Hierarchy

Hierarchy

  • IIgrDataGridProps

Properties

Properties

activationMode?: string | GridActivationMode

Sets or gets the grid selection mode.

activeCell?: IgrGridCellPosition

Gets or sets the position of the active cell.

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

Type declaration

actualBorderWidth?: Thickness

Gets the actual border width.

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

Type declaration

actualCornerRadiusBottomLeft?: string | number
actualCornerRadiusBottomRight?: string | number
actualCornerRadiusTopLeft?: string | number
actualCornerRadiusTopRight?: string | number
actualHeaderHeight?: string | number

Gets the height used for the header row.

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.

actualRowHeight?: string | number

Gets the actual height for the rows in the grid.

allowCopyOperation?: string | boolean
animationSettings?: IgrGridAnimationSettings

Sets or gets the default animation settings for the grid.

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.

autoGenerateColumns?: string | boolean

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

autoGenerateDesiredProperties?: string[]

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

border?: string

Gets or sets the border color around the grid.

borderWidthBottom?: string | number
borderWidthLeft?: string | number
borderWidthRight?: string | number
borderWidthTop?: string | number
cellBackground?: string

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

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

Type declaration

cellDataLoadedAnimationMode?: string | CellDataLoadedAnimationMode

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

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

Type declaration

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

Type declaration

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

Type declaration

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

Type declaration

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

Type declaration

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

Type declaration

cellSelectedBackground?: string

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

cellSelectionAnimationMode?: string | CellSelectionAnimationMode

Sets or gets the cell selection animation mode to use.

cellTextColor?: string

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

cellTextStyle?: string

Gets or sets the font to use for content cells

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

Type declaration

children?: ReactNode
clearSelectionOnEscape?: string | boolean

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

columnAddingAnimationMode?: string | ColumnShowingAnimationMode

Sets or gets the Column Adding Animation mode to use.

columnExchangingAnimationMode?: string | ColumnExchangingAnimationMode

Sets or gets the column exchanging animation mode to use.

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

Type declaration

columnHidingAnimationMode?: string | ColumnHidingAnimationMode

Sets or gets the column hiding animation mode to use.

columnMovingAnimationMode?: string | ColumnMovingAnimationMode

Sets or gets the column moving animation mode to use.

columnMovingMode?: string | ColumnMovingMode

Gets or sets the type column moving to use.

columnMovingSeparator?: IgrColumnMovingSeparator

Gets or sets the column resizing seperator settings.

columnMovingSeparatorBackground?: string

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

columnMovingSeparatorOpacity?: string | number

Gets or sets the opacity of the column moving separator.

columnMovingSeparatorWidth?: string | number

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

columnOptionsIconAlignment?: string | ColumnOptionsIconAlignment

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

columnOptionsIconBehavior?: string | ColumnOptionsIconBehavior

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

columnOptionsIconColor?: string

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

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

Type declaration

columnPropertyUpdatingAnimationMode?: string | ColumnPropertyUpdatingAnimationMode

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

columnResizingAnimationMode?: string | ColumnResizingAnimationMode

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

columnResizingMode?: string | ColumnResizingMode

Gets or sets the type of column resizing to use.

columnResizingSeparator?: IgrColumnResizingSeparator

Gets or sets the column resizing seperator settings.

columnResizingSeparatorBackground?: string

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

columnResizingSeparatorOpacity?: string | number

Gets or sets the opacity of the column Resizing separator.

columnResizingSeparatorWidth?: string | number

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

columnShowingAnimationMode?: string | ColumnShowingAnimationMode

Sets or gets the column showing animation mode to use.

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

Type declaration

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

Type declaration

cornerRadiusBottomLeft?: string | number
cornerRadiusBottomRight?: string | number
cornerRadiusTopLeft?: string | number
cornerRadiusTopRight?: string | number
customFilterRequested?: ((s, e) => void)

Type declaration

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

Type declaration

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

Type declaration

dataSource?: any

Gets or sets the data for the grid to use.

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.

defaultColumnMinWidth?: string | number

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

defaultColumnWidth?: string | IgrColumnWidth

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

deferEventForRowDragSelection?: string | boolean

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

deletedTextColor?: string

Gets or sets the text color for unsaved deleted rows.

density?: string | ControlDisplayDensity

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

editMode?: string | EditModeType

Gets or sets the type of edit mode

editModeClickAction?: string | EditModeClickAction

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

editOnKeyPress?: string | boolean

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

editOpacity?: string | number

Gets or sets the default opacity for unsaved cell edits.

editRowBorder?: string

Gets or sets the border color for rows being edited.

editRowBorderWidthBottom?: string | number
editRowBorderWidthLeft?: string | number
editRowBorderWidthRight?: string | number
editRowBorderWidthTop?: string | number
editTextStyle?: string

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

enterBehavior?: string | EnterKeyBehaviors

Gets or sets the behavior of the Enter key.

enterBehaviorAfterEdit?: string | EnterKeyBehaviorAfterEdit

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

filterComparisonType?: string | FilterComparisonType

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

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

Type declaration

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

Type declaration

filterLogicalOperator?: string | FilterLogicalOperator

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

filterUIType?: string | FilterUIType

Gets or sets which filter UI type to use.

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

Type declaration

groupHeaderDisplayMode?: string | GroupHeaderDisplayMode

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

groupSummaryDisplayMode?: string | GroupSummaryDisplayMode

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

headerBackground?: string

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

headerClickAction?: string | HeaderClickAction

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

headerHeight?: string | number

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

headerRowSeparator?: IgrHeaderRowSeparator

Gets or sets the header row seperator settings.

headerRowSeparatorBackground?: string
headerSeparator?: IgrHeaderSeparator

Gets or sets the header seperator settings.

headerSeparatorBackground?: string

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

headerSeparatorWidth?: string | number

Gets or sets the width of the header separators.

headerSortIndicatorColor?: string

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

headerSortIndicatorStyle?: string | SortIndicatorStyle

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

headerTextColor?: string

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

headerTextStyle?: string

Gets or sets the font to use for header cells

height?: string
initialGroups?: string
initialSorts?: string
initialSummaries?: string
insetBottom?: number

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

insetLeft?: number

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

insetRight?: number

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

insetTop?: number

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

isActiveCellStyleEnabled?: string | boolean

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

isColumnOptionsEnabled?: string | boolean

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

isColumnOptionsGroupingEnabled?: string | boolean

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

isColumnOptionsSummariesEnabled?: string | boolean

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

isGroupByAreaVisible?: string | boolean

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

isGroupCollapsable?: string | boolean

Gets or sets whether group headers are collapsable.

isGroupExpandedDefault?: string | boolean

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

isGroupRowSticky?: string | boolean

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

isHeaderSeparatorVisible?: string | boolean

Gets or sets if header separators are rendered.

isPagerVisible?: string | boolean

Gets or sets whether to show the pager or not.

isPlaceholderRenderingEnabled?: string | boolean

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

isRowHoverEnabled?: string | boolean

Gets or sets whether the row will highlight when hovered.

isToolbarColumnChooserVisible?: string | boolean

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

isToolbarColumnPinningVisible?: string | boolean

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

isToolbarVisible?: string | boolean

Gets or sets whether to show the toolbar.

lastStickyRowBackground?: string

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

mergedCellEvaluationCriteria?: string | MergedCellEvaluationCriteria

Gets or sets how cells are evaluated for merging.

mergedCellMode?: string | MergedCellMode

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

mergedCellVerticalAlignment?: string | CellContentVerticalAlignment

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

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.

notifyOnAllSelectionChanges?: string | boolean

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

pageSize?: string | number

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

pinnedAreaSeparator?: IgrPinnedAreaSeparator

Gets or sets the pinned area separator settings.

pinnedAreaSeparatorWidth?: string | number

Gets or sets the width of the pinned area separators.

pinnedRowBackground?: string

Gets or sets the default color to use for pinned rows

pinnedRowOpacity?: string | number

Gets or sets the default opacity to use for pinned rows

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.

reactsToFilterChanges?: string | boolean

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

reactsToGroupChanges?: string | boolean

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

reactsToSortChanges?: string | boolean

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

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

Type declaration

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

Type declaration

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.

rowHoverAnimationMode?: string | RowHoverAnimationMode

Sets or gets the row hover animation mode to use.

rowHoverBackground?: string

Gets or sets the background color for rows when hovered.

rowHoverTextColor?: string

Gets or sets the text color for rows when hovered.

rowSelectionAnimationMode?: string | RowSelectionAnimationMode

Sets or gets the row selection animation mode to use.

rowSeparator?: IgrRowSeparator

Gets or sets the row seperator settings.

rowSeparatorBackground?: string

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

rowSeparatorHeight?: string | number

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

rowSeparatorLastStickyRowBackground?: string

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

rowSeparatorPinnedRowBackground?: string

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

rowSeparatorStickyRowBackground?: string

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

scrollbarBackground?: string

Gets or sets the scrollbar background color.

scrollbarStyle?: string | ScrollbarStyle

Gets or sets the style of scrollbar.

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

sectionHeaderBackground?: string

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

sectionHeaderSelectedBackground?: string

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

sectionHeaderTextColor?: string

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

sectionHeaderTextStyle?: string

Gets or sets the font to use for section header cells

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

Type declaration

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

Type declaration

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

Type declaration

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

Type declaration

selectionBehavior?: string | GridSelectionBehavior

Sets or gets how selection behaves in the grid.

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

Type declaration

selectionMode?: string | DataGridSelectionMode

Sets or gets the grid selection mode.

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

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

Type declaration

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

Type declaration

stickyRowBackground?: string

Gets or sets the default color to use for sticky rows

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

Type declaration

summaryRootBackground?: string

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

summaryRootLabelTextColor?: string

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

summaryRootLabelTextStyle?: string

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

summaryRootSelectedBackground?: string

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

summaryRootValueTextColor?: string

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

summaryRootValueTextStyle?: string

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

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

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

summaryScope?: string | SummaryScope

Gets or sets the scope which summaries are calculated for.

summarySectionBackground?: string

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

summarySectionLabelTextColor?: string

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

summarySectionLabelTextStyle?: string

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

summarySectionSelectedBackground?: string

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

summarySectionValueTextColor?: string

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

summarySectionValueTextStyle?: string

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

todayOverride?: Date
toolbarColumnChooserText?: string

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

toolbarColumnChooserTitle?: string

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

toolbarColumnPinningText?: string

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

toolbarColumnPinningTitle?: string

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

toolbarTitle?: string

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

useAccessibility?: string | boolean
useCanvas?: string | boolean
width?: string