Ignite UI for React

All
  • Public
  • Public/Protected
  • All

Class IgrNumericColumn<SS>

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

Type parameters

  • SS

Hierarchy

Constructors

Accessors

Methods

Constructors

constructor

Accessors

activationBorder

  • get activationBorder(): string
  • set activationBorder(v: string): void

  • Gets or sets the background color to use.

    Returns string

  • Gets or sets the background color to use.

    Parameters

    • v: string

    Returns void

activationBorderBottomWidth

  • get activationBorderBottomWidth(): number
  • set activationBorderBottomWidth(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

activationBorderLeftWidth

  • get activationBorderLeftWidth(): number
  • set activationBorderLeftWidth(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

activationBorderRightWidth

  • get activationBorderRightWidth(): number
  • set activationBorderRightWidth(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

activationBorderTopWidth

  • get activationBorderTopWidth(): number
  • set activationBorderTopWidth(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

actualActivationBorder

  • get actualActivationBorder(): string
  • set actualActivationBorder(v: string): void

actualBackground

  • get actualBackground(): string
  • set actualBackground(v: string): void

  • Gets the actual background color that will be used.

    Returns string

  • Gets the actual background color that will be used.

    Parameters

    • v: string

    Returns void

actualBorder

  • get actualBorder(): string
  • set actualBorder(v: string): void

  • Gets the actual border color that will be used.

    Returns string

  • Gets the actual border color that will be used.

    Parameters

    • v: string

    Returns void

actualColumnOptionsIconAlignment

actualColumnOptionsIconBehavior

actualColumnOptionsIconColor

  • get actualColumnOptionsIconColor(): string
  • set actualColumnOptionsIconColor(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

actualHeaderText

  • get actualHeaderText(): string
  • set actualHeaderText(v: string): void

  • Gets the actual text displayed in the header of the column

    Returns string

  • Gets the actual text displayed in the header of the column

    Parameters

    • v: string

    Returns void

actualIsColumnOptionsEnabled

  • get actualIsColumnOptionsEnabled(): boolean
  • set actualIsColumnOptionsEnabled(v: boolean): void

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

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

actualLastStickyRowBackground

  • get actualLastStickyRowBackground(): string
  • set actualLastStickyRowBackground(v: string): void

actualLineBreakMode

actualPinnedRowBackground

  • get actualPinnedRowBackground(): string
  • set actualPinnedRowBackground(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

actualPinnedRowOpacity

  • get actualPinnedRowOpacity(): number
  • set actualPinnedRowOpacity(v: number): void

actualSelectedBackground

  • get actualSelectedBackground(): string
  • set actualSelectedBackground(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

actualStickyRowBackground

  • get actualStickyRowBackground(): string
  • set actualStickyRowBackground(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

actualTextColor

  • get actualTextColor(): string
  • set actualTextColor(v: string): void

  • Gets the actual color used for displaying text.

    Returns string

  • Gets the actual color used for displaying text.

    Parameters

    • v: string

    Returns void

animationSettings

background

  • get background(): string
  • set background(v: string): void

  • Gets or sets the background color to use.

    Returns string

  • Gets or sets the background color to use.

    Parameters

    • v: string

    Returns void

border

  • get border(): string
  • set border(v: string): void

  • Gets or sets the background color to use.

    Returns string

  • Gets or sets the background color to use.

    Parameters

    • v: string

    Returns void

borderBottomWidth

  • get borderBottomWidth(): number
  • set borderBottomWidth(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

borderLeftWidth

  • get borderLeftWidth(): number
  • set borderLeftWidth(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

borderRightWidth

  • get borderRightWidth(): number
  • set borderRightWidth(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

borderTopWidth

  • get borderTopWidth(): number
  • set borderTopWidth(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

cellStyleKeyRequested

  • get cellStyleKeyRequested(): function
  • set cellStyleKeyRequested(ev: function): void

columnOptionsIconAlignment

columnOptionsIconBehavior

columnOptionsIconColor

  • get columnOptionsIconColor(): string
  • set columnOptionsIconColor(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

contentOpacity

  • get contentOpacity(): number
  • set contentOpacity(v: number): void

  • Gets or sets the opacity of the content.

    Returns number

  • Gets or sets the opacity of the content.

    Parameters

    • v: number

    Returns void

dataBinding

  • get dataBinding(): function
  • set dataBinding(ev: function): void

dataBound

  • get dataBound(): function
  • set dataBound(ev: function): void

filter

  • get filter(): ColumnFilterCondition
  • set filter(v: ColumnFilterCondition): void

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

    Returns ColumnFilterCondition

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

    Parameters

    • v: ColumnFilterCondition

    Returns void

formatOverride

  • get formatOverride(): any
  • set formatOverride(v: any): void

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

    Returns any

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

    Parameters

    • v: any

    Returns void

header

  • Gets or sets the header definition for this column.

    Returns IgrHeader

  • Gets or sets the header definition for this column.

    Parameters

    Returns void

headerText

  • get headerText(): string
  • set headerText(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

horizontalAlignment

isAutoGenerated

  • get isAutoGenerated(): boolean
  • set isAutoGenerated(v: boolean): void

  • Gets whether this column was auto generated.

    Returns boolean

  • Gets whether this column was auto generated.

    Parameters

    • v: boolean

    Returns void

isColumnOptionsEnabled

  • get isColumnOptionsEnabled(): boolean
  • set isColumnOptionsEnabled(v: boolean): void

  • 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

  • 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.

    Parameters

    • v: boolean

    Returns void

isFilteringEnabled

  • get isFilteringEnabled(): boolean
  • set isFilteringEnabled(v: boolean): void

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

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

isFromMarkup

  • get isFromMarkup(): boolean
  • set isFromMarkup(v: boolean): void

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

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

isHidden

  • get isHidden(): boolean
  • set isHidden(v: boolean): void

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

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

isResizingEnabled

  • get isResizingEnabled(): boolean
  • set isResizingEnabled(v: boolean): void

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

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

lastStickyRowBackground

  • get lastStickyRowBackground(): string
  • set lastStickyRowBackground(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

lineBreakMode

maxFractionDigits

  • get maxFractionDigits(): number
  • set maxFractionDigits(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

minFractionDigits

  • get minFractionDigits(): number
  • set minFractionDigits(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

minIntegerDigits

  • get minIntegerDigits(): number
  • set minIntegerDigits(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

minWidth

  • get minWidth(): number
  • set minWidth(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

name

  • get name(): string
  • set name(v: string): void

  • Gets or sets an unique name of the Column

    Returns string

  • Gets or sets an unique name of the Column

    Parameters

    • v: string

    Returns void

negativePrefix

  • get negativePrefix(): string
  • set negativePrefix(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

negativeSuffix

  • get negativeSuffix(): string
  • set negativeSuffix(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

paddingBottom

  • get paddingBottom(): number
  • set paddingBottom(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

paddingLeft

  • get paddingLeft(): number
  • set paddingLeft(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

paddingRight

  • get paddingRight(): number
  • set paddingRight(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

paddingTop

  • get paddingTop(): number
  • set paddingTop(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

pinned

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

    Returns PinnedPositions

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

    Parameters

    Returns void

pinnedRowBackground

  • get pinnedRowBackground(): string
  • set pinnedRowBackground(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

pinnedRowOpacity

  • get pinnedRowOpacity(): number
  • set pinnedRowOpacity(v: number): void

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

    Returns number

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

    Parameters

    • v: number

    Returns void

positivePrefix

  • get positivePrefix(): string
  • set positivePrefix(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

positiveSuffix

  • get positiveSuffix(): string
  • set positiveSuffix(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

propertyPath

  • get propertyPath(): string
  • set propertyPath(v: string): void

  • Gets or sets the key used for the column binding

    Returns string

  • Gets or sets the key used for the column binding

    Parameters

    • v: string

    Returns void

selectedBackground

  • get selectedBackground(): string
  • set selectedBackground(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

shouldRemoveWhenHidden

  • get shouldRemoveWhenHidden(): boolean
  • set shouldRemoveWhenHidden(v: boolean): void

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

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

showGroupingSeparator

  • get showGroupingSeparator(): boolean
  • set showGroupingSeparator(v: boolean): void

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

    Returns boolean

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

    Parameters

    • v: boolean

    Returns void

sortDirection

stickyRowBackground

  • get stickyRowBackground(): string
  • set stickyRowBackground(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

textColor

  • get textColor(): string
  • set textColor(v: string): void

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

    Returns string

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

    Parameters

    • v: string

    Returns void

textStyle

  • get textStyle(): string
  • set textStyle(v: string): void

verticalAlignment

width

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

    Returns IgrColumnWidth

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

    Parameters

    Returns void

Methods

Optional UNSAFE_componentWillMount

  • UNSAFE_componentWillMount(): void

Optional UNSAFE_componentWillReceiveProps

Optional UNSAFE_componentWillUpdate

  • UNSAFE_componentWillUpdate(nextProps: Readonly<IIgrNumericColumnProps>, nextState: Readonly<__type>, nextContext: any): void

Optional componentDidCatch

  • componentDidCatch(error: Error, errorInfo: ErrorInfo): void

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

    Parameters

    • error: Error
    • errorInfo: ErrorInfo

    Returns void

componentDidMount

  • componentDidMount(): void

Optional componentDidUpdate

  • componentDidUpdate(prevProps: Readonly<IIgrNumericColumnProps>, prevState: Readonly<__type>, snapshot?: SS): 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

    Returns void

Optional componentWillMount

  • componentWillMount(): void

Optional componentWillReceiveProps

Optional componentWillUnmount

  • componentWillUnmount(): 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

Optional componentWillUpdate

  • componentWillUpdate(nextProps: Readonly<IIgrNumericColumnProps>, nextState: Readonly<__type>, nextContext: any): void

getNamedHeaderValue

  • getNamedHeaderValue(valueName: string): any

  • 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

  • getNamedValue(valueName: string): any

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

    Parameters

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

    Returns any

Optional getSnapshotBeforeUpdate

  • getSnapshotBeforeUpdate(prevProps: Readonly<IIgrNumericColumnProps>, prevState: Readonly<__type>): SS | null

  • 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 SS | null

getUniqueKey

  • getUniqueKey(): string

  • Get the unique key used to identify this column.

    Returns string

hasNamedHeaderValue

  • hasNamedHeaderValue(valueName: string): boolean

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

    Parameters

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

    Returns boolean

hasNamedHeaderValues

  • hasNamedHeaderValues(): boolean

  • Returns if the column has named header values.

    Returns boolean

hasNamedValue

  • hasNamedValue(valueName: string): 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

hasNamedValues

  • hasNamedValues(): boolean

  • Returns if this definition has named value.

    Returns boolean

removeNamedHeaderValue

  • removeNamedHeaderValue(valueName: string): void

  • 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

  • removeNamedValue(valueName: string): void

  • Removes the named value from this definition by name.

    Parameters

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

    Returns void

render

  • render(): any

setNamedHeaderValue

setNamedValue

shouldComponentUpdate

  • shouldComponentUpdate(nextProps: any, nextState: any): boolean

  • Parameters

    • nextProps: any
    • nextState: any

    Returns boolean

Static _createFromInternal