The following tables list the members exposed by GridGroupByClientEvents.
| Name | Description | |
|---|---|---|
 | GroupedColumnsChanged | event which is fired when the groupedColumns collection has changed. This event is fired also when group/ungroup from groupby modal dialog but key, layout and grid are not set. Use args.owner in order to access the groupby widget object. Use args.owner.grid to access the grid widget option. Use args.groupedColumns to get a reference to the current groupedColumns. Use args.key to get a reference to the current column's key that's being grouped. Use args.layout to get a reference to the current layout object, if any. Use args.grid to get a reference to the current child grid element, in case it's an hierarchical grid. |
| GroupedColumnsChanging | Event which is fired when the grouped columns collection is about to change. This event is fired even when the OK button is clicked from the modal dialog (after the modalDialogButtonApplyClick event is fired). Use args.owner in order to access the groupby widget object. Use args.owner.grid to access the grid widget option. Use args.groupedColumns to get a reference to the current groupedColumns. Use args.newGroupedColumns to get an object of the new grouped columns that should be applied (it is set ONLY if called from modal dialog). Use args.key to get a reference to the current column's key that's being grouped (not set if called from modal dialog). Use args.layout to get a reference to the current layout object, if any (not set if called from modal dialog). Use args.grid to get a reference to the current child grid element, in case it's an hierarchical grid (not set if called from modal dialog). |
| ModalDialogButtonApplyClick | Event fired when the button is Apply is clicked. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridGroupby widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. Use ui.groupedColumns to get the array of grouped columns. Use ui.groupedColumnLayouts to get array of column layouts. Use ui.sortingExpr to get array of sorted columns. |
| ModalDialogButtonResetClick | Event fired when reset button is clicked. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridGroupby widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. |
| ModalDialogClosed | Event fired after the modal dialog has been closed. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridGroupBy widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. |
| ModalDialogClosing | Event fired before the modal dialog is closed. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridGroupBy widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. |
| ModalDialogContentsRendered | Event fired after the contents of the modal dialog are rendered. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridGroupBy widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. |
| ModalDialogContentsRendering | Event fired before the contents of the modal dialog are rendered. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridGroupby widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. |
| ModalDialogGroupColumn | Event fired when column in modal dialog is clicked to be grouped. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridGroupby widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.key to get the key of the column to be grouped. Use args.groupedColumns to get a reference to the current groupedColumns. Use ui.layout to get the layout of the columns. |
| ModalDialogGroupingColumn | Event fired when column in modal dialog is clicked to be grouped. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridGroupby widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.key to get the key of the column to be grouped. Use ui.layout to get the layout of the columns. |
| ModalDialogMoving | Event fired every time the groupby dialog changes its position. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridGroupBy widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.modalDialogElement to get a reference to the Column Chooser element. This is a jQuery object. Use ui.originalPosition to get the original position of the groupby dialog div as { top, left } object, relative to the page. Use ui.position to get the current position of the groupby dialog div as { top, left } object, relative to the page. |
| ModalDialogOpened | Event fired after the modal dialog is already opened. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridGroupBy widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. |
| ModalDialogOpening | Event fired before the modal dialog is opened. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridGroupBy widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.modalDialogElement to get a reference to the modal dialog element. This is a jQuery object. |
| ModalDialogSortGroupedColumn | Event fired when column in modal dialog is clicked to be ungrouped. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridGroupby widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.key to get the key of the column to be grouped. Use ui.layout to get the layout of the columns. Use ui.isAsc to get whether column should be sorted ascending or descending. |
| ModalDialogUngroupColumn | Event fired when column in modal dialog is clicked to be ungrouped. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridGroupby widget. Use ui.owner.grid to get the reference to the igGrid widget. Use args.groupedColumns to get a reference to the current groupedColumns. Use ui.key to get the key of the column to be grouped. Use ui.layout to get the layout of the columns. |
| ModalDialogUngroupingColumn | Event fired when column in modal dialog is clicked to be ungrouped. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridGroupby widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.key to get the key of the column to be grouped. Use ui.layout to get the layout of the columns. |
View on GitHub