Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Class IgrNumericColumn

Represents a Numeric grid column, used to allow the developer to display a formatted number in a cell.

Hierarchy

Hierarchy

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

context

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>

See

https://reactjs.org/docs/context.html

Readonly props

props: Readonly<IIgrNumericColumnProps> & Readonly<{
    children?: ReactNode;
}>

refs

refs: {
    [key: string]: ReactInstance;
}

Deprecated

https://reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs

Type declaration

  • [key: string]: ReactInstance

state

state: Readonly<{}>

Static Optional contextType

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}</>;
  }
}

See

https://reactjs.org/docs/context.html#classcontexttype

Accessors

activationBorder

  • get activationBorder(): string

  • Gets or sets the background color to use.

    Returns string

  • set activationBorder(v): void

  • Parameters

    • v: string

    Returns void

activationBorderBottomWidth

  • 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

activationBorderLeftWidth

  • 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

activationBorderRightWidth

  • 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

activationBorderTopWidth

  • 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

actualActivationBorder

  • get actualActivationBorder(): string

  • Gets the actual background color that will be used.

    Returns string

  • set actualActivationBorder(v): void

  • Parameters

    • v: string

    Returns void

actualBackground

  • get actualBackground(): string

  • Gets the actual background color that will be used.

    Returns string

  • set actualBackground(v): void

  • Parameters

    • v: string

    Returns void

actualBorder

  • get actualBorder(): string

  • Gets the actual border color that will be used.

    Returns string

  • set actualBorder(v): void

  • Parameters

    • v: string

    Returns void

actualColumnOptionsIconAlignment

  • get actualColumnOptionsIconAlignment(): ColumnOptionsIconAlignment

  • Gets the actual column options icon alignment for this column.

    Returns ColumnOptionsIconAlignment

  • set actualColumnOptionsIconAlignment(v): void

  • Parameters

    Returns void

actualColumnOptionsIconBehavior

  • 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

actualColumnOptionsIconColor

  • get actualColumnOptionsIconColor(): string

  • Gets the actual column options icon color for this column.

    Returns string

  • set actualColumnOptionsIconColor(v): void

  • Parameters

    • v: string

    Returns void

actualDeletedTextColor

  • get actualDeletedTextColor(): string

  • Gets the actual text color used for deleted rows.

    Returns string

  • set actualDeletedTextColor(v): void

  • Parameters

    • v: string

    Returns void

actualEditFontInfo

  • get actualEditFontInfo(): string

  • Gets the actual font style used for unsaved cell edits.

    Returns string

  • set actualEditFontInfo(v): void

  • Parameters

    • v: string

    Returns void

actualEditOpacity

  • get actualEditOpacity(): number

  • Gets the actual opacity for unsaved edited cell values.

    Returns number

  • set actualEditOpacity(v): void

  • Parameters

    • v: number

    Returns void

actualErrorBorder

  • get actualErrorBorder(): string

  • Gets the actual error border color that will be used.

    Returns string

  • set actualErrorBorder(v): void

  • Parameters

    • v: string

    Returns void

actualHeaderText

  • 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

actualHeaderTextChange

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

  • Returns ((s, e) => void)

  • set actualHeaderTextChange(ev): void

  • Parameters

    Returns void

actualHoverBackground

  • 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

actualIsColumnOptionsEnabled

  • 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

actualIsColumnOptionsGroupingEnabled

  • 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

actualIsColumnOptionsSummariesEnabled

  • 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

actualLastStickyRowBackground

  • 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

actualLineBreakMode

  • 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

actualPinnedRowBackground

  • 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

actualPinnedRowOpacity

  • get actualPinnedRowOpacity(): number

  • Gets or sets the color to use for displaying text.

    Returns number

  • set actualPinnedRowOpacity(v): void

  • Parameters

    • v: number

    Returns void

actualRowHoverTextColor

  • 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

actualSelectedBackground

  • 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

actualStickyRowBackground

  • 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

actualTextColor

  • get actualTextColor(): string

  • Gets the actual color used for displaying text.

    Returns string

  • set actualTextColor(v): void

  • Parameters

    • v: string

    Returns void

animationSettings

  • get animationSettings(): IgrGridColumnAnimationSettings

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

    Returns IgrGridColumnAnimationSettings

  • set animationSettings(v): void

  • Parameters

    Returns void

background

  • get background(): string

  • Gets or sets the background color to use.

    Returns string

  • set background(v): void

  • Parameters

    • v: string

    Returns void

border

  • get border(): string

  • Gets or sets the background color to use.

    Returns string

  • set border(v): void

  • Parameters

    • v: string

    Returns void

borderBottomWidth

  • 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

borderLeftWidth

  • 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

borderRightWidth

  • 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

borderTopWidth

  • 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

cellStyleKeyRequested

  • 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

columnOptionsIconAlignment

  • 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

columnOptionsIconBehavior

  • 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

columnOptionsIconColor

  • 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

contentOpacity

  • get contentOpacity(): number

  • Gets or sets the opacity of the content.

    Returns number

  • set contentOpacity(v): void

  • Parameters

    • v: number

    Returns void

dataBinding

  • get dataBinding(): ((s, e) => void)

  • Called when a cell is data binding.

    Returns ((s, e) => void)

  • set dataBinding(ev): void

  • Parameters

    Returns void

dataBound

  • get dataBound(): ((s, e) => void)

  • Called when a cell has been data bound.

    Returns ((s, e) => void)

  • set dataBound(ev): void

  • Parameters

    Returns void

deletedTextColor

  • get deletedTextColor(): string

  • Gets or sets the text color used for deleted rows.

    Returns string

  • set deletedTextColor(v): void

  • Parameters

    • v: string

    Returns void

editOpacity

  • 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

editorDataSource

  • get editorDataSource(): any

  • Gets or sets the ComboBox data source.

    Returns any

  • set editorDataSource(v): void

  • Parameters

    • v: any

    Returns void

editorTextField

  • get editorTextField(): string

  • Gets or sets the ComboBox text field.

    Returns string

  • set editorTextField(v): void

  • Parameters

    • v: string

    Returns void

editorType

  • get editorType(): EditorType

  • Gets or sets the editor type used for editing cells in this column.

    Returns EditorType

  • set editorType(v): void

  • Parameters

    Returns void

editorValueField

  • get editorValueField(): string

  • Gets or sets the ComboBox value field.

    Returns string

  • set editorValueField(v): void

  • Parameters

    • v: string

    Returns void

errorBorder

  • get errorBorder(): string

  • Gets or sets the error border color to use.

    Returns string

  • set errorBorder(v): void

  • Parameters

    • v: string

    Returns void

errorBorderBottomWidth

  • get errorBorderBottomWidth(): number

  • Returns number

  • set errorBorderBottomWidth(v): void

  • Parameters

    • v: number

    Returns void

errorBorderLeftWidth

  • get errorBorderLeftWidth(): number

  • Returns number

  • set errorBorderLeftWidth(v): void

  • Parameters

    • v: number

    Returns void

errorBorderRightWidth

  • get errorBorderRightWidth(): number

  • Returns number

  • set errorBorderRightWidth(v): void

  • Parameters

    • v: number

    Returns void

errorBorderTopWidth

  • get errorBorderTopWidth(): number

  • Returns number

  • set errorBorderTopWidth(v): void

  • Parameters

    • v: number

    Returns void

field

  • get field(): string

  • Gets or sets the key used for the column binding

    Returns string

  • set field(v): void

  • Parameters

    • v: string

    Returns void

filter

  • 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

filterComparisonType

  • get filterComparisonType(): FilterComparisonType

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

    Returns FilterComparisonType

  • set filterComparisonType(v): void

  • Parameters

    Returns void

filterExpression

  • 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

filterOperands

  • get filterOperands(): IgrGridFilterOperandsCollection

  • Gets a list of the current custom filters for this column.

    Returns IgrGridFilterOperandsCollection

  • set filterOperands(v): void

  • Parameters

    Returns void

formatOverride

  • get formatOverride(): any

  • Gets or sets the INTL NumericFormat object to use for formatting the date values.

    Returns any

  • set formatOverride(v): void

  • Parameters

    • v: any

    Returns void

formatSpecifiers

  • get formatSpecifiers(): any[]

  • Returns any[]

  • set formatSpecifiers(v): void

  • Parameters

    • v: any[]

    Returns void

formatString

  • get formatString(): string

  • Gets or sets the format string to apply to the value. If set, the other value formatting properties on this column are ignored.

    Returns string

  • set formatString(v): void

  • Parameters

    • v: string

    Returns void

header

  • get header(): IgrHeader<IIgrHeaderProps>

  • Gets or sets the header definition for this column.

    Returns IgrHeader<IIgrHeaderProps>

  • set header(v): void

  • Parameters

    Returns void

headerText

  • 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

horizontalAlignment

  • get horizontalAlignment(): CellContentHorizontalAlignment

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

    Returns CellContentHorizontalAlignment

  • set horizontalAlignment(v): void

  • Parameters

    Returns void

isAutoGenerated

  • get isAutoGenerated(): boolean

  • Gets whether this column was auto generated.

    Returns boolean

  • set isAutoGenerated(v): void

  • Parameters

    • v: boolean

    Returns void

isColumnOptionsEnabled

  • 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

isColumnOptionsGroupingEnabled

  • 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

isColumnOptionsSummariesEnabled

  • 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

isEditable

  • get isEditable(): boolean

  • Gets or sets if the column is editable.

    Returns boolean

  • set isEditable(v): void

  • Parameters

    • v: boolean

    Returns void

isFilteringEnabled

  • get isFilteringEnabled(): boolean

  • Gets or sets whether filtering is enabled for this column.

    Returns boolean

  • set isFilteringEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

isFromMarkup

  • 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

isHidden

  • 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

isResizingEnabled

  • get isResizingEnabled(): boolean

  • Gets or sets whether resizing is enabled for this column.

    Returns boolean

  • set isResizingEnabled(v): void

  • Parameters

    • v: boolean

    Returns void

lastStickyRowBackground

  • 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

lineBreakMode

  • 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

maxFractionDigits

  • get maxFractionDigits(): number

  • Gets or sets the maximum fraction digits. If FormatString is specificied this value is ignored.

    Returns number

  • set maxFractionDigits(v): void

  • Parameters

    • v: number

    Returns void

mergedCellEvaluationCriteria

  • get mergedCellEvaluationCriteria(): MergedCellEvaluationCriteria

  • Gets or sets how cells are evaluated for merging.

    Returns MergedCellEvaluationCriteria

  • set mergedCellEvaluationCriteria(v): void

  • Parameters

    Returns void

mergedCellMode

  • 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

mergedCellPaddingBottom

  • 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

mergedCellPaddingLeft

  • 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

mergedCellPaddingRight

  • 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

mergedCellPaddingTop

  • 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

mergedCellVerticalAlignment

  • get mergedCellVerticalAlignment(): CellContentVerticalAlignment

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

    Returns CellContentVerticalAlignment

  • set mergedCellVerticalAlignment(v): void

  • Parameters

    Returns void

minFractionDigits

  • get minFractionDigits(): number

  • Gets or sets the minimum fraction digits. If FormatString is specificied this value is ignored.

    Returns number

  • set minFractionDigits(v): void

  • Parameters

    • v: number

    Returns void

minIntegerDigits

  • get minIntegerDigits(): number

  • Gets or sets the minimum integer digits. If FormatString is specificied this value is ignored.

    Returns number

  • set minIntegerDigits(v): void

  • Parameters

    • v: number

    Returns void

minWidth

  • 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

name

  • get name(): string

  • Gets or sets an unique name of the Column

    Returns string

  • set name(v): void

  • Parameters

    • v: string

    Returns void

negativePrefix

  • get negativePrefix(): string

  • Gets or sets the string to prefix a negative value. If FormatString is specificied this value is ignored.

    Returns string

  • set negativePrefix(v): void

  • Parameters

    • v: string

    Returns void

negativeSuffix

  • get negativeSuffix(): string

  • Gets or sets the string to suffix a negative value. If FormatString is specificied this value is ignored.

    Returns string

  • set negativeSuffix(v): void

  • Parameters

    • v: string

    Returns void

paddingBottom

  • 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

paddingLeft

  • 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

paddingRight

  • 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

paddingTop

  • 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

pinned

  • get pinned(): PinnedPositions

  • Gets or sets the current fixed position for this column.

    Returns PinnedPositions

  • set pinned(v): void

  • Parameters

    Returns void

pinnedRowBackground

  • 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

pinnedRowOpacity

  • get pinnedRowOpacity(): number

  • Gets or sets the color to use for displaying text.

    Returns number

  • set pinnedRowOpacity(v): void

  • Parameters

    • v: number

    Returns void

positivePrefix

  • get positivePrefix(): string

  • Gets or sets the string to prefix a positive value. If FormatString is specificied this value is ignored.

    Returns string

  • set positivePrefix(v): void

  • Parameters

    • v: string

    Returns void

positiveSuffix

  • get positiveSuffix(): string

  • Gets or sets the string to suffix a positive value. If FormatString is specificied this value is ignored.

    Returns string

  • set positiveSuffix(v): void

  • Parameters

    • v: string

    Returns void

rowHoverBackground

  • 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

rowHoverTextColor

  • 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

selectedBackground

  • 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

shouldRemoveWhenHidden

  • 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

showGroupingSeparator

  • get showGroupingSeparator(): boolean

  • Gets or sets whether to show a grouping separator. If FormatString is specificied this value is ignored.

    Returns boolean

  • set showGroupingSeparator(v): void

  • Parameters

    • v: boolean

    Returns void

sortDirection

  • get sortDirection(): ColumnSortDirection

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

    Returns ColumnSortDirection

  • set sortDirection(v): void

  • Parameters

    Returns void

stickyRowBackground

  • 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

textColor

  • get textColor(): string

  • Gets or sets the color to use for displaying text.

    Returns string

  • set textColor(v): void

  • Parameters

    • v: string

    Returns void

textEditStyle

  • 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

textStyle

  • get textStyle(): string

  • Returns string

  • set textStyle(v): void

  • Parameters

    • v: string

    Returns void

verticalAlignment

  • get verticalAlignment(): CellContentVerticalAlignment

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

    Returns CellContentVerticalAlignment

  • set verticalAlignment(v): void

  • Parameters

    Returns void

width

  • get width(): IgrColumnWidth

  • Gets or sets the width to use for this column.

    Returns IgrColumnWidth

  • set width(v): void

  • Parameters

    Returns void

Methods

Optional UNSAFE_componentWillMount

Optional UNSAFE_componentWillReceiveProps

Optional UNSAFE_componentWillUpdate

applyCustomFilter

  • Parameters

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

    Returns void

Optional componentDidCatch

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

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

Optional componentDidUpdate

  • 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

    Returns void

Optional componentWillMount

Optional componentWillReceiveProps

Optional componentWillUnmount

  • 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

Optional componentWillUpdate

findByName

  • Parameters

    • name: string

    Returns any

forceUpdate

  • Parameters

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

        • Returns void

    Returns void

getNamedHeaderValue

  • 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

getNamedValue

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

    Parameters

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

    Returns any

Optional getSnapshotBeforeUpdate

  • 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

    Returns any

getUniqueKey

  • Get the unique key used to identify this column.

    Returns string

hasNamedHeaderValue

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

    Parameters

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

    Returns boolean

hasNamedHeaderValues

  • Returns if the column has named header values.

    Returns boolean

hasNamedValue

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

    Parameters

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

    Returns boolean

hasNamedValues

  • Returns if this definition has named value.

    Returns boolean

removeNamedHeaderValue

  • 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

removeNamedValue

  • Removes the named value from this definition by name.

    Parameters

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

    Returns void

render

  • Returns any

setNamedHeaderValue

setNamedValue

setState

  • Type parameters

    Type Parameters

    • K extends never

    Parameters

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

        • Returns void

    Returns void

shouldComponentUpdate

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

Static _createFromInternal