Skip to content

Commit 71c3db8

Browse files
Portugal, Marcelomportuga
authored andcommitted
docs(ui-grid.info): Added missing documentation.
Documented headerRowHeight, sort priority, setRowsDirty and savePagination. closes #4098, closes #5518, closes #5661, closes #6671
1 parent 85838e5 commit 71c3db8

File tree

4 files changed

+14
-6
lines changed

4 files changed

+14
-6
lines changed

misc/tutorial/208_save_state.ngdoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ default:
3939
- saveVisible
4040
- saveSort
4141
- saveFilter
42+
- savePagination
4243
- savePinning
4344
- saveGrouping
4445
- saveGroupingExpandedStates

src/features/row-edit/js/gridRowEdit.js

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -156,10 +156,11 @@
156156
* @methodOf ui.grid.rowEdit.api:PublicApi
157157
* @name setRowsDirty
158158
* @description Sets each of the rows passed in dataRows
159-
* to be dirty. note that if you have only just inserted the
159+
* to be dirty. Note that if you have only just inserted the
160160
* rows into your data you will need to wait for a $digest cycle
161161
* before the gridRows are present - so often you would wrap this
162-
* call in a $interval or $timeout
162+
* call in a $interval or $timeout. Also, you must pass row.entity
163+
* into this function rather than row objects themselves.
163164
* <pre>
164165
* $interval( function() {
165166
* gridApi.rowEdit.setRowsDirty(myDataRows);

src/js/core/factories/GridColumn.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ angular.module('ui.grid')
302302
* - direction: values are {@link ui.grid.service:uiGridConstants#properties_ASC uiGridConstants.ASC}
303303
* or {@link ui.grid.service:uiGridConstants#properties_DESC uiGridConstants.DESC}
304304
* - ignoreSort: if set to true this sort is ignored (used by tree to manipulate the sort functionality)
305-
* - priority: says what order to sort the columns in (lower priority gets sorted first).
305+
* - priority: says what order to sort the columns in (lower priority gets sorted first). Starts from 0.
306306
* @example
307307
* <pre>
308308
* $scope.gridOptions.columnDefs = [{

src/js/core/factories/GridOptions.js

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -216,13 +216,19 @@ angular.module('ui.grid')
216216
*/
217217
baseOptions.showHeader = typeof(baseOptions.showHeader) !== "undefined" ? baseOptions.showHeader : true;
218218

219-
/* (NOTE): Don't show this in the docs. We only use it internally
219+
/**
220220
* @ngdoc property
221221
* @name headerRowHeight
222222
* @propertyOf ui.grid.class:GridOptions
223-
* @description The height of the header in pixels, defaults to 30
223+
* @description The height of the header in pixels, defaults to 30.
224+
* Although, we recommend that you alter header height with CSS rather than using this option:
224225
*
225-
*/
226+
* <pre>
227+
* .grid .ui-grid-header-cell {
228+
* height: 60px;
229+
* }
230+
* </pre>
231+
**/
226232
if (!baseOptions.showHeader) {
227233
baseOptions.headerRowHeight = 0;
228234
}

0 commit comments

Comments
 (0)