Row Selection

LyteNyte Grid offers configurable row selection functionality with support for both single and multiple selection. You can trigger row selection through row clicks, checkbox toggling, or both.

Enabling Row Selection

Enable row selection by setting the rowSelectionMode property to either "single" or "multiple". To activate row selection on clicks, set the rowSelectionPointerActivator property to "single-click" or "double-click".

TODO;

Checkbox Selection

Control the display of selection checkboxes with the rowSelectionCheckbox property. When enabled, checkboxes appear in the marker column.

The rowSelectionCheckbox property accepts three values:

• "normal" displays a checkbox for every row
• "hide-for-disabled" displays checkboxes only for selectable rows
• "hide" removes all checkboxes

TODO;

Selecting Rows On Click

By default, clicking a row creates a new selection, clearing previous selections unless the user holds Shift or Ctrl/Cmd keys. Set rowSelectionMultiSelectOnClick to true to enable cumulative selection, allowing users to quickly select and deselect multiple rows.

TODO;

Row Selection Predicate

Use the rowSelectionPredicate property to determine which rows users can select. Choose from predefined values or create a custom function:

• "all" makes every row selectable
• "group-only" limits selection to group rows only
• "leaf-only" limits selection to leaf rows only (default)

TODO;

For more granular control, provide a custom function to enable selection based on specific criteria:

TODO;

Row Selection And Group Rows

Group rows establish hierarchical relationships with their children. The rowSelectionSelectChildren property controls whether selecting a group row selects only that row or includes all its children as well.

TODO;

Managing Selected Rows

LyteNyte Grid stores selected rows in the rowSelectionSelectedIds set within grid state. You can provide an initial value when creating the grid state.

The API provides these methods for managing row selection:

• rowSelectionGetSelected returns currently selected row nodes
• rowSelectionSelect selects specified rows
• rowSelectionDeselect deselects specified rows
• rowSelectionIsIndeterminate returns true if a group row has any selected children
• rowSelectionAllRowsSelected returns true if all rows in the grid are selected
• rowSelectionSelectAll selects all rows
• rowSelectionClear clears all selected rows
• rowSelectionSelectAllSupported returns true if the row data source supports selecting all rows

See the API Reference for detailed information.

TODO;

Row Selection In Row Data Sources (Enterprise Only)

While LyteNyte Grid maintains row selection state, row data sources provide meta information that determines certain selection capabilities.

Row data sources can implement:

• rowSelectionIndeterminateSupported to indicate if indeterminate selection is supported for group rows
• rowSelectionSelectAllSupported to inform the grid if selecting all rows is possible

The Client Row Data Source and Tree Data Source support all row selection capabilities, while the Server Row Data Source does not support indeterminate selection or selecting all rows.