Base class for various definition types for the grid.

Hierarchy

Hierarchy

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<IIgrColumnMovingSeparatorProps> & 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 actualErrorBorder(): string
  • Gets the actual error border color that will be used.

    Returns string

  • set actualErrorBorder(v): void
  • Parameters

    • v: string

    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 actualOpacity(): number
  • Returns number

  • set actualOpacity(v): void
  • Parameters

    • v: number

    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 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 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 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 horizontalAlignment(): CellContentHorizontalAlignment
  • Gets or sets the horizontal alignment to use for the cell content.

    Returns CellContentHorizontalAlignment

  • set horizontalAlignment(v): void
  • Parameters

    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 nativeElement(): HTMLElement
  • Returns HTMLElement

  • get opacity(): number
  • Returns number

  • set opacity(v): void
  • Parameters

    • v: number

    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 separatorWidth(): number
  • Gets or sets the separator width for this column.

    Returns number

  • set separatorWidth(v): void
  • Parameters

    • v: number

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

Methods

  • 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

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

    Returns any

  • 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 the named value from this definition by name.

    Parameters

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

    Returns void

  • Returns any

  • 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