The imperative API of LyteNyte Grid for triggering actions such as column resizing, row expansion, and selection.

The declarative state of LyteNyte Grid. This contains all core and optional features represented as atoms.

The current layout view of the grid, reflecting visible headers and rows based on virtualization and scroll position.

The aggregation model configuration for the grid. Each entry maps a column id to its associated aggregation function. Aggregation results are typically displayed in group or summary rows.

A registry of named cell renderer functions. These can be referenced by name in individual column definitions to customize cell rendering behavior.

Controls the grid's current cell selection mode. This determines how users may interact with and select individual or grouped cells.

An array of cell selections currently active in the grid. Each selection is a rectangular range of selected cells, useful for bulk editing, clipboard actions, or analytics.

Specifies the number of extra columns to render after the last visible column. Helps with smoother horizontal scrolling to the right.

Specifies the number of extra columns to render before the first visible column. Helps with smoother horizontal scrolling to the left.

Controls how many columns back the grid should look when computing layout for column-spanning cells. Larger values allow broader spans but can reduce rendering efficiency.

A base column configuration object used as a fallback for individual columns.

If true, double-clicking on a column's resize handle will trigger an autosize for that column based on its content.

The default expansion state for column groups when no specific state has been set.

A map of column group ids to their expansion state. This controls whether individual groups are expanded or collapsed. Direct mutation bypasses grid events.

The delimiter string used to construct hierarchical column group ids by joining nested keys.

Computed metadata about the column group structure in the grid. This is used internally for layout and interaction logic involving grouped headers.

Configuration object for the marker column, which is often used to indicate row-specific states like expansion or editing.

Enables or disables the marker column in the grid.

Computed metadata for each column in the grid, including rendering metrics and positional information. Useful for custom layout or advanced plugin behavior.

Tracks the expansion state of column groups generated by pivot operations. Each key is a group id, and the value indicates whether it's expanded or collapsed.

The generated columns from the current pivot model. These columns represent data values derived from pivot operations. They may be updated, but changes may be overridden if the pivot model changes.

Controls whether column pivoting is enabled in the grid. When true, pivot columns will be generated based on the active pivot model.

The current column pivot model in use. This model defines how column pivoting is structured in the grid and which columns are used to generate pivot dimensions.

Tracks the expansion state of row groups generated by the current pivot model. Each key is a row group id, and the value determines its expansion state.

All column definitions registered in the grid, including both visible and hidden columns.

Controls whether columns should automatically resize to fit the available width of the grid viewport.

A dictionary of dialog frames currently managed by the grid. These frames can be programmatically opened or closed using the dialogFrameOpen and dialogFrameClose API methods.

Represents the current active edit position in the grid. If no edit is active, this is null.

Determines the cell edit mode for the grid. Modes include read-only and editable states.

Specifies the mouse interaction pattern (e.g., single click, double click) required to activate a cell edit.

A map of named edit renderers. These renderers are used to customize the editing experience for cells in editable columns.

A function used to validate updates to a row during an edit. This validator can prevent invalid edits before they are applied to the grid state.

The in (set) filter model to apply to LyteNyte Grid.

An array of filters currently applied to the grid. If empty, no filters are active.

A map of named floating row cell renderers. These renderers can be assigned by name in the floating row column configurations.

Controls whether the floating row is enabled in the grid. When enabled, the floating row appears fixed below the column headers.

Specifies the height, in pixels, of the floating row when enabled.

A unique identifier associated with the grid instance.

A map of named header cell renderers. These can be referenced in column definitions to customize how column headers are displayed.

The vertical height (in pixels) allocated for grouped header rows, if present.

The vertical height (in pixels) allocated for the header row of the grid.

The total height (in pixels) of all rows currently present in the grid.

A dictionary of popover frames currently managed by the grid. These can be dynamically shown or hidden using the popoverFrameOpen and popoverFrameClose API methods.

Represents the current quick search input applied to the grid. When set, rows will be filtered using this value. If null or an empty string, no quick search filtering will be applied.

Specifies whether the quick search is case-sensitive or insensitive. Controls how text is matched during quick search filtering.

A fallback row height (in pixels) used before actual row heights are measured. Especially useful when rendering rows with dynamic or unknown content heights.

The configured row data source for the grid. This defines how rows are fetched, paged, or streamed into the grid.

The backing store for row data within the grid. This is managed internally and should not be mutated directly unless implementing a custom data source.

The default estimated height for row detail sections before their actual height has been measured.

Represents the set of row ids with expanded row detail sections.

Specifies the height of the row detail section when expanded.

The function that renders additional row detail content when a row is expanded.

A predicate function used to determine whether a given row should be rendered as a full-width row. Full-width rows span across all columns and bypass standard cell layout.

The component function that renders full-width rows in the grid. This renderer is called whenever a row matches the full-width predicate.

Defines the template or configuration for the automatically generated row group column. This controls its appearance and behavior.

Controls the default expansion state of all row groups. If a number is provided, groups up to that depth will be expanded by default.

Specifies how automatically generated row group columns should be displayed in the grid. This controls their visibility and layout.

An object mapping row group ids to their expansion state. Updating this directly will not trigger grid events and should be done with care.

An array representing the fields or columns being used to group rows. An empty array disables row grouping.

The height configuration for rows in the grid. This may be a fixed number, a function, or a configuration object.

Specifies the number of additional rows to render below the visible viewport. Increasing this value can reduce flickering when scrolling downward, but may negatively impact rendering performance.

Specifies the number of additional rows to render above the visible viewport. Increasing this value can reduce visible loading artifacts when scrolling upward, at the cost of performance.

Controls how many rows back the grid should look when computing layout for row-spanning cells. Higher values allow larger spans but impact performance.

If true, selecting a parent row will automatically select its child rows. Useful for hierarchical or grouped data selection.

A set of selected row ids in the grid.

Specifies the interaction pattern or input trigger that initiates row selection, such as clicks or keyboard inputs.

Specifies the selection mode of the grid, such as single or multiple row selection.

Identifies the anchor row used for shift-based range selections. Defines the selection starting point.

Boolean flag that determines whether the grid renders in right-to-left (RTL) mode.

An array representing the current sort state of the grid. Each entry defines a column and its sort direction. An empty array means no active sorting.

The current view bounds of the grid, representing the row and column segments that should be rendered based on scroll position and viewport.

The HTML element representing the viewport of the grid. May be null before initialization.

The internal height of the viewport, typically matching the clientHeight of the viewport element.

The outer height of the viewport, corresponding to its offsetHeight.

The internal width of the viewport, usually equal to the clientWidth of the viewport element.

The outer width of the viewport, corresponding to its offsetWidth.

Controls whether columns should be virtualized. Improves performance for large column sets by only rendering visible columns. Enabled by default.

Controls whether rows should be virtualized. Improves performance for large datasets by only rendering visible rows. Enabled by default.

The total combined width (in pixels) of all visible columns in the grid.

The horizontal (x-axis) pixel positions of each visible column in the grid. Used to determine where each column should render on screen.

The vertical (y-axis) pixel positions of rows in the grid. Determines how each row is positioned within the scrollable area.

The initial aggregation model to apply to LyteNyte Grid.

No properties

The map of named cell renderers that can be referenced by name in the grid.

The cell selection mode to use.

The initial cell selections in the grid.

No properties

The number of columns after the last visible column to render.

Type

number

The number of columns before the first visible column to render.

Type

number

The number of columns LyteNyte Grid should scan when computing layout.

Type

number

The base column definition.

A boolean indicating if double click to autosize a column should be enabled.

Type

boolean

The default expansion state for column groups if not specified explicitly.

Type

boolean

The initial expansion state for column groups.

A delimiter used to concatenate group paths into a single group id.

Type

string

The column marker definition.

A boolean indicating if the column marker should be visible.

Type

boolean

A boolean indicating if the column pivot mode should be on.

Type

boolean

The initial column pivot model to apply to LyteNyte Grid.

The initial column definitions.

No properties

Indicates whether the grid should size columns to fit the available width.

Type

boolean

The dialog frames available in the grid.

The initial cell edit mode.

The mouse interaction that should begin cell editing.

The edit renderers that may be referenced by name.

A function for validating grid updates at a row level.

The in (set) filter model to apply to LyteNyte Grid.

The initial filter model to apply to the grid.

The floating cell renderers that may be referenced by name.

A boolean indicating if the floating row should be enabled.

Type

boolean

The height in px of the floating row.

Type

number

A unique identifier for the grid instance.

Type

string

The header cell renderers that may be referenced by name.

The height in pixels for the header groups.

Type

number

The height in pixels that the header should occupy.

Type

number

The popover frames available in the grid.

The quick search filter value.

Type

null | string

Variants

• null
• string

The case sensitivity of the quick search filter.

Initial height guess for auto-height rows, used before actual measurement.

Type

number

The data source used by LyteNyte Grid to manage and provide row data.

The initial guess of the height of a row detail area before the actual height is observed.

Type

number

The initial row detail expansion state.

The height of the row detail area.

A function used to render the content for a row detail area.

The function predicate used to determine if a row should be rendered as full width.

The renderer used to render the content of a full width row.

Template for generating row group columns dynamically.

Default expansion depth for row groups. Can be a boolean or a depth number.

Type

number | boolean

Variants

• number
• boolean

The row group display mode to use in the grid.

Initial expansion state of specific row groups by row id.

No properties

The initial row group model configuration to apply.

No properties

Row height strategy used by LyteNyte Grid for rendering rows.

The number of rows below the last visible row to render.

Type

number

The number of rows above the first visible row to render.

Type

number

The number of rows LyteNyte Grid should scan when computing layout.

Type

number

A boolean indicating if the row selection should select children as well.

Type

boolean

The initial selected row ids.

The mouse interaction that should begin row selection.

The row selection mode to use.

Whether to use right-to-left rendering. If false, left-to-right is assumed.

Type

boolean

The initial sort model to apply to the grid.

No properties

A boolean indicating if the columns in the grid should be virtualized.

Type

boolean

A boolean indicating if the rows in the grid should be virtualized.

Type

boolean