Skip to content

Commit 6205b8c

Browse files
committed
Merge pull request #4163 from angular-ui/JLLeitschuh-patch-2
docs(core): Adds priority to sort in columnDef
2 parents ce554e6 + 60bdff2 commit 6205b8c

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

src/js/core/factories/GridColumn.js

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -272,17 +272,27 @@ angular.module('ui.grid')
272272
*
273273
*/
274274

275-
/**
276-
* @ngdoc property
277-
* @name sort
278-
* @propertyOf ui.grid.class:GridOptions.columnDef
279-
* @description An object of sort information, attributes are:
280-
*
281-
* - direction: values are uiGridConstants.ASC or uiGridConstants.DESC
282-
* - ignoreSort: if set to true this sort is ignored (used by tree to manipulate the sort functionality)
283-
* @example
284-
* <pre> $scope.gridOptions.columnDefs = [ { field: 'field1', sort: { direction: uiGridConstants.ASC, ignoreSort: true }}] </pre>
285-
*/
275+
/**
276+
* @ngdoc property
277+
* @name sort
278+
* @propertyOf ui.grid.class:GridOptions.columnDef
279+
* @description An object of sort information, attributes are:
280+
*
281+
* - direction: values are uiGridConstants.ASC or uiGridConstants.DESC
282+
* - ignoreSort: if set to true this sort is ignored (used by tree to manipulate the sort functionality)
283+
* - priority: says what order to sort the columns in (lower priority gets sorted first).
284+
* @example
285+
* <pre>
286+
* $scope.gridOptions.columnDefs = [{
287+
* field: 'field1',
288+
* sort: {
289+
* direction: uiGridConstants.ASC,
290+
* ignoreSort: true,
291+
* priority: 0
292+
* }
293+
* }];
294+
* </pre>
295+
*/
286296

287297

288298
/**

0 commit comments

Comments
 (0)