Declarative State Reference

Defines which aggregation function should be applied to each column in the grid. The keys in this object are column IDs, and the values are the names of aggregation functions that should be used for those columns.

The aggregation function names must correspond to keys in the aggFns object. When data is grouped or summarized, these functions will be applied to calculate aggregate values for each column.

Defines the available cell edit providers that can be used within the grid. Each key in the object represents the name of a cell edit provider, and the corresponding value is the implementation of that provider.

Cell edit providers determine how cells are edited, including the UI components that appear during editing, how values are validated, and how edits are committed or canceled. Different columns can use different edit providers based on their data types and editing requirements.

Specifies how cell selection behaves in the grid. This property controls whether users can select individual cells, ranges of cells, entire rows, columns, or other selection patterns, and how these selections can be created or modified.

Defines custom renderers for column headers in the grid. Each key in the object represents the name of a header renderer, and the corresponding value is the implementation of that renderer.

Custom header renderers allow you to control exactly how column headers are displayed, including custom formatting, icons, and interactive elements within the header area.

Specifies the height of column group headers in the grid. This property controls the vertical space allocated for headers that represent groups of columns.

Specifies a custom renderer for column group headers. This renderer controls how the headers for column groups are displayed in the grid.

By providing a custom renderer, you can control the appearance and behavior of column group headers, including customizing the display of group names, adding collapse/expand controls, or including any other interactive elements.

Determines whether column group headers should remain visible (sticky) when scrolling horizontally. When set to true, column group headers will remain fixed in position while the grid content scrolls.

This improves user experience by maintaining context about which column group is being viewed even when scrolling through wide datasets.

Specifies the delimiter character used to separate levels in hierarchical column group IDs. This is used when constructing and parsing IDs for nested column groups.

For example, with a delimiter of "/", a column group ID might look like "region/country/city", representing a three-level hierarchy of column groups.

Defines the current expansion state of column groups in the grid. The keys in this object are column group IDs, and the values are booleans indicating whether each group is expanded.

This allows for programmatic control over which column groups are expanded or collapsed at any given time, enabling features like "expand all" or "collapse all" operations.

A function that determines the default expansion state for a given column group. This function is called when a column group's expansion state is not explicitly defined in the columnGroupExpansionState object.

By providing a custom implementation, you can control which column groups are expanded by default based on their characteristics, such as level in the hierarchy or group name.

Determines how far to scan when calculating column spans. This property defines the maximum number of columns to check when resolving spanning cells.

A larger value allows for wider spanning cells but may impact performance with very large grids. Typically, this value should be set to cover the maximum possible column span in the grid.

Defines the columns to be displayed in the grid. This array contains column definitions that specify how each column should behave and appear.

Each column definition includes properties like the column's ID, title, width, renderer, and other configuration options that control the column's behavior and appearance.

Specifies a base configuration for all columns in the grid. Properties defined in this object will be used as defaults for all columns, unless overridden by specific column definitions.

This allows for consistent column behavior across the grid while still allowing for customization of individual columns as needed.

Specifies which columns are used to pivot the grid data. This array contains column IDs that will be used as pivot columns, where unique values in these columns will become new columns in the resulting pivoted view.

Specifies the height of the floating row in the grid. This property controls the vertical space allocated for the floating row when it is enabled.

The height can be specified as a fixed number of pixels or using a more complex configuration that allows for different heights based on specific conditions or requirements.

Defines custom renderers for cells in the floating row. Each key in the object represents the name of a floating cell renderer, and the corresponding value is the implementation of that renderer.

Custom floating cell renderers allow you to control exactly how cells in the floating row are displayed, including custom formatting, interactive elements, and specialized content like summary calculations or input controls.

Defines the maximum number of row updates that can be stored in the update stack, which enables undo/redo functionality for changes to row data. When this limit is reached, older updates are removed.

Determines whether the row update stack is enabled. When set to true, the grid will track changes to row data, allowing for operations like undo and redo.

When set to true, displays a marker or indicator that can be clicked to expand or collapse the row detail section. This provides a visual cue that a row has additional detail content available.

Specifies a custom renderer for the detail section of a row. This renderer controls how the expanded detail content is displayed when a row is expanded to show additional information.

Determines whether row details are enabled for specific rows. This can be a boolean value applied to all rows or a function that evaluates each row individually to determine if it should have details available.

Specifies the height of the detail section when a row is expanded. This can be a fixed height for all row details or a function that determines the height based on the specific row data.

A Set containing the IDs of rows that are currently expanded to show their detail section. This allows for programmatic control over which rows have their details visible.

Determines whether row dragging is enabled in the grid. When set to true, users can drag rows to reorder them or move them between groups or grids.

When set to true, allows multiple rows to be selected and dragged as a group. This enables operations on multiple rows simultaneously through drag and drop.

Specifies other grid instances that can participate in drag and drop operations with this grid. This enables dragging rows between separate grid instances.

A function that determines whether a specific row can be dragged. This allows for fine-grained control over which rows are draggable based on row data or other conditions.

When set to true, the grid will automatically apply default aggregation functions to columns when rows are grouped, without requiring explicit configuration of the aggregation model.

Defines a template for columns that are generated to display row group information. This controls the appearance and behavior of group columns when row grouping is active.

Specifies which columns are used for grouping rows. This array contains column IDs in the order they should be applied for hierarchical grouping.

Determines how grouped rows are displayed in the grid, such as whether grouped columns are hidden or shown alongside the generated group columns.

Controls the default expansion state of row groups. This can be a boolean that applies to all groups or a number representing the maximum depth to which groups should be expanded by default.

Defines which row groups are currently expanded. This allows for programmatic control over the expansion state of individual groups in the grid.

Specifies the height of rows in the grid. This can be a fixed height applied to all rows or a function that determines the height based on the specific row data.

Controls the display and behavior of checkboxes used for row selection. This can specify whether checkboxes are shown, their position, and appearance.

Determines when a row should be selected in response to pointer events. This function controls the exact behavior that triggers row selection, such as click or click-and-drag.

Specifies the row selection mode, such as whether single or multiple rows can be selected at once, and how selection behavior works when clicking on rows.

A Set containing the IDs of rows that are currently selected. This allows for programmatic control over which rows are selected in the grid.

Determines which rows can be selected. This can be a predefined value like "all", "group-only", "leaf-only", or a custom function that evaluates each row individually.

When set to true, selecting a group row will automatically select all of its child rows. This applies to hierarchical data with parent-child relationships.

When set to true, allows multiple rows to be selected by clicking on them individually without requiring modifier keys like Ctrl or Shift to be pressed.

Determines how far to scan when calculating row spans. This property defines the maximum number of rows to check when resolving spanning cells.

A function that determines whether a specific row should be rendered using full width mode, which spans across all columns rather than being divided into cells.

Specifies a custom renderer for rows that are displayed in full width mode. This renderer controls how full width rows are displayed in the grid.

Specifies the number of rows to display per page when pagination is enabled. This controls how many rows are visible at once before requiring navigation to another page.

Indicates which page is currently displayed in the grid. Page numbering is zero-based, so the first page is represented by 0, the second page by 1, and so on.

Provides custom comparison functions for sorting specific columns. This object maps column IDs to comparator functions that define how values in those columns should be compared when sorting, allowing for specialized sorting logic beyond the default comparisons.

Defines the available overlays that can be displayed on the grid. This object maps overlay IDs to their corresponding overlay configurations, allowing for multiple predefined overlays that can be shown or hidden as needed.

A function that determines whether a context menu should be displayed for a specific cell or location in the grid. This allows for conditional display of context menus based on cell content, user permissions, or other factors.

Specifies a custom renderer for column header menus. This renderer controls the appearance and content of menus that appear when interacting with column headers, such as for sorting, filtering, or column operations.

Defines custom panel components that can be displayed within the grid. Each key in this object represents a panel ID, and the corresponding value is the panel configuration. Panels provide a way to display complex UI components alongside or within the grid.

Specifies buttons that should appear in the header area of panel frames. These buttons allow users to interact with or control panels, such as closing, minimizing, or performing specific actions related to the panel content.

Defines custom dialog components that can be displayed over the grid. Each key in this object represents a dialog ID, and the corresponding value is the dialog configuration. Dialogs provide modal interfaces for user interaction or information display.

Defines custom popover components that can be displayed near specific elements in the grid. Each key in this object represents a popover ID, and the corresponding value is the popover configuration. Popovers provide contextual information or controls related to specific grid elements.

Defines custom menu components that can be displayed within the grid. Each key in this object represents a menu ID, and the corresponding value is the menu configuration. These menus can be used for custom dropdown or context menu implementations.