| startCell | +(object) an object that contains the initial cell of the selection, includes the following properties:
|
+
| endCell | +(object) an object that contains the end cell of the selection, includes the following properties:
|
+
| dragDirection | +(string) determines the direction of movement of the focused cell: `"up"` | `"down"` | `"left"` | `"right"` | `null` | +
| event | +(Event) the browser event: `MouseEvent` or `TouchEvent` | +
| startCell | +(object) an object that contains the initial cell of the selection, includes the following properties:
|
+
| endCell | +(object) an object that contains the end cell of the selection, includes the following properties:
|
+
| handle | +(boolean) indicates whether the handle was used (`true`) or a regular selection (`false`) | +
| event | +(Event) the browser event: `MouseEvent` or `TouchEvent` | +
| startCell | +(object) an object that contains the initial cell of the selection, includes the following properties:
|
+
| endCell | +(object) an object that contains the current end cell of the selection, includes the following properties:
|
+
| focusCell | +(object) an object that contains the focus cell (if the handle is used) or `null`, includes the following properties:
|
+
| dragDirection | +(string) determines the direction of movement of the focused cell: `"up"` | `"down"` | `"left"` | `"right"` | `null` | +
| event | +(Event) the browser event: `MouseEvent` or `TouchEvent` | +
| startCell | +(object) an object that contains the initial cell of the selection, includes the following properties:
|
+
| endCell | +(object) an object that contains the end cell of the selection, includes the following properties:
|
+
| dragDirection | +(string) determines the direction of movement of the focused cell: `"up"` | `"down"` | `"left"` | `"right"` | `null` | +
| event | +(Event) the browser event: `MouseEvent` or `TouchEvent` | +
| startCell | +(object) an object that contains the initial cell of the selection, includes the following properties:
|
+
| endCell | +(object) an object that contains the end cell of the selection, includes the following properties:
|
+
| handle | +(boolean) indicates whether the handle was used (`true`) or a regular selection (`false`) | +
| event | +(Event) the browser event: `MouseEvent` or `TouchEvent` | +
| startCell | +(object) an object that contains the initial cell of the selection, includes the following properties:
|
+
| nextCell | +(object) an object that contains the next cell to which the boundary is moving or the end cell of the previously selected boundary during the handle movement, includes the following properties:
|
+
| focusCell | +(object) an object that contains the last focus cell (if the handle is used) or `null`, includes the following properties:
|
+
| dragDirection | +(string) determines the direction of movement of the focused cell: `"up"` | `"down"` | `"left"` | `"right"` | `null` | +
| event | +(Event) the browser event: `MouseEvent` or `TouchEvent` | +
| startCell | +(object) an object that contains the initial cell of the selection, includes the following properties:
|
+
| endCell | +(object) an object that contains the end cell at the time of selection completion, includes the following properties:
|
+
| handle | +(boolean) indicates whether the handle was used (`true`) or a regular selection (`false`) | +
| event | +(Event) the browser event: `MouseEvent` or `TouchEvent` | +
| startCell | +(object) an object that contains the initial cell of the selection, includes the following properties:
|
+
| endCell | +(object) an object that contains the end cell at the start of the selection, includes the following properties:
|
+
| handle | +(boolean) indicates whether the handle is used (`true`) or a regular selection (`false`) | +
| event | +(Event) the browser event: `MouseEvent` or `TouchEvent` | +
| validateCell | +(object) an object that contains the cell where the selection starts, includes the following properties:
|
+
| handle | +(boolean) indicates whether the handle is used (`true`) or a regular selection (`false`) | +
| event | +(Event) the browser event: `MouseEvent` or `TouchEvent` | +
| disabled | +(boolean) disables the module on startup, `false` by default | +
| mode | +(string) the operating mode of the module:
|
+
| handle | +(boolean | object) enables the handle for resizing or provides additional configuration options, `true` by default. As an *object* can contain the following properties:
|
+
| area | +(boolean) enables the display of the selection area, `true` by default | +
| range | +(object) the object with the reset range coordinates that contains the following options:
|
+
| range | +(object) the object with the set range coordinates that contains the following options:
|
+
| range | +(object) an object with the range coordinates that contains the following options:
|
+
| range | +(object) an object with the range coordinates that contains the following options:
|
+
| xStart | +(string | number) the starting column id | +
| xEnd | +(string | number) the ending column id | +
| yStart | +(string | number) the starting row id | +
| yEnd | +(string | number) the ending row id | +
| row | +(object) the row object | +
| column | +(object) the column object | +
| cell | +(object) - an object with the `x` and `y` coordinates of a cell, where:
|
+
| range | +(object) an object with the range coordinates that contains the following options:
|
+
| join | +(boolean) defines whether a new range is merged with the current one:
+
|
+
Details for ${row.name}
- -| css | -(string) user-defined CSS classes for a sub-row | -
| element | -(HTMLElement | null) the parent container of the current sub-row | -
| expanded | -(boolean) defines whether a sub-row is expanded by default, false by default | -
| fullWidth | -(boolean) defines whether a sub-row will take all the width of Grid, false by default | -
| height | -(number) the height of a sub-row in pixels, 200 by default | -
| padding | -(string | number) the inner padding of a sub-row, 8 by default | -
| preserve | -(boolean) saves the state of sub-rows while expanding/collapsing, disappearing from the visible area, data updating, false by default | -
| toggleIcon | -(boolean) enables the icon for expanding/collapsing, true by default | -
| view | -(string | object | null) that can be presented by:
|
-
| PageUp | -scroll Grid up to the height of the visible content (without change of the selected cell) | -
| PageDown | -scroll Grid down to the height of the visible content (without change of the selected cell) | -
| Home | -navigate to the beginning of the Grid content (without change of the selected cell) | -
| End | -navigate to the end of the Grid content (without change of the selected cell) | -
| Ctrl+Enter | -expands/collapses the parent item in the TreeGrid mode | -
| ArrowUp | -move selection to the previous vertical cell | -
| ArrowDown | -move selection to the next vertical cell | -
| ArrowLeft | -move selection to the previous horizontal cell | -
| ArrowRight | -move selection to the next horizontal cell | -
| Ctrl+ArrowUp | -move selection to the first vertical cell | -
| Ctrl+ArrowDown | -move selection to the last vertical cell | -
| Ctrl+ArrowLeft | -move selection to the first horizontal cell | -
| Ctrl+ArrowRight | -move selection to the last horizontal cell | -
| Tab | -move selection to the next horizontal cell or the first cell of the next row | -
| Shit+Tab | -move selection to the previous horizontal cell or to the first cell of the previous row | -
| Shift+ArrowUp | -move selection to the previous vertical cell with the change of the selected cells | -
| Shift+ArrowDown | -move selection to the next vertical cell with the change of the selected cells | -
| Shift+ArrowLeft | -move selection to the previous horizontal cell with the change of the selected cells | -
| Shift+ArrowRight | -move selection to the next horizontal cell with the change of the selected cells | -
| Ctrl+Shift+ArrowUp | -move selection to the first vertical cell with the change of the selected cells | -
| Ctrl+Shift+ArrowDown | -move selection to the last vertical cell with the change of the selected cells | -
| Ctrl+Shift+ArrowLeft | -move selection to the first horizontal cell with the change of the selected cells | -
| Ctrl+Shift+ArrowRight | -move selection to the last horizontal cell with the change of the selected cells | -
| Enter | -open the editor in the selected cell. If the editor is currently opened - close the editor and save changes | -
| Escape | -close the editor of the selected cell without saving | -
| row | -to move selection between Grid rows | -
| cell | -to move selection between Grid cells | -
| complex | -to highlight both a selected cell and the row it belongs to | -
Details for ${row.name}
+ +| css | +(string) user-defined CSS classes for a sub-row | +
| element | +(HTMLElement | null) the parent container of the current sub-row | +
| expanded | +(boolean) defines whether a sub-row is expanded by default, false by default | +
| fullWidth | +(boolean) defines whether a sub-row will take all the width of Grid, false by default | +
| height | +(number) the height of a sub-row in pixels, 200 by default | +
| padding | +(string | number) the inner padding of a sub-row, 8 by default | +
| preserve | +(boolean) saves the state of sub-rows while expanding/collapsing, disappearing from the visible area, data updating, false by default | +
| toggleIcon | +(boolean) enables the icon for expanding/collapsing, true by default | +
| view | +(string | object | null) that can be presented by:
|
+
| row | +to move selection between Grid rows | +
| cell | +to move selection between Grid cells | +
| complex | +to highlight both a selected cell and the row it belongs to | +
| disabled | +(boolean) disables the module on startup, `false` by default | +
| mode | +(string) the operating mode of the module:
|
+
| handle | +(boolean | object) enables the handle for resizing or provides additional configuration options, `true` by default. As an *object* can contain the following properties:
|
+
| area | +(boolean) enables the display of the selection area, `true` by default | +
| PageUp | +scrolls Grid up to the height of the visible content (without change of the selected cell) | +
| PageDown | +scrolls Grid down to the height of the visible content (without change of the selected cell) | +
| Home | +navigates to the beginning of the Grid content (without change of the selected cell) | +
| End | +navigates to the end of the Grid content (without change of the selected cell) | +
| Ctrl+Enter | +expands/collapses the parent item in the TreeGrid mode | +
| ArrowUp | +moves selection to the previous vertical cell | +
| ArrowDown | +moves selection to the next vertical cell | +
| ArrowLeft | +moves selection to the previous horizontal cell | +
| ArrowRight | +moves selection to the next horizontal cell | +
| Ctrl+ArrowUp | +moves selection to the first vertical cell | +
| Ctrl+ArrowDown | +moves selection to the last vertical cell | +
| Ctrl+ArrowLeft | +moves selection to the first horizontal cell | +
| Ctrl+ArrowRight | +moves selection to the last horizontal cell | +
| Tab | +moves selection to the next horizontal cell or the first cell of the next row | +
| Shit+Tab | +moves selection to the previous horizontal cell or to the first cell of the previous row | +
| Shift+ArrowUp | +moves selection to the previous vertical cell with the change of the selected cells | +
| Shift+ArrowDown | +moves selection to the next vertical cell with the change of the selected cells | +
| Shift+ArrowLeft | +moves selection to the previous horizontal cell with the change of the selected cells | +
| Shift+ArrowRight | +moves selection to the next horizontal cell with the change of the selected cells | +
| Ctrl+Shift+ArrowUp | +moves selection to the first vertical cell with the change of the selected cells | +
| Ctrl+Shift+ArrowDown | +moves selection to the last vertical cell with the change of the selected cells | +
| Ctrl+Shift+ArrowLeft | +moves selection to the first horizontal cell with the change of the selected cells | +
| Ctrl+Shift+ArrowRight | +moves selection to the last horizontal cell with the change of the selected cells | +
| Enter | +opens the editor in the selected cell. If the editor is currently opened - closes the editor and saves changes | +
| Escape | +closes the editor of the selected cell without saving | +
| Delete | +clears data in the selected cells. Works only with the `BlockSelection` module in the "range" mode | +
| ArrowUp | +resets the selected range and moves the focus to the previous vertical cell, setting the initially selected cell if no selection is active | +
| ArrowDown | +resets the selected range and moves the focus to the next vertical cell, setting the initially selected cell if no selection is active | +
| ArrowLeft | +resets the selected range and moves the focus to the previous horizontal cell, setting the initially selected cell if no selection is active | +
| ArrowRight | +resets the selected range and moves the focus to the next horizontal cell, setting the initially selected cell if no selection is active | +
| Shift+ArrowUp | +extends the selected range from the current initial cell to the previous vertical cell | +
| Shift+ArrowDown | +extends the selected range from the current initial cell to the next vertical cell | +
| Shift+ArrowLeft | +extends the selected range from the current initial cell to the previous horizontal cell | +
| Shift+ArrowRight | +extends the selected range from the current initial cell to the next horizontal cell | +
| Ctrl+ArrowUp | +resets the selected range and moves the focus to the first vertical cell | +
| Ctrl+ArrowDown | +resets the selected range and moves the focus to the last vertical cell | +
| Ctrl+ArrowLeft | +resets the selected range and moves the focus to the first horizontal cell | +
| Ctrl+ArrowRight | +resets the selected range and moves the focus to the last horizontal cell | +
| Ctrl+Shift+ArrowUp | +extends the selected range to the first vertical cell | +
| Ctrl+Shift+ArrowDown | +extends the selected range to the last vertical cell | +
| Ctrl+Shift+ArrowLeft | +extends the selected range to the first horizontal cell | +
| Ctrl+Shift+ArrowRight | +extends the selected range to the last horizontal cell | +
| Shift + click | +sets the end cell of the range, extending the selection from the current initial cell | +
| Delete | +allows clearing the selected cells | +
| ArrowUp | +resets the selected range and moves the focus to the previous vertical cell, setting the initially selected cell if no selection is active | +
| ArrowDown | +resets the selected range and moves the focus to the next vertical cell, setting the initially selected cell if no selection is active | +
| ArrowLeft | +resets the selected range and moves the focus to the previous horizontal cell, setting the initially selected cell if no selection is active | +
| ArrowRight | +resets the selected range and moves the focus to the next horizontal cell, setting the initially selected cell if no selection is active | +
| Shift+ArrowUp | +extends the selected range from the current initial cell to the previous vertical cell | +
| Shift+ArrowDown | +extends the selected range from the current initial cell to the next vertical cell | +
| Shift+ArrowLeft | +extends the selected range from the current initial cell to the previous horizontal cell | +
| Shift+ArrowRight | +extends the selected range from the current initial cell to the next horizontal cell | +
| Ctrl+ArrowUp | +resets the selected range and moves the focus to the first vertical cell | +
| Ctrl+ArrowDown | +resets the selected range and moves the focus to the last vertical cell | +
| Ctrl+ArrowLeft | +resets the selected range and moves the focus to the first horizontal cell | +
| Ctrl+ArrowRight | +resets the selected range and moves the focus to the last horizontal cell | +
| Ctrl+Shift+ArrowUp | +extends the selected range to the first vertical cell | +
| Ctrl+Shift+ArrowDown | +extends the selected range to the last vertical cell | +
| Ctrl+Shift+ArrowLeft | +extends the selected range to the first horizontal cell | +
| Ctrl+Shift+ArrowRight | +extends the selected range to the last horizontal cell | +
| Shift + click | +sets the end cell of the range, extending the selection from the current initial cell | +
| Delete | +allows clearing the selected cells | +
| range | +(object) an object with the range coordinates that contains the following options:
|
+
| join | +(boolean) defines whether a new range is merged with the current one:
+
|
+
| xStart | +(string | number) the starting column id | +
| xEnd | +(string | number) the ending column id | +
| yStart | +(string | number) the starting row id | +
| yEnd | +(string | number) the ending row id | +
| row | +(object) the row object | +
| column | +(object) the column object | +
| cell | +(object) - an object with the `x` and `y` coordinates of a cell, where:
|
+
| row | -(object|string) an object with a cell to be selected or the id of a row | +(object | string) an object with a cell to be selected or the id of a row |
| column | -(object|string) the config of a column or its id | +(object | string) the config of a column or its id |
| ctrlUp | -(boolean) true - to select the desired rows or cells, otherwise - false (for multiselection mode) | +(boolean) true - to select the desired rows or cells, otherwise - false (for the `multiselection` mode) |
| shiftUp | -(boolean) true - to select a range of rows or cells, otherwise - false (for multiselection mode) | +(boolean) true - to select a range of rows or cells, otherwise - false (for the `multiselection` mode) |
| row | +(IRow | Id) an object with a cell to be checked or the id of a row | +
| column | +(ICol | Id) the config of a column or its id | +
| rowId | -(string|number) optional, the id of a row | +(string | number) optional, the id of a row |
| colId | -(string|number) optional, the id of a column | +(string | number) optional, the id of a column |
| ArrowUp | +resets the selected range and moves the focus to the previous vertical cell, setting the initially selected cell if no selection is active | +
| ArrowDown | +resets the selected range and moves the focus to the next vertical cell, setting the initially selected cell if no selection is active | +
| ArrowLeft | +resets the selected range and moves the focus to the previous horizontal cell, setting the initially selected cell if no selection is active | +
| ArrowRight | +resets the selected range and moves the focus to the next horizontal cell, setting the initially selected cell if no selection is active | +
| Shift+ArrowUp | +extends the selected range from the current initial cell to the previous vertical cell | +
| Shift+ArrowDown | +extends the selected range from the current initial cell to the next vertical cell | +
| Shift+ArrowLeft | +extends the selected range from the current initial cell to the previous horizontal cell | +
| Shift+ArrowRight | +extends the selected range from the current initial cell to the next horizontal cell | +
| Ctrl+ArrowUp | +resets the selected range and moves the focus to the first vertical cell | +
| Ctrl+ArrowDown | +resets the selected range and moves the focus to the last vertical cell | +
| Ctrl+ArrowLeft | +resets the selected range and moves the focus to the first horizontal cell | +
| Ctrl+ArrowRight | +resets the selected range and moves the focus to the last horizontal cell | +
| Ctrl+Shift+ArrowUp | +extends the selected range to the first vertical cell | +
| Ctrl+Shift+ArrowDown | +extends the selected range to the last vertical cell | +
| Ctrl+Shift+ArrowLeft | +extends the selected range to the first horizontal cell | +
| Ctrl+Shift+ArrowRight | +extends the selected range to the last horizontal cell | +
| Shift + click | +sets the end cell of the range, extending the selection from the current initial cell | +
| Delete | +allows clearing the selected cells | +