Unions
The following unions are available in the Data Grid component:
| Name | Value | Description |
|---|---|---|
| PivotControlAction | '' | |
| PivotControlAxis | 'rows' | 'columns' | 'values' | |
| PivotControlCommand | 'PivotControlAction' | |
| PivotRow | 'PivotResultRow' | Internal rows intentionally do not implement the consumer's source-record type. |
| PivotWorkerCommand | 'unknown' | |
| AutoFillModuleType | 'Function' | Type definition for the autofill module. The module is a function, typically the useAutoFill hook, that accepts AutoFillModuleOptions and returns an AutoFill instance. |
| ClipboardModuleType | 'Function' | Type definition for the clipboard module. A clipboard module is a function (typically the useClipboard hook) that accepts ClipboardModuleOptions and returns a Clipboard instance with copy, paste, and cut methods. |
| PinDirectionInput | 'ColumnPinDirection' | 'string' | Public input shape for |
| ChartType | 'Bar' | 'StackingBar' | 'StackingBar100' | 'Pie' | 'Column' | 'StackingColumn' | 'StackingColumn100' | 'Line' | 'StackingLine' | 'StackingLine100' | 'Area' | 'StackingArea' | 'StackingArea100' | 'Scatter' | |
| EditMode | 'Normal' | 'Popup' | 'PopupTemplate' | 'Cell' | Defines the editing interaction mode for grid records.
|
| PopupSettings | 'Partial<ComponentProps<typeof Dialog>>' | Configuration settings for customizing the Syncfusion |
| ContextMenuItem | 'Edit' | 'Delete' | 'Save' | 'Cancel' | 'SortAscending' | 'SortDescending' | 'ClearSort' | 'FirstPage' | 'PrevPage' | 'LastPage' | 'NextPage' | 'SelectRow' | 'ClearRowSelection' | 'ClearSelection' | 'Sum' | 'Average' | 'Min' | 'Max' | 'Count' | 'TrueCount' | 'FalseCount' | 'Custom' | 'UnpinRow' | 'PinToTop' | 'PinToBottom' | 'UnpinColumn' | 'PinToLeft' | 'PinToRight' | 'Bar' | 'StackingBar' | 'StackingBar100' | 'Pie' | 'Column' | 'StackingColumn' | 'StackingColumn100' | 'Line' | 'StackingLine' | 'StackingLine100' | 'Area' | 'StackingArea' | 'StackingArea100' | 'Scatter' | Defines the set of built-in context menu item types available in the Data Grid component. Specifies the standard actions that can be displayed in context menus when right-clicking on grid cells or rows. Used to configure which default menu items should appear in the context menu alongside custom items. |
| FilterType | 'FilterBar' | 'Excel' | 'CheckBox' | 'Menu' | Defines the type of filter UI to be used in the Data Grid component. Controls the visual interface and behavior for applying filters to columns.
|
| IndicatorType | 'Spinner' | 'Shimmer' | Defines Loading Indicator of the Grid.
|
| PrintRange | 'All' | 'CurrentPage' | 'Custom' | Defines the range of rows to include in the print operation.
|
| ToolbarItems | 'Add' | 'Edit' | 'Update' | 'Delete' | 'Cancel' | 'Search' | 'ColumnChooser' | 'Print' | 'PdfExport' | Defines the set of actionable items displayed in the grid toolbar. Each item maps to a specific user command. Enables direct data operations, UI control.
|
| ExcelBorderLineStyle | 'thin' | 'thick' | Defines excel border line style.
|
| ExcelExportRange | 'All' | 'CurrentPage' | 'Custom' | Specifies the row range to include in an Excel export operation.
|
| ExcelHAlign | 'Left' | 'Right' | 'Center' | 'Fill' | Defines Excel horizontal alignment.
|
| ExcelVAlign | 'Top' | 'Bottom' | 'Center' | 'Justify' | Defines Excel vertical alignment.
|
| MultipleGridExportMode | 'AppendToPage' | 'NewPage' | Specifies export mode for multiple grids.
|
| CustomFormulaFunction | 'Function' | Callback contract for a registered custom formula function. |
| FormulaErrorCode | '#INVALID_REFERENCE' | '#CIRCREF!' | '#PARSE!' | '#NAME?' | Stable error values produced by formula evaluation. |
| FormulaModuleType | 'Function' | Injectable FormulaModule factory contract. |
| FormulaValue | 'ValueType' | 'FormulaErrorCode' | Values exposed by formula projections. |
| GroupSummary | 'Function' | Callback type for determining row selectability and checkbox visibility per row. |
| AggregateData | 'unknown' | Represents the structure of aggregate result values returned by the Data Grid component.
Includes raw numeric values for computation and formatted display values for rendering.
Raw values are keyed by Used in |
| ValueType | 'number' | 'string' | 'Date' | 'boolean' | 'undefined' | Defines the supported data types for grid values, used in filtering, sorting, and other operations.
|
| DetailRowTemplate | 'Function' | Represents a template function for rendering detail rows. Returns React elements that define the complete detail content, typically including a nested grid or custom components. |
| BorderLineStyle | 'Thin' | 'Thick' | Defines border line style.
|
| ContentType | 'Image' | 'Line' | 'PageNumber' | 'Text' | Defines PDF ContentType.
|
| PdfDashStyle | 'Solid' | 'Dash' | 'Dot' | 'DashDot' | 'DashDotDot' | Defines the PDF dash style.
|
| PdfExportRange | 'All' | 'CurrentPage' | 'Custom' | Defines the range of rows to export from the grid. Available options:
|
| PdfHAlign | 'Left' | 'Right' | 'Center' | 'Justify' | Defines PDF horizontal alignment.
|
| PdfPageNumberType | 'LowerLatin' | 'LowerRoman' | 'UpperLatin' | 'UpperRoman' | 'Numeric' | 'Arabic' | Defines PDF PageNumber Type.
|
| PdfVAlign | 'Top' | 'Bottom' | 'Middle' | Defines PDF vertical alignment.
|
| PinningModuleType | 'Function' | Defines the row pinning module factory contract. Creates a row pinning module from grid-specific initialization options. |
| PivotAxisPath | 'Array' | Defines the path of a generated pivot member within a row or column hierarchy. Each segment identifies the source field and member value that produced the current hierarchy node. Used by pivot result rows and columns to preserve typed member identity for rendering and interaction. |
| PivotMeasureMetadata | 'unknown' | Defines metadata for a generated pivot measure column in the final result matrix. Describes the generated column identity, source field, and aggregate used to calculate its value. |
| PivotMemberValue | 'unknown' | Represents the scalar value carried by a generated pivot member identity. The value is opaque to the Grid contract so member comparison and filtering remain independent of the source record type. |
| PivotTotalKind | 'detail' | 'subtotal' | 'grandTotal' | Identifies the total state for a generated pivot row or column. A detail entry represents a leaf member, a subtotal represents an intermediate group, and a grand total represents the complete report. |
| PivotAggregateType | 'Sum' | 'Count' | 'Min' | 'Max' | 'Average' | 'Sum' | 'Count' | 'Min' | 'Max' | 'Average' | Defines the aggregate operations supported for pivot value calculations. Combines the grid aggregate enum with the literal names used by the pivot engine. Used when configuring numeric summaries for pivot rows, columns, and totals. |
| PivotColumnGroupOverrides | 'Partial<Pick<ColumnProps<PivotResultRow>, 'headerText'' | ''headerTemplate'' | ''headerTextAlign'' | ''customAttributes'>>' | Presentation overrides for a generated pivot group header. |
| PivotColumnOverrides | 'Partial<Pick<ColumnProps<PivotResultRow>, 'headerText'' | ''headerTemplate'' | ''template'' | ''format'' | ''width'' | ''minWidth'' | ''maxWidth'' | ''textAlign'' | ''headerTextAlign'' | ''cellClass'' | ''customAttributes'' | ''visible'' | ''allowResize'>>' | Presentation overrides for a generated pivot value column. |
| PivotErrorCode | 'InvalidField' | 'InvalidSettings' | 'UnsupportedDataSource' | 'UnsupportedScrollMode' | 'ColumnLimitExceeded' | 'CalculationFailed' | Defines the supported pivot calculation error codes. Used to classify failures returned by the pivot engine or report validation. |
| PivotResultColumnId | 'unknown' | Identifies a generated pivot result column in the rendered matrix. This value is distinct from source-record keys and is only valid within the pivot result model. |
| PivotResultRowId | 'unknown' | Identifies a generated pivot result row in the rendered matrix. This value is distinct from source-record keys and is only valid within the pivot result model. |
| RowReorderModuleType | 'Function' | Provides the row reordering handler set returned by the module factory. |
| IsRowSelectable | 'Function' | Callback type for determining row selectability and checkbox visibility per row. |
| SideBar | 'SideBarDef' | Public sidebar configuration accepted by the Grid component. |
| SideBarPanelId | 'columns' | 'filters' | 'editing' | 'string' | Identifies a built-in or consumer-defined sidebar panel. |
| SideBarToolPanelModule | 'Function' | Defines the injectable contract for a built-in sidebar panel module. |