Initial Grid State
ColumnProvidedProps<T>
Provides the initial configuration for columns within Graphite Grid, including default settings and dynamic properties.
Type parameters
Type parameter |
---|
T |
Properties
- Name
baseColumnDefinition?
- Type
- BaseColumnDefinition<T>
- Description
Specifies the base column definition used as a starting point for all column configurations. All specific column definitions are merged with this base definition to form the final setup.
- Name
columnDefinitions?
- Type
- ColumnDefinition<T>[]
- Description
Specifies the initial set of column definitions for the grid. These definitions provide detailed configurations for each column, including visual and interactive properties that dictate how the columns behave and appear within the grid.
- Name
columnGroupExpansions?
- Type
- Record<string, null | boolean>
- Description
Provides initial settings for the expansion state of column groups. This property accepts a record object where each key corresponds to a column group Id and each value indicates whether the group is expanded or collapsed. This setup allows users to preset the visibility of grouped columns, tailoring the initial view to specific requirements or user preferences.
- Name
columnHeaderGroupHeight?
- Type
- number | "auto"
- Description
Specifies the height of the column group headers. Similar to
columnHeaderHeight
, setting this to"auto"
may require disabling column virtualization for accurate measurements.
- Name
columnHeaderGroupRenderer?
- Type
- null | (p) => Element | None
- Description
Provides a custom renderer for column group headers, applicable to headers that span multiple columns. Since column groups do not belong to any particular column, a custom renderer allows for flexible display options.
- Name
columnHeaderHeight?
- Type
- number | "auto"
- Description
Specifies the height of the column headers. When set to
"auto"
, it is recommended to disable column virtualization to ensure proper layout calculations.
- Name
columnIdPathDelimiter?
- Type
- string
- Description
When a ColumnDefinition specifies a
groupId
path, Graphite Grid joins the path segments into a single string to form the column group Id. ThecolumnIdPathDelimiter
property allows customization of the delimiter used in this process, replacing the default delimiter with a user-defined string for greater flexibility in naming conventions.
- Name
headerTooltipHideDelayMs?
- Type
- number
- Description
Specifies the delay in milliseconds before hiding a tooltip that is currently displayed over a column header. This delay allows the tooltip to remain visible briefly even after the user stops hovering over the header, enhancing readability.
- Name
headerTooltipMouseOnly?
- Type
- boolean
- Description
Determines whether tooltips on column headers should only appear when the user hovers over them with a mouse, as opposed to being triggered by other pointer devices such as touch screens. This setting helps optimize the interface for desktop environments where mouse use is prevalent.
- Name
headerTooltipShowDelayMs?
- Type
- number
- Description
Specifies the delay in milliseconds before displaying a tooltip over a column header when hovered. This delay allows for a brief pause before showing the tooltip, improving the user interface responsiveness.
- Name
markerColumnDefinition?
- Type
- MarkerColumnDefinition<T>
- Description
Specifies the marker column definition, allowing for overrides of some properties of the marker column.
- Name
markerColumnEnabled?
- Type
- boolean
- Description
Determines whether the marker column is enabled, controlling its visibility and functionality within the grid.
- Name
pivotColumnGroupExpansions?
- Type
- Record<string, null | boolean>
- Description
Sets initial expansion states for pivot column groups, similar to
columnGroupExpansions
but specifically for groups within the pivot view. This property allows users to define which groups of pivoted data are visible by default, providing a tailored view that highlights specific aspects of the data set.
- Name
pivotColumnIdPrefix?
- Type
- string
- Description
Overrides the default prefix used for pivot column Ids, providing a custom prefix that precedes the actual column Id in each pivot column definition. This customization is crucial for distinguishing pivot columns from regular columns, especially in configurations where multiple types of operations are performed on the same data set.
- Name
pivotColumnModel?
- Type
- string[]
- Description
Specifies the initial model for pivot columns in the grid, defined as an array of column Ids. Each Id in the model corresponds to a column that plays a role in data pivoting, defining how data is grouped and aggregated in the pivot view. This property sets up the foundation for complex data manipulation tasks, enabling users to extract significant insights from large datasets.
- Name
pivotColumnSource?
- Type
- null | "client" | PivotColumnSourceClient<T> | PivotColumnSourceControlled<T>
- Description
Specifies the source of pivot columns, dictating how these columns are generated and updated. The source can be
controlled
, allowing full customization of pivot column behavior, orclient
, which utilizes client-side data to automatically determine the pivot columns. This property defines how the grid interacts with data to create a dynamic pivot view, adapting to various data sources and user interactions.
- Name
pivotModeIsOn?
- Type
- boolean
- Description
Controls whether the grid operates in column pivot mode. Activating pivot mode changes how columns are displayed based on pivot configurations, allowing dynamic rearrangement and aggregation of data across multiple dimensions. This mode is essential for advanced data analysis and visualization tasks.
- Name
stickyHeaderLabel?
- Type
- boolean
- Description
Determines whether the header label remains visible while its associated column is partially visible during scrolling. Setting this property to true ensures that the header is always visible as long as any part of the column is in view.