gridx.modules.select.Column
Object » _Base » gridx.modules.select.Column
dojo.require("gridx.modules.select.Column");
Defined in gridx/modules/select/Column.js
This module provides a simple way for selecting columns by clicking or SPACE key, or CTRL + Click to select multiple columns.
Examples:
Example 1
1. Use select api on grid column object obtained from grid.column(i)
grid.column(1).select();
grid.column(1).deselect();
grid.column(1).isSelected();
2. Use select api on select.column module
grid.select.column.selectById(columnId);
grid.select.column.deSelectById(columnId);
grid.select.column.isSelected(columnId);
grid.select.column.getSelected();//[]
grid.select.column.clear();
Property Summary
- columnMixin A map of functions to be mixed into grid column object, so that we can use select api on column object directly - grid.column(1).select() | deselect() | isSelected();
- grid
Method Summary
- _highlight(id, toHighlight)
- _init()
- _markById(id, toSelect)
- _onRender(start, count)
- clear() Clear all column selections
- deselectById(id) Deselect target column by id
- getSelected() Get array of column id of all selected columns
- isSelected(id) Check if a column is selected
- selectById(id) Select target column by id
Event Summary
- onDeselected(col) Fired when a column is deselected.
- onHighlightChange() Fired when a column's highlight is changed.
- onSelected(col) Fired when a column is selected.
Attached Objects
Properties
Overrides _Base
A map of functions to be mixed into grid column object, so that we can use select api on column object directly
- grid.column(1).select() | deselect() | isSelected();
Methods
Events
Overrides _Base
Fired when a column is deselected.
| Parameter | Type | Description |
|---|---|---|
| col | gridx.core.Column | The column object |