A column in the data grid.

Type Parameters

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

Properties

context: any

If using the new style context, re-declare this in your class to be the React.ContextType of your static contextType. Should be used with type annotation or static contextType.

static contextType = MyContext
// For TS pre-3.7:
context!: React.ContextType<typeof MyContext>
// For TS 3.7 and above:
declare context: React.ContextType<typeof MyContext>
props: Readonly<P> & Readonly<{
    children?: ReactNode;
}>
refs: {
    [key: string]: ReactInstance;
}

Type declaration

  • [key: string]: ReactInstance
state: Readonly<{}>
contextType?: Context<any>

If set, this.context will be set at runtime to the current value of the given Context.

Usage:

type MyContext = number
const Ctx = React.createContext<MyContext>(0)

class Foo extends React.Component {
static contextType = Ctx
context!: React.ContextType<typeof Ctx>
render () {
return <>My context's value: {this.context}</>;
}
}

Accessors

  • get activationBorder(): string
  • Gets or sets the background color to use.

    Returns string

  • set activationBorder(v): void
  • Parameters

    • v: string

    Returns void

  • get activationBorderBottomWidth(): number
  • Gets or sets the amount of bottom activation border to use for the cell content of this column.

    Returns number

  • set activationBorderBottomWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get activationBorderLeftWidth(): number
  • Gets or sets the amount of left activation border to use for the cell content for this column.

    Returns number

  • set activationBorderLeftWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get activationBorderRightWidth(): number
  • Gets or sets the amount of right activation border to use for the cell content of this column.

    Returns number

  • set activationBorderRightWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get activationBorderTopWidth(): number
  • Gets or sets the amount of top activation border to use for the cell content for this column.

    Returns number

  • set activationBorderTopWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get actualActivationBorder(): string
  • Gets the actual background color that will be used.

    Returns string

  • set actualActivationBorder(v): void
  • Parameters

    • v: string

    Returns void

  • get actualBackground(): string
  • Gets the actual background color that will be used.

    Returns string

  • set actualBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get actualBorder(): string
  • Gets the actual border color that will be used.

    Returns string

  • set actualBorder(v): void
  • Parameters

    • v: string

    Returns void

  • get actualColumnOptionsIconAlignment(): ColumnOptionsIconAlignment
  • Gets the actual column options icon alignment for this column.

    Returns ColumnOptionsIconAlignment

  • set actualColumnOptionsIconAlignment(v): void
  • Parameters

    Returns void

  • get actualColumnOptionsIconBehavior(): ColumnOptionsIconBehavior
  • Gets or sets how the column option icon will behave in the column header.

    Returns ColumnOptionsIconBehavior

  • set actualColumnOptionsIconBehavior(v): void
  • Parameters

    Returns void

  • get actualColumnOptionsIconColor(): string
  • Gets the actual column options icon color for this column.

    Returns string

  • set actualColumnOptionsIconColor(v): void
  • Parameters

    • v: string

    Returns void

  • get actualDeletedTextColor(): string
  • Gets the actual text color used for deleted rows.

    Returns string

  • set actualDeletedTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get actualEditFontInfo(): string
  • Gets the actual font style used for unsaved cell edits.

    Returns string

  • set actualEditFontInfo(v): void
  • Parameters

    • v: string

    Returns void

  • get actualEditOpacity(): number
  • Gets the actual opacity for unsaved edited cell values.

    Returns number

  • set actualEditOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get actualErrorBorder(): string
  • Gets the actual error border color that will be used.

    Returns string

  • set actualErrorBorder(v): void
  • Parameters

    • v: string

    Returns void

  • get actualHeaderText(): string
  • Gets the actual text displayed in the header of the column

    Returns string

  • set actualHeaderText(v): void
  • Parameters

    • v: string

    Returns void

  • get actualHeaderTextChange(): ((s, e) => void)
  • Returns ((s, e) => void)

  • set actualHeaderTextChange(ev): void
  • Parameters

    Returns void

  • get actualHoverBackground(): string
  • Gets the actual background color that is used for the cells when they are hovered.

    Returns string

  • set actualHoverBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get actualIsColumnOptionsEnabled(): boolean
  • Gets the actual state of the column options for this column.

    Returns boolean

  • set actualIsColumnOptionsEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get actualIsColumnOptionsGroupingEnabled(): boolean
  • Gets the actual state of grouping menu in the column options for this column.

    Returns boolean

  • set actualIsColumnOptionsGroupingEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get actualIsColumnOptionsSummariesEnabled(): boolean
  • Gets the actual state of summaries menu in the column options for this column.

    Returns boolean

  • set actualIsColumnOptionsSummariesEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get actualLastStickyRowBackground(): string
  • Gets the actual color for the last row in the sticky row area.

    Returns string

  • set actualLastStickyRowBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get actualLineBreakMode(): TextCellLineBreakMode
  • Gets the actual line break mode which will be used if text is present in the cell.

    Returns TextCellLineBreakMode

  • set actualLineBreakMode(v): void
  • Parameters

    Returns void

  • get actualPinnedRowBackground(): string
  • Gets the actual background color for cells belonging to rows marked as pinned.

    Returns string

  • set actualPinnedRowBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get actualPinnedRowOpacity(): number
  • Gets or sets the color to use for displaying text.

    Returns number

  • set actualPinnedRowOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get actualRowHoverTextColor(): string
  • Gets the actual text color that is used for the cells when they are hovered.

    Returns string

  • set actualRowHoverTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get actualSelectedBackground(): string
  • Gets the actual background color that is used for the cells when they are selected

    Returns string

  • set actualSelectedBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get actualStickyRowBackground(): string
  • Gets the actual background color for content that sticks to the top of the grid.

    Returns string

  • set actualStickyRowBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get actualTextColor(): string
  • Gets the actual color used for displaying text.

    Returns string

  • set actualTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get background(): string
  • Gets or sets the background color to use.

    Returns string

  • set background(v): void
  • Parameters

    • v: string

    Returns void

  • get border(): string
  • Gets or sets the background color to use.

    Returns string

  • set border(v): void
  • Parameters

    • v: string

    Returns void

  • get borderBottomWidth(): number
  • Gets or sets the amount of bottom border to use for the cell content of this column.

    Returns number

  • set borderBottomWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get borderLeftWidth(): number
  • Gets or sets the amount of left border to use for the cell content for this column.

    Returns number

  • set borderLeftWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get borderRightWidth(): number
  • Gets or sets the amount of right border to use for the cell content of this column.

    Returns number

  • set borderRightWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get borderTopWidth(): number
  • Gets or sets the amount of top border to use for the cell content for this column.

    Returns number

  • set borderTopWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get cellStyleKeyRequested(): ((s, e) => void)
  • Called when the style key for a cell is needed. Used for recycling the cell.

    Returns ((s, e) => void)

  • set cellStyleKeyRequested(ev): void
  • Parameters

    Returns void

  • get columnOptionsIconAlignment(): ColumnOptionsIconAlignment
  • Gets or sets whether the column options icon is aligned opposite the header text or not.

    Returns ColumnOptionsIconAlignment

  • set columnOptionsIconAlignment(v): void
  • Parameters

    Returns void

  • get columnOptionsIconBehavior(): ColumnOptionsIconBehavior
  • Gets or sets how the column option icon will behave in the column header.

    Returns ColumnOptionsIconBehavior

  • set columnOptionsIconBehavior(v): void
  • Parameters

    Returns void

  • get columnOptionsIconColor(): string
  • Gets or sets the column options icon color for this column.

    Returns string

  • set columnOptionsIconColor(v): void
  • Parameters

    • v: string

    Returns void

  • get contentOpacity(): number
  • Gets or sets the opacity of the content.

    Returns number

  • set contentOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get dataBinding(): ((s, e) => void)
  • Called when a cell is data binding.

    Returns ((s, e) => void)

  • set dataBinding(ev): void
  • Parameters

    Returns void

  • get dataBound(): ((s, e) => void)
  • Called when a cell has been data bound.

    Returns ((s, e) => void)

  • set dataBound(ev): void
  • Parameters

    Returns void

  • get deletedTextColor(): string
  • Gets or sets the text color used for deleted rows.

    Returns string

  • set deletedTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get editOpacity(): number
  • Gets or sets the opacity to use for unsaved edited cell values.

    Returns number

  • set editOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get errorBorder(): string
  • Gets or sets the error border color to use.

    Returns string

  • set errorBorder(v): void
  • Parameters

    • v: string

    Returns void

  • get errorBorderBottomWidth(): number
  • Returns number

  • set errorBorderBottomWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get errorBorderLeftWidth(): number
  • Returns number

  • set errorBorderLeftWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get errorBorderRightWidth(): number
  • Returns number

  • set errorBorderRightWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get errorBorderTopWidth(): number
  • Returns number

  • set errorBorderTopWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get field(): string
  • Gets or sets the key used for the column binding

    Returns string

  • set field(v): void
  • Parameters

    • v: string

    Returns void

  • get filter(): ColumnFilterCondition
  • Gets or sets a filter to apply on the values of this column

    Returns ColumnFilterCondition

  • set filter(v): void
  • Parameters

    • v: ColumnFilterCondition

    Returns void

  • get filterComparisonType(): FilterComparisonType
  • Gets or sets whether UI filters are case sensitive or not.

    Returns FilterComparisonType

  • set filterComparisonType(v): void
  • Parameters

    Returns void

  • get filterExpression(): IFilterExpression
  • Gets or sets a filter to apply to the values of this column.

    Returns IFilterExpression

  • set filterExpression(v): void
  • Parameters

    • v: IFilterExpression

    Returns void

  • get headerText(): string
  • Gets or sets the text displayed in the header of the column

    Returns string

  • set headerText(v): void
  • Parameters

    • v: string

    Returns void

  • get horizontalAlignment(): CellContentHorizontalAlignment
  • Gets or sets the horizontal alignment to use for the cell content.

    Returns CellContentHorizontalAlignment

  • set horizontalAlignment(v): void
  • Parameters

    Returns void

  • get isAutoGenerated(): boolean
  • Gets whether this column was auto generated.

    Returns boolean

  • set isAutoGenerated(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isColumnOptionsEnabled(): 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.

    Returns boolean

  • set isColumnOptionsEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isColumnOptionsGroupingEnabled(): boolean
  • Gets or sets whether to show the grouping option in the column options menu for this column.

    Returns boolean

  • set isColumnOptionsGroupingEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isColumnOptionsSummariesEnabled(): boolean
  • Gets or sets whether to show the summaries option in the column options menu for this column.

    Returns boolean

  • set isColumnOptionsSummariesEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isEditable(): boolean
  • Gets or sets if the column is editable.

    Returns boolean

  • set isEditable(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isFilteringEnabled(): boolean
  • Gets or sets whether filtering is enabled for this column.

    Returns boolean

  • set isFilteringEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isFromMarkup(): boolean
  • Gets whether this column was projected from markup/templates and is constrained.

    Returns boolean

  • set isFromMarkup(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isHidden(): boolean
  • Gets or sets whether or not a column is hidden from the grid

    Returns boolean

  • set isHidden(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isResizingEnabled(): boolean
  • Gets or sets whether resizing is enabled for this column.

    Returns boolean

  • set isResizingEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get lastStickyRowBackground(): string
  • Gets or sets the color for the last row in the sticky row area.

    Returns string

  • set lastStickyRowBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get lineBreakMode(): TextCellLineBreakMode
  • Gets or sets the line breaking mode to use if text is present in the cell.

    Returns TextCellLineBreakMode

  • set lineBreakMode(v): void
  • Parameters

    Returns void

  • get mergedCellMode(): MergedCellMode
  • Gets or sets if and how cell merging is performed for this field.

    Returns MergedCellMode

  • set mergedCellMode(v): void
  • Parameters

    Returns void

  • get mergedCellPaddingBottom(): number
  • Gets or sets the amount of bottom padding to use for the cell content of this column.

    Returns number

  • set mergedCellPaddingBottom(v): void
  • Parameters

    • v: number

    Returns void

  • get mergedCellPaddingLeft(): number
  • Gets or sets the amount of left padding to use for the cell content for this column.

    Returns number

  • set mergedCellPaddingLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get mergedCellPaddingRight(): number
  • Gets or sets the amount of right padding to use for the cell content of this column.

    Returns number

  • set mergedCellPaddingRight(v): void
  • Parameters

    • v: number

    Returns void

  • get mergedCellPaddingTop(): number
  • Gets or sets the amount of top padding to use for the cell content for this column.

    Returns number

  • set mergedCellPaddingTop(v): void
  • Parameters

    • v: number

    Returns void

  • get minWidth(): number
  • Gets or sets the minimum width to use for this column. Overrides the DefaultColumnMinWidth from the grid, if set.

    Returns number

  • set minWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get name(): string
  • Gets or sets an unique name of the Column

    Returns string

  • set name(v): void
  • Parameters

    • v: string

    Returns void

  • get nativeElement(): HTMLElement
  • Returns HTMLElement

  • get paddingBottom(): number
  • Gets or sets the amount of bottom padding to use for the cell content of this column.

    Returns number

  • set paddingBottom(v): void
  • Parameters

    • v: number

    Returns void

  • get paddingLeft(): number
  • Gets or sets the amount of left padding to use for the cell content for this column.

    Returns number

  • set paddingLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get paddingRight(): number
  • Gets or sets the amount of right padding to use for the cell content of this column.

    Returns number

  • set paddingRight(v): void
  • Parameters

    • v: number

    Returns void

  • get paddingTop(): number
  • Gets or sets the amount of top padding to use for the cell content for this column.

    Returns number

  • set paddingTop(v): void
  • Parameters

    • v: number

    Returns void

  • get pinned(): PinnedPositions
  • Gets or sets the current fixed position for this column.

    Returns PinnedPositions

  • set pinned(v): void
  • Parameters

    Returns void

  • get pinnedRowBackground(): string
  • Gets or sets the background color for cells belonging to rows marked as pinned.

    Returns string

  • set pinnedRowBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get pinnedRowOpacity(): number
  • Gets or sets the color to use for displaying text.

    Returns number

  • set pinnedRowOpacity(v): void
  • Parameters

    • v: number

    Returns void

  • get rowHoverBackground(): string
  • Gets or sets the background color to use for the cells when the row is hovered.

    Returns string

  • set rowHoverBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get rowHoverTextColor(): string
  • Gets or sets the text color to use for the cells when the row is hovered.

    Returns string

  • set rowHoverTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get selectedBackground(): string
  • Gets or sets the background color to use for the cells when they are selected

    Returns string

  • set selectedBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get shouldRemoveWhenHidden(): boolean
  • Gets or sets if a column should be removed from the grid when it is fully hidden

    Returns boolean

  • set shouldRemoveWhenHidden(v): void
  • Parameters

    • v: boolean

    Returns void

  • get sortDirection(): ColumnSortDirection
  • Gets the current sort direction (None, Ascending, Descending) for this column.

    Returns ColumnSortDirection

  • set sortDirection(v): void
  • Parameters

    Returns void

  • get stickyRowBackground(): string
  • Gets or sets the background color for content that sticks to the top of the grid.

    Returns string

  • set stickyRowBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get textColor(): string
  • Gets or sets the color to use for displaying text.

    Returns string

  • set textColor(v): void
  • Parameters

    • v: string

    Returns void

  • get textEditStyle(): string
  • Gets or sets the font style to use for unsaved cell edits.

    Returns string

  • set textEditStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get textStyle(): string
  • Returns string

  • set textStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get verticalAlignment(): CellContentVerticalAlignment
  • Gets or sets the vertical alignment to use for the cell content.

    Returns CellContentVerticalAlignment

  • set verticalAlignment(v): void
  • Parameters

    Returns void

  • get width(): IgrColumnWidth
  • Gets or sets the width to use for this column.

    Returns IgrColumnWidth

  • set width(v): void
  • Parameters

    Returns void

Methods

  • Parameters

    • filterID: string
    • index: number
    • value: any

    Returns void

  • Catches exceptions generated in descendant components. Unhandled exceptions will cause the entire component tree to unmount.

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

  • Called immediately after updating occurs. Not called for the initial render.

    The snapshot is only present if getSnapshotBeforeUpdate is present and returns non-null.

    Parameters

    • prevProps: Readonly<P>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    Returns void

  • Called immediately before a component is destroyed. Perform any necessary cleanup in this method, such as cancelled network requests, or cleaning up any DOM elements created in componentDidMount.

    Returns void

  • Parameters

    • name: string

    Returns any

  • Parameters

    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Gets the value of a named header value for this column by name.

    Parameters

    • valueName: string
      • Name of the named header value to retrieve.

    Returns any

  • Gets the value for a named value from this definition.

    Parameters

    • valueName: string
      • The named value name to check for.

    Returns any

  • Runs before React applies the result of render to the document, and returns an object to be given to componentDidUpdate. Useful for saving things such as scroll position before render causes changes to it.

    Note: the presence of getSnapshotBeforeUpdate prevents any of the deprecated lifecycle events from running.

    Parameters

    • prevProps: Readonly<P>
    • prevState: Readonly<{}>

    Returns any

  • Get the unique key used to identify this column.

    Returns string

  • Returns if there is a named header value with a given name.

    Parameters

    • valueName: string
      • The named value to check for.

    Returns boolean

  • Returns if the column has named header values.

    Returns boolean

  • Returns if this definition has a named value with a given name.

    Parameters

    • valueName: string
      • The named value name to check for.

    Returns boolean

  • Returns if this definition has named value.

    Returns boolean

  • Removes a named header value with the given name from the named header values for this column.

    Parameters

    • valueName: string
      • The named header value to remove.

    Returns void

  • Removes the named value from this definition by name.

    Parameters

    • valueName: string
      • The named value name to remove.

    Returns void

  • Returns any

  • Parameters

    Returns void

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

    • state: {} | ((prevState, props) => {} | Pick<{}, K>) | Pick<{}, K>
    • Optional callback: (() => void)
        • (): void
        • Returns void

    Returns void

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean