docs(scrollThreshold): Add missing documentation details.

BREAKING CHANGE: Removed horizontalScrollThreshold as it is not being used by the grid.
angular-ui · Jun 20, 2018 · cc0fdb7 · cc0fdb7
1 parent f482800
commit cc0fdb7
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 14 deletions.
diff --git a/src/js/core/factories/GridOptions.js b/src/js/core/factories/GridOptions.js
@@ -317,11 +317,13 @@ angular.module('ui.grid')
        * Defaults to 4
        */
       baseOptions.excessRows = typeof(baseOptions.excessRows) !== "undefined" ? baseOptions.excessRows : 4;
+
       /**
        * @ngdoc property
        * @name scrollThreshold
        * @propertyOf ui.grid.class:GridOptions
-       * @description Defaults to 4
+       * @description Throttles the grid scrolling by the amount of rows set, which helps with smoothness of scrolling.
+       * Defaults to 4.
        */
       baseOptions.scrollThreshold = typeof(baseOptions.scrollThreshold) !== "undefined" ? baseOptions.scrollThreshold : 4;
 
@@ -333,14 +335,6 @@ angular.module('ui.grid')
        * Defaults to 4
        */
       baseOptions.excessColumns = typeof(baseOptions.excessColumns) !== "undefined" ? baseOptions.excessColumns : 4;
-      /**
-       * @ngdoc property
-       * @name horizontalScrollThreshold
-       * @propertyOf ui.grid.class:GridOptions
-       * @description Defaults to 4
-       */
-      baseOptions.horizontalScrollThreshold = typeof(baseOptions.horizontalScrollThreshold) !== "undefined" ? baseOptions.horizontalScrollThreshold : 2;
-
 
       /**
        * @ngdoc property

diff --git a/test/unit/core/factories/GridOptions.spec.js b/test/unit/core/factories/GridOptions.spec.js
@@ -35,7 +35,6 @@ describe('GridOptions factory', function () {
         excessRows: 4,
         scrollThreshold: 4,
         excessColumns: 4,
-        horizontalScrollThreshold: 2,
         aggregationCalcThrottle: 500,
         wheelScrollThrottle: 70,
         scrollDebounce: 300,
@@ -82,7 +81,6 @@ describe('GridOptions factory', function () {
         excessRows: 5,
         scrollThreshold: 6,
         excessColumns: 7,
-        horizontalScrollThreshold: 3,
         aggregationCalcThrottle: 1000,
         wheelScrollThrottle: 75,
         enableSorting: true,
@@ -125,7 +123,6 @@ describe('GridOptions factory', function () {
         excessRows: 5,
         scrollThreshold: 6,
         excessColumns: 7,
-        horizontalScrollThreshold: 3,
         aggregationCalcThrottle: 1000,
         wheelScrollThrottle: 75,
         scrollDebounce: 300,
@@ -173,7 +170,6 @@ describe('GridOptions factory', function () {
         excessRows: 5,
         scrollThreshold: 6,
         excessColumns: 7,
-        horizontalScrollThreshold: 3,
         aggregationCalcThrottle: 1000,
         wheelScrollThrottle: 75,
         enableFiltering: false,
@@ -215,7 +211,6 @@ describe('GridOptions factory', function () {
         excessRows: 5,
         scrollThreshold: 6,
         excessColumns: 7,
-        horizontalScrollThreshold: 3,
         aggregationCalcThrottle: 1000,
         wheelScrollThrottle: 75,
         scrollDebounce: 300,