gridx.modules.select.Cell
Object » _RowCellBase » gridx.modules.select.Cell
dojo.require("gridx.modules.select.Cell");
Defined in gridx/modules/select/Cell.js
This module provides a simple way for selecting cells by clicking or SPACE key, or CTRL + Click to select multiple cells.
Examples:
Example 1
1. Use select api on grid cell object obtained from grid.cell(i, j)
grid.cell(1,1).select();
grid.cell(1,1).deselect();
grid.cell(1,1).isSelected();
2. Use select api on select.cell module
grid.select.cell.selectById(rowId, columnId);
grid.select.cell.deSelectById(rowId, columnId);
grid.select.cell.isSelected(rowId, columnId);
grid.select.cell.getSelected();//[]
grid.select.cell.clear();
Property Summary
- cellMixin A map of functions to be mixed into grid cell object, so that we can use select api on cell object directly - grid.cell(1,1).select() | deselect() | isSelected();
Method Summary
- _getMarkType(colId)
- _highlight(rowId, colId, toHighlight)
- _init()
- _isSelected(cell)
- _markById(item, toMark)
- _onMark(rowId, toMark, oldState, type)
- _onRender(start, count)
- clear() Deselected all the selected cells;
- deselectById(rowId, columnId) Deselect a cell by [rowId, columnId].
- getSelected() Get arrays of [rowId, columnId] of all the selected cells
- isSelected(rowId, columnId) Check if a cell is already selected.
- selectById(rowId, columnId) Select a cell by [rowId, columnId].
Event Summary
- onDeselected(cell) Fired when a cell is deselected.
- onHighlightChange() Fired when a cell's highlight is changed.
- onSelected(cell) Fired when a cell is selected.
Attached Objects
Properties
Overrides _RowCellBase
A map of functions to be mixed into grid cell object, so that we can use select api on cell object directly
- grid.cell(1,1).select() | deselect() | isSelected();
Methods
Overrides _RowCellBase
Deselect a cell by [rowId, columnId].
| Parameter | Type | Description |
|---|---|---|
| rowId | ||
| columnId |
Overrides _RowCellBase
Check if a cell is already selected.
| Parameter | Type | Description |
|---|---|---|
| rowId | ||
| columnId |
Overrides _RowCellBase
Select a cell by [rowId, columnId].
| Parameter | Type | Description |
|---|---|---|
| rowId | ||
| columnId |
Events
Overrides _RowCellBase
Fired when a cell is deselected.
| Parameter | Type | Description |
|---|---|---|
| cell | gridx.core.Cell | The cell object |