Version

GridHidingClientEvents Class Members

The following tables list the members exposed by GridHidingClientEvents.

Public Fields
 NameDescription
Public FieldcolumnChooserButtonApplyClickEvent fired when button Apply in column chooser is clicked. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridHiding widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. Use ui.columnsToShow to get array of columns identifiers which should be shown. Use ui.columnsToHide to get array of columns identifiers which should be hidden.  
Public FieldcolumnChooserButtonResetClickEvent fired when button Reset in column chooser is clicked. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridHiding widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object.  
Public FieldcolumnChooserClosedEvent fired after the column chooser has been closed. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridHiding widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object.  
Public FieldcolumnChooserClosingEvent fired before the column chooser is closed. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridHiding widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object.  
Public FieldcolumnChooserContentsRenderedEvent fired after the contents of the column chooser are rendered. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridHiding widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object.  
Public FieldcolumnChooserContentsRenderingEvent fired before the contents of the column chooser are rendered. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridHiding widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object.  
Public FieldcolumnChooserMovingEvent fired every time the column chooser changes its position. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridHiding widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object. Use ui.originalPosition to get the original position of the column chooser div as { top, left } object, relative to the page. Use ui.position to get the current position of the column chooser div as { top, left } object, relative to the page.  
Public FieldcolumnChooserOpenedEvent fired after the column chooser is already opened. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridHiding widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object.  
Public FieldcolumnChooserOpeningEvent fired before the column chooser is opened. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridHiding widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.columnChooserElement to get a reference to the Column Chooser element. This is a jQuery object.  
Public FieldcolumnHiddenEvent fired after the hiding has been executed and results are rendered. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridHiding widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.columnIndex to get the hidden column index. Has a value only if the column's key is a number. Use ui.columnKey to get the hidden column key. Has a value only if the column's key is a string.  
Public FieldcolumnHidingEvent fired before a hiding operation is executed. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridHiding widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.columnIndex to get the hidden column index. Has a value only if the column's key is a number. Use ui.columnKey to get the hidden column key. Has a value only if the column's key is a string.  
Public FieldcolumnShowingEvent fired before a showing operation is executed. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridHiding widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.columnIndex to get the shown column index. Use ui.columnKey to get the shown column key.  
Public FieldcolumnShownEvent fired after the showing has been executed and results are rendered. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridHiding widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.columnIndex to get the shown column index. Use ui.columnKey to get the shown column key.  
Public FieldmultiColumnHidingEvent fired before a hiding operation is executed. The handler function takes arguments evt and ui. Use ui.owner to get the reference to the igGridHiding widget. Use ui.owner.grid to get the reference to the igGrid widget. Use ui.columnKeys to get array of the hidden column keys.  
See Also

View on GitHub