Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Interface IIgrDataGridColumnProps

Hierarchy

Hierarchy

Properties

Properties

Optional activationBorder

activationBorder?: string

Gets or sets the background color to use.

Optional activationBorderBottomWidth

activationBorderBottomWidth?: string | number

Gets or sets the amount of bottom activation border to use for the cell content of this column.

Optional activationBorderLeftWidth

activationBorderLeftWidth?: string | number

Gets or sets the amount of left activation border to use for the cell content for this column.

Optional activationBorderRightWidth

activationBorderRightWidth?: string | number

Gets or sets the amount of right activation border to use for the cell content of this column.

Optional activationBorderTopWidth

activationBorderTopWidth?: string | number

Gets or sets the amount of top activation border to use for the cell content for this column.

Optional actualActivationBorder

actualActivationBorder?: string

Gets the actual background color that will be used.

Optional actualBackground

actualBackground?: string

Gets the actual background color that will be used.

Optional actualBorder

actualBorder?: string

Gets the actual border color that will be used.

Optional actualColumnOptionsIconAlignment

actualColumnOptionsIconAlignment?: string | ColumnOptionsIconAlignment

Gets the actual column options icon alignment for this column.

Optional actualColumnOptionsIconBehavior

actualColumnOptionsIconBehavior?: string | ColumnOptionsIconBehavior

Gets or sets how the column option icon will behave in the column header.

Optional actualColumnOptionsIconColor

actualColumnOptionsIconColor?: string

Gets the actual column options icon color for this column.

Optional actualDeletedTextColor

actualDeletedTextColor?: string

Gets the actual text color used for deleted rows.

Optional actualEditFontInfo

actualEditFontInfo?: string

Gets the actual font style used for unsaved cell edits.

Optional actualEditOpacity

actualEditOpacity?: string | number

Gets the actual opacity for unsaved edited cell values.

Optional actualErrorBorder

actualErrorBorder?: string

Gets the actual error border color that will be used.

Optional actualHeaderText

actualHeaderText?: string

Gets the actual text displayed in the header of the column

Optional actualHoverBackground

actualHoverBackground?: string

Gets the actual background color that is used for the cells when they are hovered.

Optional actualIsColumnOptionsEnabled

actualIsColumnOptionsEnabled?: string | boolean

Gets the actual state of the column options for this column.

Optional actualIsColumnOptionsGroupingEnabled

actualIsColumnOptionsGroupingEnabled?: string | boolean

Gets the actual state of grouping menu in the column options for this column.

Optional actualIsColumnOptionsSummariesEnabled

actualIsColumnOptionsSummariesEnabled?: string | boolean

Gets the actual state of summaries menu in the column options for this column.

Optional actualLastStickyRowBackground

actualLastStickyRowBackground?: string

Gets the actual color for the last row in the sticky row area.

Optional actualLineBreakMode

actualLineBreakMode?: string | TextCellLineBreakMode

Gets the actual line break mode which will be used if text is present in the cell.

Optional actualPinnedRowBackground

actualPinnedRowBackground?: string

Gets the actual background color for cells belonging to rows marked as pinned.

Optional actualPinnedRowOpacity

actualPinnedRowOpacity?: string | number

Gets or sets the color to use for displaying text.

Optional actualRowHoverTextColor

actualRowHoverTextColor?: string

Gets the actual text color that is used for the cells when they are hovered.

Optional actualSelectedBackground

actualSelectedBackground?: string

Gets the actual background color that is used for the cells when they are selected

Optional actualStickyRowBackground

actualStickyRowBackground?: string

Gets the actual background color for content that sticks to the top of the grid.

Optional actualTextColor

actualTextColor?: string

Gets the actual color used for displaying text.

Optional animationSettings

animationSettings?: IgrGridColumnAnimationSettings

Gets or sets the animation settings to use for this column.

Optional background

background?: string

Gets or sets the background color to use.

Optional border

border?: string

Gets or sets the background color to use.

Optional borderBottomWidth

borderBottomWidth?: string | number

Gets or sets the amount of bottom border to use for the cell content of this column.

Optional borderLeftWidth

borderLeftWidth?: string | number

Gets or sets the amount of left border to use for the cell content for this column.

Optional borderRightWidth

borderRightWidth?: string | number

Gets or sets the amount of right border to use for the cell content of this column.

Optional borderTopWidth

borderTopWidth?: string | number

Gets or sets the amount of top border to use for the cell content for this column.

Optional cellStyleKeyRequested

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

Type declaration

Optional children

children?: ReactNode

Optional columnOptionsIconAlignment

columnOptionsIconAlignment?: string | ColumnOptionsIconAlignment

Gets or sets whether the column options icon is aligned opposite the header text or not.

Optional columnOptionsIconBehavior

columnOptionsIconBehavior?: string | ColumnOptionsIconBehavior

Gets or sets how the column option icon will behave in the column header.

Optional columnOptionsIconColor

columnOptionsIconColor?: string

Gets or sets the column options icon color for this column.

Optional contentOpacity

contentOpacity?: string | number

Gets or sets the opacity of the content.

Optional dataBinding

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

Type declaration

Optional dataBound

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

Type declaration

Optional deletedTextColor

deletedTextColor?: string

Gets or sets the text color used for deleted rows.

Optional editOpacity

editOpacity?: string | number

Gets or sets the opacity to use for unsaved edited cell values.

Optional errorBorder

errorBorder?: string

Gets or sets the error border color to use.

Optional errorBorderBottomWidth

errorBorderBottomWidth?: string | number

Optional errorBorderLeftWidth

errorBorderLeftWidth?: string | number

Optional errorBorderRightWidth

errorBorderRightWidth?: string | number

Optional errorBorderTopWidth

errorBorderTopWidth?: string | number

Optional field

field?: string

Gets or sets the key used for the column binding

Optional filter

filter?: ColumnFilterCondition

Gets or sets a filter to apply on the values of this column

Optional filterComparisonType

filterComparisonType?: string | FilterComparisonType

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

Optional filterExpression

filterExpression?: IFilterExpression

Gets or sets a filter to apply to the values of this column.

Optional header

header?: IgrHeader<IIgrHeaderProps>

Gets or sets the header definition for this column.

Optional headerText

headerText?: string

Gets or sets the text displayed in the header of the column

Optional horizontalAlignment

horizontalAlignment?: string | CellContentHorizontalAlignment

Gets or sets the horizontal alignment to use for the cell content.

Optional isAutoGenerated

isAutoGenerated?: string | boolean

Gets whether this column was auto generated.

Optional isColumnOptionsEnabled

isColumnOptionsEnabled?: string | boolean

Gets or sets the preferred state of the column options for this column. If the feature is disabled at the grid level then it will be disabled for the column regardless of what this is set to.

Optional isColumnOptionsGroupingEnabled

isColumnOptionsGroupingEnabled?: string | boolean

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

Optional isColumnOptionsSummariesEnabled

isColumnOptionsSummariesEnabled?: string | boolean

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

Optional isEditable

isEditable?: string | boolean

Gets or sets if the column is editable.

Optional isFilteringEnabled

isFilteringEnabled?: string | boolean

Gets or sets whether filtering is enabled for this column.

Optional isFromMarkup

isFromMarkup?: string | boolean

Gets whether this column was projected from markup/templates and is constrained.

Optional isHidden

isHidden?: string | boolean

Gets or sets whether or not a column is hidden from the grid

Optional isResizingEnabled

isResizingEnabled?: string | boolean

Gets or sets whether resizing is enabled for this column.

Optional lastStickyRowBackground

lastStickyRowBackground?: string

Gets or sets the color for the last row in the sticky row area.

Optional lineBreakMode

lineBreakMode?: string | TextCellLineBreakMode

Gets or sets the line breaking mode to use if text is present in the cell.

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 this field.

Optional mergedCellPaddingBottom

mergedCellPaddingBottom?: string | number

Gets or sets the amount of bottom padding to use for the cell content of this column.

Optional mergedCellPaddingLeft

mergedCellPaddingLeft?: string | number

Gets or sets the amount of left padding to use for the cell content for this column.

Optional mergedCellPaddingRight

mergedCellPaddingRight?: string | number

Gets or sets the amount of right padding to use for the cell content of this column.

Optional mergedCellPaddingTop

mergedCellPaddingTop?: string | number

Gets or sets the amount of top padding to use for the cell content for this column.

Optional mergedCellVerticalAlignment

mergedCellVerticalAlignment?: string | CellContentVerticalAlignment

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

Optional minWidth

minWidth?: string | number

Gets or sets the minimum width to use for this column. Overrides the DefaultColumnMinWidth from the grid, if set.

Optional name

name?: string

Gets or sets an unique name of the Column

Optional paddingBottom

paddingBottom?: string | number

Gets or sets the amount of bottom padding to use for the cell content of this column.

Optional paddingLeft

paddingLeft?: string | number

Gets or sets the amount of left padding to use for the cell content for this column.

Optional paddingRight

paddingRight?: string | number

Gets or sets the amount of right padding to use for the cell content of this column.

Optional paddingTop

paddingTop?: string | number

Gets or sets the amount of top padding to use for the cell content for this column.

Optional pinned

pinned?: string | PinnedPositions

Gets or sets the current fixed position for this column.

Optional pinnedRowBackground

pinnedRowBackground?: string

Gets or sets the background color for cells belonging to rows marked as pinned.

Optional pinnedRowOpacity

pinnedRowOpacity?: string | number

Gets or sets the color to use for displaying text.

Optional rowHoverBackground

rowHoverBackground?: string

Gets or sets the background color to use for the cells when the row is hovered.

Optional rowHoverTextColor

rowHoverTextColor?: string

Gets or sets the text color to use for the cells when the row is hovered.

Optional selectedBackground

selectedBackground?: string

Gets or sets the background color to use for the cells when they are selected

Optional shouldRemoveWhenHidden

shouldRemoveWhenHidden?: string | boolean

Gets or sets if a column should be removed from the grid when it is fully hidden

Optional sortDirection

sortDirection?: string | ColumnSortDirection

Gets the current sort direction (None, Ascending, Descending) for this column.

Optional stickyRowBackground

stickyRowBackground?: string

Gets or sets the background color for content that sticks to the top of the grid.

Optional textColor

textColor?: string

Gets or sets the color to use for displaying text.

Optional textEditStyle

textEditStyle?: string

Gets or sets the font style to use for unsaved cell edits.

Optional textStyle

textStyle?: string

Optional verticalAlignment

verticalAlignment?: string | CellContentVerticalAlignment

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

Optional width

width?: string | IgrColumnWidth

Gets or sets the width to use for this column.