Unions

The following unions are available in the Data Grid component:

NameValueDescription
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 field - type (e.g., Freight - sum for summation on the "Freight" field). Formatted values are keyed by AggregateType enum members (e.g., Sum for rendering summation results).

Used in footerTemplate rendering and custom aggregation logic.

EditMode
'Normal' | 'Popup' | 'PopupTemplate' | 'Cell'

Defines the editing interaction mode for grid records.

  • Normal - Allows inline editing directly within grid cells.
  • Popup - Displays edit form in a modal dialog with auto-generated fields.
  • PopupTemplate - Displays edit form in a modal dialog using custom template.
  • Cell - Allows editing individual cells with field-based tracking.
PopupSettings
'Partial<ComponentProps<typeof Dialog>>'

Configuration settings for customizing the Syncfusion Dialog component used in popup edit mode. Accepts any valid Dialog component props as partial properties for dialog customization.

ContextMenuItem
'Edit' | 'Delete' | 'Save' | 'Cancel' | 'SortAscending' | 'SortDescending' | 'ClearSort' | 'FirstPage' | 'PrevPage' | 'LastPage' | 'NextPage' | 'SelectRow' | 'ClearRowSelection' | 'ClearSelection' | 'Sum' | 'Average' | 'Min' | 'Max' | 'Count' | 'TrueCount' | 'FalseCount' | 'Custom'

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'

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.

  • FilterBar - Specifies the filter type as filter bar.
  • Excel - Specifies the filter type as excel filter.
  • CheckBox - Specifies the filter type as checkbox filter.
IndicatorType
'Spinner' | 'Shimmer'

Defines Loading Indicator of the Grid.

  • Spinner - Defines Loading Indicator as Spinner.
  • Shimmer - Defines Loading Indicator as Shimmer.
PrintRange
'All' | 'CurrentPage' | 'Custom'

Defines the range of rows to include in the print operation.

  • All - Prints all rows from the data source.
  • CurrentPage - Prints only rows displayed on the current page.
  • Custom - Prints a specified range of rows using startRow and endRow.
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.

  • Add - Creates new row or record. Opens blank form or inserts editable row.
  • Edit - Enables editing for selected row. Supports selection logic, inline editing.
  • Update - Saves changes to data source. Triggers validation, lifecycle hooks.
  • Delete - Removes selected row or record.
  • Cancel - Discards unsaved changes. Exits edit mode, maintains data integrity.
  • Search - Displays input for row filtering. Supports keyword match, column-level queries
  • ColumnChooser - Opens column chooser dialog for showing/hiding columns
  • Print - Prints the grid with configured data range and formatting options.
ExcelBorderLineStyle
'thin' | 'thick'

Defines excel border line style.

  • thin - Excel border line style as thin line.
  • thick - Excel border line style as thick line.
ExcelExportRange
'All' | 'CurrentPage' | 'Custom'

Specifies the row range to include in an Excel export operation.

  • All — Exports every row from the full data source.
  • CurrentPage — Exports only the rows visible on the current page.
  • Custom — Exports rows within the range defined by customRange.
ExcelHAlign
'Left' | 'Right' | 'Center' | 'Fill'

Defines Excel horizontal alignment.

  • Left - Aligns excel content to left.
  • Right - Aligns excel content to right.
  • Center - Aligns excel content to center.
  • Fill - Aligns excel content to fill.
ExcelVAlign
'Top' | 'Bottom' | 'Center' | 'Justify'

Defines Excel vertical alignment.

  • Top - Aligns excel content to top.
  • Bottom - Aligns excel content to bottom.
  • Center - Aligns excel content to center.
  • Justify - Aligns excel content to justify.
ValueType
'number' | 'string' | 'Date' | 'boolean'

Defines the supported data types for grid values, used in filtering, sorting, and other operations.

  • number - Represents numeric values.
  • string - Represents text values.
  • Date - Represents date values.
  • boolean - Represents true/false values.
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.

  • thin - Border line style as thin line.
  • thick - Border line style as thick line.
ContentType
'Image' | 'Line' | 'PageNumber' | 'Text'

Defines PDF ContentType.

  • Image - PDF content is Image type
  • Line - PDF content is Line type
  • PageNumber - PDF content is PageNumber type
  • Text - PDF content is Text type
PdfDashStyle
'Solid' | 'Dash' | 'Dot' | 'DashDot' | 'DashDotDot'

Defines the PDF dash style.

  • Solid - Solid DashStyle
  • Dash - Dash DashStyle
  • Dot - Dot DashStyle
  • DashDot - DashDot DashStyle
  • DashDotDot - DashDotDot DashStyle
PdfExportRange
'All' | 'CurrentPage' | 'Custom'

Defines the range of rows to export from the grid. Available options:

  • All - Exports all rows from the data source.
  • CurrentPage - Exports only rows visible on the current page.
  • Custom - Exports rows within a custom range specified by PdfExportCustomRange.
PdfHAlign
'Left' | 'Right' | 'Center' | 'Justify'

Defines PDF horizontal alignment.

  • Left - Aligns PDF content to left.
  • Right - Aligns PDF content to right.
  • Center - Aligns PDF content to center.
  • Justify - Aligns PDF content to justify.
PdfPageNumberType
'LowerLatin' | 'LowerRoman' | 'UpperLatin' | 'UpperRoman' | 'Numeric' | 'Arabic'

Defines PDF PageNumber Type.

  • LowerLatin - LowerCase Latin pageNumber
  • LowerRoman - LowerCase Roman pageNumber
  • UpperLatin - UpperCase Latin pageNumber
  • UpperRoman - UpperCase Roman pageNumber
  • Numeric - Numeric pageNumber
  • Arabic - Arabic pageNumber
PdfVAlign
'Top' | 'Bottom' | 'Middle'

Defines PDF vertical alignment.

  • Top - Aligns PDF content to top.
  • Bottom - Aligns PDF content to bottom.
  • Middle - Aligns PDF content to middle.
IsRowSelectable
'Function'

Callback type for determining row selectability and checkbox visibility per row.