Skip to content

Commit 31e9060

Browse files
Portugal, Marcelomportuga
authored andcommitted
docs(ui-grid.info): Fix documentation issues.
fix #5016, fix #4756, fix #4627, fix #3930
1 parent 1f057fd commit 31e9060

File tree

3 files changed

+37
-5
lines changed

3 files changed

+37
-5
lines changed

misc/tutorial/209_grouping.ngdoc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,18 @@
22
@name Tutorial: 209 Grouping
33
@description
44

5-
<div class="alert alert-warning" role="alert"><strong>Beta</strong> This feature is ready for testing, but it either hasn't seen a lot of use or has some known bugs.</div>
5+
<h2>Grouping</h2>
6+
7+
<div class="alert alert-warning" role="alert">
8+
<strong>Beta</strong> This feature is ready for testing, but it either hasn't
9+
seen a lot of useor has some known bugs.
10+
</div>
11+
12+
<div class="alert alert-warning" role="alert">
13+
<strong>Note:</strong> Grouping leverages the sort functionality, allowing a user to change the sort order
14+
or use external sort functionality and have the resulting list grouped. A column(s) that is marked as being
15+
grouped is always moved to the high order of the sort priority, as the data must be sorted to permit grouping.
16+
</div>
617

718
The grouping feature allows you to group rows together based on similar
819
values in specific columns, providing an effect similar in some ways to an Excel pivot table.

src/js/core/factories/Grid.js

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -425,8 +425,13 @@ angular.module('ui.grid')
425425
* the columnDef and you'd like headerCellClasses to be re-evaluated.
426426
* @param {string} type one of the
427427
* {@link ui.grid.service:uiGridConstants#properties_dataChange uiGridConstants.dataChange}
428-
* values (ALL, ROW, EDIT, COLUMN), which tells us which refreshes to fire.
428+
* values (ALL, ROW, EDIT, COLUMN, OPTIONS), which tells us which refreshes to fire.
429429
*
430+
* - ALL: listeners fired on any of these events, fires listeners on all events.
431+
* - ROW: fired when a row is added or removed.
432+
* - EDIT: fired when the data in a cell is edited.
433+
* - COLUMN: fired when the column definitions are modified.
434+
* - OPTIONS: fired when the grid options are modified.
430435
*/
431436
self.api.registerMethod( 'core', 'notifyDataChange', this.notifyDataChange );
432437

@@ -612,7 +617,13 @@ angular.module('ui.grid')
612617
* api for users to tell us when they've changed data or some other event that
613618
* our watches cannot pick up
614619
* @param {string} type the type of event that occurred - one of the
615-
* uiGridConstants.dataChange values (ALL, ROW, EDIT, COLUMN)
620+
* uiGridConstants.dataChange values (ALL, ROW, EDIT, COLUMN, OPTIONS)
621+
*
622+
* - ALL: listeners fired on any of these events, fires listeners on all events.
623+
* - ROW: fired when a row is added or removed.
624+
* - EDIT: fired when the data in a cell is edited.
625+
* - COLUMN: fired when the column definitions are modified.
626+
* - OPTIONS: fired when the grid options are modified.
616627
*/
617628
Grid.prototype.notifyDataChange = function notifyDataChange(type) {
618629
var constants = uiGridConstants.dataChange;
@@ -2283,7 +2294,7 @@ angular.module('ui.grid')
22832294

22842295
/**
22852296
* @ngdoc function
2286-
* @name redrawCanvas
2297+
* @name redrawInPlace
22872298
* @methodOf ui.grid.class:Grid
22882299
* @description Redraw the rows and columns based on our current scroll position
22892300
* @param {boolean} [rowsAdded] Optional to indicate rows are added and the scroll percentage must be recalculated

src/js/core/factories/GridOptions.js

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,11 +129,21 @@ angular.module('ui.grid')
129129
*
130130
*/
131131

132+
/**
133+
* @ngdoc object
134+
* @name enableGridMenu
135+
* @propertyOf ui.grid.class:GridOptions
136+
* @description Takes a boolean that adds a settings icon in the top right of the grid, which floats above
137+
* the column header, when true. The menu by default gives access to show/hide columns, but can be
138+
* customised to show additional actions.
139+
*
140+
* See the {@link #!/tutorial/121_grid_menu Grid Menu tutorial} for more detailed information.
141+
*/
132142

133143
/**
134144
* @ngdoc array
135145
* @name excludeProperties
136-
* @propertyOf ui.grid.class:GridOptions
146+
* @propertyOf ui.grid.class:GridOptions
137147
* @description Array of property names in data to ignore when auto-generating column names. Provides the
138148
* inverse of columnDefs - columnDefs is a list of columns to include, excludeProperties is a list of columns
139149
* to exclude.

0 commit comments

Comments
 (0)