Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IIgrDataGridProps

Hierarchy

Hierarchy

  • IIgrDataGridProps

Properties

Properties

Optional activationMode

activationMode?: string | GridActivationMode

Sets or gets the grid selection mode.

Optional activeCell

activeCell?: IgrGridCellPosition

Gets or sets the position of the active cell.

Optional activeCellChanged

activeCellChanged?: ((s, e) => void)

Type declaration

Optional actualBorderWidth

actualBorderWidth?: Thickness

Gets the actual border width.

Optional actualColumnsChanged

actualColumnsChanged?: ((s, e) => void)

Type declaration

Optional actualCornerRadiusBottomLeft

actualCornerRadiusBottomLeft?: string | number

Optional actualCornerRadiusBottomRight

actualCornerRadiusBottomRight?: string | number

Optional actualCornerRadiusTopLeft

actualCornerRadiusTopLeft?: string | number

Optional actualCornerRadiusTopRight

actualCornerRadiusTopRight?: string | number

Optional actualHeaderHeight

actualHeaderHeight?: string | number

Gets the height used for the header row.

Optional actualPrimaryKey

actualPrimaryKey?: string[]

Gets either the inferred primary key from the data source, or the user provided primary key, if present. Represents the actual primary key that the grid will use in operations that require it.

Optional actualRowHeight

actualRowHeight?: string | number

Gets the actual height for the rows in the grid.

Optional allowCopyOperation

allowCopyOperation?: string | boolean

Optional animationSettings

animationSettings?: IgrGridAnimationSettings

Sets or gets the default animation settings for the grid.

Optional autoAcceptEdits

autoAcceptEdits?: string | boolean

Gets or sets whether to automatically accept edits or require explicit acceptance or rejections of edits when handling the CellValueChanging or DataCommitting events. When True, nothing is required on the part of the developer in order for edits to be accepted. In order to validate and reject a user cell edit you must explicitly handle the CellValueChanging event and call the RejectEdit method using the edit ID provided by the event. In order to reject a whole commit you need to handle the DataComitting event and explicitly call the RejectCommit method using the commit ID provided by the event. When False, cell edits are not immediately accepted until you explicitly call the AcceptEdit method using the edit ID provided by the CellValueChanging event. If you do not handle this event then edits will be auto accepted.

Optional autoGenerateColumns

autoGenerateColumns?: string | boolean

Configures whether or not the grid will autogenerate columns when the data source is set.

Optional autoGenerateDesiredProperties

autoGenerateDesiredProperties?: string[]

Gets or sets the desired properties the grid will automatically generate columns for.

Optional border

border?: string

Gets or sets the border color around the grid.

Optional borderWidthBottom

borderWidthBottom?: string | number

Optional borderWidthLeft

borderWidthLeft?: string | number

Optional borderWidthRight

borderWidthRight?: string | number

Optional borderWidthTop

borderWidthTop?: string | number

Optional cellBackground

cellBackground?: string

Gets or sets the default background color to use for content cells

Optional cellClicked

cellClicked?: ((s, e) => void)

Type declaration

Optional cellDataLoadedAnimationMode

cellDataLoadedAnimationMode?: string | CellDataLoadedAnimationMode

Sets or gets the cell data loaded animation mode to use.

Optional cellEditEnded

cellEditEnded?: ((s, e) => void)

Type declaration

Optional cellEditStarted

cellEditStarted?: ((s, e) => void)

Type declaration

Optional cellPointerDown

cellPointerDown?: ((s, e) => void)

Type declaration

Optional cellPointerUp

cellPointerUp?: ((s, e) => void)

Type declaration

Optional cellPreviewPointerDown

cellPreviewPointerDown?: ((s, e) => void)

Type declaration

Optional cellPreviewPointerUp

cellPreviewPointerUp?: ((s, e) => void)

Type declaration

Optional cellSelectedBackground

cellSelectedBackground?: string

Gets or sets the default background color to use for content cells when a row is in a selected state

Optional cellSelectionAnimationMode

cellSelectionAnimationMode?: string | CellSelectionAnimationMode

Sets or gets the cell selection animation mode to use.

Optional cellTextColor

cellTextColor?: string

Gets or sets the default text color to use for content cells

Optional cellTextStyle

cellTextStyle?: string

Gets or sets the font to use for content cells

Optional cellValueChanging

cellValueChanging?: ((s, e) => void)

Type declaration

Optional children

children?: ReactNode

Optional clearSelectionOnEscape

clearSelectionOnEscape?: string | boolean

Gets or sets whether selection is cleared when pressing the Escape key.

Optional columnAddingAnimationMode

columnAddingAnimationMode?: string | ColumnShowingAnimationMode

Sets or gets the Column Adding Animation mode to use.

Optional columnExchangingAnimationMode

columnExchangingAnimationMode?: string | ColumnExchangingAnimationMode

Sets or gets the column exchanging animation mode to use.

Optional columnHiddenChanged

columnHiddenChanged?: ((s, e) => void)

Type declaration

Optional columnHidingAnimationMode

columnHidingAnimationMode?: string | ColumnHidingAnimationMode

Sets or gets the column hiding animation mode to use.

Optional columnMovingAnimationMode

columnMovingAnimationMode?: string | ColumnMovingAnimationMode

Sets or gets the column moving animation mode to use.

Optional columnMovingMode

columnMovingMode?: string | ColumnMovingMode

Gets or sets the type column moving to use.

Optional columnMovingSeparator

columnMovingSeparator?: IgrColumnMovingSeparator

Gets or sets the column resizing seperator settings.

Optional columnMovingSeparatorBackground

columnMovingSeparatorBackground?: string

Gets or sets the default background color to use for column moving separator.

Optional columnMovingSeparatorOpacity

columnMovingSeparatorOpacity?: string | number

Gets or sets the opacity of the column moving separator.

Optional columnMovingSeparatorWidth

columnMovingSeparatorWidth?: string | number

Sets or gets the width to use for the column resizing separator.

Optional columnOptionsIconAlignment

columnOptionsIconAlignment?: string | ColumnOptionsIconAlignment

Gets or sets the column options icon alignment in header cells.

Optional columnOptionsIconBehavior

columnOptionsIconBehavior?: string | ColumnOptionsIconBehavior

Gets or sets how the column options icon will behave inside header cells.

Optional columnOptionsIconColor

columnOptionsIconColor?: string

Gets or sets the column options icon color in header cells.

Optional columnPinnedChanged

columnPinnedChanged?: ((s, e) => void)

Type declaration

Optional columnPropertyUpdatingAnimationMode

columnPropertyUpdatingAnimationMode?: string | ColumnPropertyUpdatingAnimationMode

Sets or gets the Column Property Updating Animation mode to use.

Optional columnResizingAnimationMode

columnResizingAnimationMode?: string | ColumnResizingAnimationMode

Sets or gets the column resizing animation mode to use. Only applies when resizing in Deferred mode.

Optional columnResizingMode

columnResizingMode?: string | ColumnResizingMode

Gets or sets the type of column resizing to use.

Optional columnResizingSeparator

columnResizingSeparator?: IgrColumnResizingSeparator

Gets or sets the column resizing seperator settings.

Optional columnResizingSeparatorBackground

columnResizingSeparatorBackground?: string

Gets or sets the default background color to use for column resizing separator.

Optional columnResizingSeparatorOpacity

columnResizingSeparatorOpacity?: string | number

Gets or sets the opacity of the column Resizing separator.

Optional columnResizingSeparatorWidth

columnResizingSeparatorWidth?: string | number

Sets or gets the width to use for the column resizing separator.

Optional columnShowingAnimationMode

columnShowingAnimationMode?: string | ColumnShowingAnimationMode

Sets or gets the column showing animation mode to use.

Optional columnWidthChanged

columnWidthChanged?: ((s, e) => void)

Type declaration

Optional columnsAutoGenerated

columnsAutoGenerated?: ((s, e) => void)

Type declaration

Optional cornerRadiusBottomLeft

cornerRadiusBottomLeft?: string | number

Optional cornerRadiusBottomRight

cornerRadiusBottomRight?: string | number

Optional cornerRadiusTopLeft

cornerRadiusTopLeft?: string | number

Optional cornerRadiusTopRight

cornerRadiusTopRight?: string | number

Optional customFilterRequested

customFilterRequested?: ((s, e) => void)

Type declaration

Optional dataCommitted

dataCommitted?: ((s, e) => void)

Type declaration

Optional dataCommitting

dataCommitting?: ((s, e) => void)

Type declaration

Optional dataSource

dataSource?: any

Gets or sets the data for the grid to use.

Optional dataSourceDesiredProperties

dataSourceDesiredProperties?: string[]

Gets or sets the desired properties for the data source to load. If specified the data source may decide to constrain the properties it fetches to these properties and must make sure that at least those properties are loaded, rather than the default behavior for that data source.

Optional defaultColumnMinWidth

defaultColumnMinWidth?: string | number

Gets or sets the default minimum width to use on all columns. Ignored if NaN.

Optional defaultColumnWidth

defaultColumnWidth?: string | IgrColumnWidth

Gets or sets the default column width to use if a column as no local width.

Optional deferEventForRowDragSelection

deferEventForRowDragSelection?: string | boolean

Gets or sets whether to defer the SelectedItemsChanged and SelectedKeysChanged events till after the drag selection has completed.

Optional deletedTextColor

deletedTextColor?: string

Gets or sets the text color for unsaved deleted rows.

Optional density

density?: string | ControlDisplayDensity

Gets or sets the display density to use for the grid.

Optional editMode

editMode?: string | EditModeType

Gets or sets the type of edit mode

Optional editModeClickAction

editModeClickAction?: string | EditModeClickAction

Gets or sets the type of click action required to enter edit mode.

Optional editOnKeyPress

editOnKeyPress?: string | boolean

Gets or sets whether edit mode will begin as soon as you start typing while a cell is active.

Optional editOpacity

editOpacity?: string | number

Gets or sets the default opacity for unsaved cell edits.

Optional editRowBorder

editRowBorder?: string

Gets or sets the border color for rows being edited.

Optional editRowBorderWidthBottom

editRowBorderWidthBottom?: string | number

Optional editRowBorderWidthLeft

editRowBorderWidthLeft?: string | number

Optional editRowBorderWidthRight

editRowBorderWidthRight?: string | number

Optional editRowBorderWidthTop

editRowBorderWidthTop?: string | number

Optional editTextStyle

editTextStyle?: string

Gets or sets the font to use for cells that have been edited.

Optional enterBehavior

enterBehavior?: string | EnterKeyBehaviors

Gets or sets the behavior of the Enter key.

Optional enterBehaviorAfterEdit

enterBehaviorAfterEdit?: string | EnterKeyBehaviorAfterEdit

Gets or sets the behavior of the enter key when exiting edit mode.

Optional filterComparisonType

filterComparisonType?: string | FilterComparisonType

Gets or sets whether UI filters are case sensitive or not.

Optional filterExpressionsChanged

filterExpressionsChanged?: ((s, e) => void)

Type declaration

Optional filterExpressionsChanging

filterExpressionsChanging?: ((s, e) => void)

Type declaration

Optional filterLogicalOperator

filterLogicalOperator?: string | FilterLogicalOperator

Gets or sets how filters set through the filter UI are combined.

Optional filterUIType

filterUIType?: string | FilterUIType

Gets or sets which filter UI type to use.

Optional groupDescriptionsChanged

groupDescriptionsChanged?: ((s, e) => void)

Type declaration

Optional groupHeaderDisplayMode

groupHeaderDisplayMode?: string | GroupHeaderDisplayMode

Gets or sets how group headers are displayed when there are multiple groups defined in the grid.

Optional groupSummaryDisplayMode

groupSummaryDisplayMode?: string | GroupSummaryDisplayMode

Gets or sets the display mode summaries will use inside groups.

Optional headerBackground

headerBackground?: string

Gets or sets the default background color to use for header cells

Optional headerClickAction

headerClickAction?: string | HeaderClickAction

Returns/sets the action to take when a column header is clicked.

Optional headerHeight

headerHeight?: string | number

Gets or sets the height to use for the header row.

Optional headerRowSeparator

headerRowSeparator?: IgrHeaderRowSeparator

Gets or sets the header row seperator settings.

Optional headerRowSeparatorBackground

headerRowSeparatorBackground?: string

Optional headerSeparator

headerSeparator?: IgrHeaderSeparator

Gets or sets the header seperator settings.

Optional headerSeparatorBackground

headerSeparatorBackground?: string

Gets or sets the default background color to use for header separators.

Optional headerSeparatorWidth

headerSeparatorWidth?: string | number

Gets or sets the width of the header separators.

Optional headerSortIndicatorColor

headerSortIndicatorColor?: string

Gets or sets the default text color to use for content cells

Optional headerSortIndicatorStyle

headerSortIndicatorStyle?: string | SortIndicatorStyle

Gets or sets the default render style for sort indicators in header cells.

Optional headerTextColor

headerTextColor?: string

Gets or sets the default text color to use for header cells

Optional headerTextStyle

headerTextStyle?: string

Gets or sets the font to use for header cells

Optional height

height?: string

Optional initialGroups

initialGroups?: string

Optional initialSorts

initialSorts?: string

Optional initialSummaries

initialSummaries?: string

Optional insetBottom

insetBottom?: number

Gets or sets the amount of bottom inset space to use around the grid content.

Optional insetLeft

insetLeft?: number

Gets or sets the amount of left inset space to use around the grid content.

Optional insetRight

insetRight?: number

Gets or sets the amount of right inset space to use around the grid content.

Optional insetTop

insetTop?: number

Gets or sets the amount of top inset space to use around the grid content.

Optional isActiveCellStyleEnabled

isActiveCellStyleEnabled?: string | boolean

Gets or sets whether the active cell style will be applied to cells when made active.

Optional isColumnOptionsEnabled

isColumnOptionsEnabled?: string | boolean

Gets or sets whether to show the column options UI in the headers for columns.

Optional isColumnOptionsGroupingEnabled

isColumnOptionsGroupingEnabled?: string | boolean

Gets or sets whether to show the grouping option in the column options menu.

Optional isColumnOptionsSummariesEnabled

isColumnOptionsSummariesEnabled?: string | boolean

Gets or sets whether to show the summaries option in the column options menu.

Optional isGroupByAreaVisible

isGroupByAreaVisible?: string | boolean

Gets or sets if the Column Grouping Area should be shown and enabled

Optional isGroupCollapsable

isGroupCollapsable?: string | boolean

Gets or sets whether group headers are collapsable.

Optional isGroupExpandedDefault

isGroupExpandedDefault?: string | boolean

Gets or sets whether groups are expanded or collapsed by default.

Optional isGroupRowSticky

isGroupRowSticky?: string | boolean

Gets or sets if group rows will stick to the top of the grid.

Optional isHeaderSeparatorVisible

isHeaderSeparatorVisible?: string | boolean

Gets or sets if header separators are rendered.

Optional isPagerVisible

isPagerVisible?: string | boolean

Gets or sets whether to show the pager or not.

Optional isPlaceholderRenderingEnabled

isPlaceholderRenderingEnabled?: string | boolean

Configures whether or not place holders are used for cells who do not have their data yet.

Optional isRowHoverEnabled

isRowHoverEnabled?: string | boolean

Gets or sets whether the row will highlight when hovered.

Optional isToolbarColumnChooserVisible

isToolbarColumnChooserVisible?: string | boolean

Gets or sets whether to show the column chooser button in the toolbar.

Optional isToolbarColumnPinningVisible

isToolbarColumnPinningVisible?: string | boolean

Gets or sets whether to show the column pinning button in the toolbar.

Optional isToolbarVisible

isToolbarVisible?: string | boolean

Gets or sets whether to show the toolbar.

Optional lastStickyRowBackground

lastStickyRowBackground?: string

Gets or sets the default color to use for the last sticky row

Optional mergedCellEvaluationCriteria

mergedCellEvaluationCriteria?: string | MergedCellEvaluationCriteria

Gets or sets how cells are evaluated for merging.

Optional mergedCellMode

mergedCellMode?: string | MergedCellMode

Gets or sets if and how cell merging is performed for all fields.

Optional mergedCellVerticalAlignment

mergedCellVerticalAlignment?: string | CellContentVerticalAlignment

Gets or sets the vertical alignment to use for the merged cell content.

Optional mouseDragSelectionEnabled

mouseDragSelectionEnabled?: string | boolean

Gets or sets the ability to select rows or cells via mouse dragging. Currently only applies when SelectionMode is MultipleRow or RangeCell.

Optional notifyOnAllSelectionChanges

notifyOnAllSelectionChanges?: string | boolean

Gets or sets if the grid should notify on programmatic selection changes as well as changes from the UI.

Optional pageSize

pageSize?: string | number

Gets or sets the size of each page when the pager is visible.

Optional pinnedAreaSeparator

pinnedAreaSeparator?: IgrPinnedAreaSeparator

Gets or sets the pinned area separator settings.

Optional pinnedAreaSeparatorWidth

pinnedAreaSeparatorWidth?: string | number

Gets or sets the width of the pinned area separators.

Optional pinnedRowBackground

pinnedRowBackground?: string

Gets or sets the default color to use for pinned rows

Optional pinnedRowOpacity

pinnedRowOpacity?: string | number

Gets or sets the default opacity to use for pinned rows

Optional primaryKey

primaryKey?: string[]

Sets or gets the user provided primary key to assume for the data. Certain functionality of the grid requires a way to uniquely identify items in order to work correctly. If a primary key cannot be inferred from the data source, you may need to provide one here.

Optional reactsToFilterChanges

reactsToFilterChanges?: string | boolean

Sets or gets whether the grid will react to filter changes.

Optional reactsToGroupChanges

reactsToGroupChanges?: string | boolean

Sets or gets whether the grid will react to group changes.

Optional reactsToSortChanges

reactsToSortChanges?: string | boolean

Sets or gets whether the grid will react to sort changes.

Optional rootSummariesChanged

rootSummariesChanged?: ((s, e) => void)

Type declaration

    • (s, e): void

    • Parameters

      • s: IgrDataGrid
      • e: IgrDataSourceRootSummariesChangedEventArgs

      Returns void

Optional rowEditEnded

rowEditEnded?: ((s, e) => void)

Type declaration

Optional rowEditStarted

rowEditStarted?: ((s, e) => void)

Type declaration

Optional rowHeight

rowHeight?: string | number

Gets or sets the height to use for the rows in the grid. If not set the grid will use the default value for the set display density.

Optional rowHoverAnimationMode

rowHoverAnimationMode?: string | RowHoverAnimationMode

Sets or gets the row hover animation mode to use.

Optional rowHoverBackground

rowHoverBackground?: string

Gets or sets the background color for rows when hovered.

Optional rowHoverTextColor

rowHoverTextColor?: string

Gets or sets the text color for rows when hovered.

Optional rowSelectionAnimationMode

rowSelectionAnimationMode?: string | RowSelectionAnimationMode

Sets or gets the row selection animation mode to use.

Optional rowSeparator

rowSeparator?: IgrRowSeparator

Gets or sets the row seperator settings.

Optional rowSeparatorBackground

rowSeparatorBackground?: string

Gets or sets the default background color to use for row separators

Optional rowSeparatorHeight

rowSeparatorHeight?: string | number

Sets or gets the height to use for the row separators.

Optional rowSeparatorLastStickyRowBackground

rowSeparatorLastStickyRowBackground?: string

Gets or sets the default last sticky row background color to use for row separators

Optional rowSeparatorPinnedRowBackground

rowSeparatorPinnedRowBackground?: string

Gets or sets the pinned row background color to use for row separators

Optional rowSeparatorStickyRowBackground

rowSeparatorStickyRowBackground?: string

Gets or sets the default sticky row background color to use for row separators

Optional scrollbarBackground

scrollbarBackground?: string

Gets or sets the scrollbar background color.

Optional scrollbarStyle

scrollbarStyle?: string | ScrollbarStyle

Gets or sets the style of scrollbar.

Optional sectionHeader

sectionHeader?: IgrSectionHeader<IIgrSectionHeaderProps>

Gets or sets the header type used for sectioning off groups of rows.

Optional sectionHeaderBackground

sectionHeaderBackground?: string

Gets or sets the default background color to use for section header cells

Optional sectionHeaderSelectedBackground

sectionHeaderSelectedBackground?: string

Gets or sets the default background color to use for section header cells when a row is in a selected state

Optional sectionHeaderTextColor

sectionHeaderTextColor?: string

Gets or sets the default text color to use for section header cells

Optional sectionHeaderTextStyle

sectionHeaderTextStyle?: string

Gets or sets the font to use for section header cells

Optional selectedCellRangesChanged

selectedCellRangesChanged?: ((s, e) => void)

Type declaration

Optional selectedCellsChanged

selectedCellsChanged?: ((s, e) => void)

Type declaration

Optional selectedItemsChanged

selectedItemsChanged?: ((s, e) => void)

Type declaration

Optional selectedKeysChanged

selectedKeysChanged?: ((s, e) => void)

Type declaration

Optional selectionBehavior

selectionBehavior?: string | GridSelectionBehavior

Sets or gets how selection behaves in the grid.

Optional selectionChanged

selectionChanged?: ((s, e) => void)

Type declaration

Optional selectionMode

selectionMode?: string | DataGridSelectionMode

Sets or gets the grid selection mode.

Optional shiftSectionContent

shiftSectionContent?: string | boolean

Gets or sets if the section header content should be shifted into the normal column scrollable area when there are pinned columns

Optional sizeChanged

sizeChanged?: ((s, e) => void)

Type declaration

Optional sortDescriptionsChanged

sortDescriptionsChanged?: ((s, e) => void)

Type declaration

Optional stickyRowBackground

stickyRowBackground?: string

Gets or sets the default color to use for sticky rows

Optional summaryDescriptionsChanged

summaryDescriptionsChanged?: ((s, e) => void)

Type declaration

Optional summaryRootBackground

summaryRootBackground?: string

Gets or sets the default background color to use for summary cells at the root level.

Optional summaryRootLabelTextColor

summaryRootLabelTextColor?: string

Gets or sets the default text color to use for summary labels in summary cells at the root level.

Optional summaryRootLabelTextStyle

summaryRootLabelTextStyle?: string

Gets or sets the font to use for summary labels at the root level.

Optional summaryRootSelectedBackground

summaryRootSelectedBackground?: string

Gets or sets the default background color to use for summary cells at the root level.

Optional summaryRootValueTextColor

summaryRootValueTextColor?: string

Gets or sets the default text color to use for summary cells at the root level.

Optional summaryRootValueTextStyle

summaryRootValueTextStyle?: string

Gets or sets the font to use for summary values at the root level.

Optional summaryRowRoot

summaryRowRoot?: IgrSummaryRowRoot<IIgrSummaryRowRootProps>

Gets or sets the cell definition used for summary rows at the root level.

Optional summaryRowSection

summaryRowSection?: IgrSummaryRowSection<IIgrSummaryRowSectionProps>

Gets or sets the cell definition used for summary rows at the section level.

Optional summaryScope

summaryScope?: string | SummaryScope

Gets or sets the scope which summaries are calculated for.

Optional summarySectionBackground

summarySectionBackground?: string

Gets or sets the default background color to use for summary cells at the section level.

Optional summarySectionLabelTextColor

summarySectionLabelTextColor?: string

Gets or sets the default text color to use for summary labels in summary cells at the section level.

Optional summarySectionLabelTextStyle

summarySectionLabelTextStyle?: string

Gets or sets the font to use for summary labels at the section level.

Optional summarySectionSelectedBackground

summarySectionSelectedBackground?: string

Gets or sets the default background color to use for summary cells at the section level.

Optional summarySectionValueTextColor

summarySectionValueTextColor?: string

Gets or sets the default text color to use for summary cells at the section level.

Optional summarySectionValueTextStyle

summarySectionValueTextStyle?: string

Gets or sets the font to use for summary values at the section level.

Optional todayOverride

todayOverride?: Date

Optional toolbarColumnChooserText

toolbarColumnChooserText?: string

Gets or sets the column chooser button text to use in the toolbar.

Optional toolbarColumnChooserTitle

toolbarColumnChooserTitle?: string

Gets or sets the column chooser title text to use in the toolbar.

Optional toolbarColumnPinningText

toolbarColumnPinningText?: string

Gets or sets the column pinning button text to use in the toolbar.

Optional toolbarColumnPinningTitle

toolbarColumnPinningTitle?: string

Gets or sets the column pinning title text to use in the toolbar.

Optional toolbarTitle

toolbarTitle?: string

Gets or sets the title text to use in the toolbar.

Optional useAccessibility

useAccessibility?: string | boolean

Optional useCanvas

useCanvas?: string | boolean

Optional width

width?: string