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<IIgrGridColumnOptionsProps> & 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 actualBaseTheme(): BaseControlTheme
  • Gets the actual display baseTheme to use for the component.

    Returns BaseControlTheme

  • set actualBaseTheme(v): void
  • Parameters

    • v: BaseControlTheme

    Returns void

  • get actualButtonDensity(): ControlDisplayDensity
  • Gets the actual display buttonDensity to use for the component.

    Returns ControlDisplayDensity

  • set actualButtonDensity(v): void
  • Parameters

    • v: ControlDisplayDensity

    Returns void

  • get actualDensity(): ControlDisplayDensity
  • Gets the actual display density to use for the component.

    Returns ControlDisplayDensity

  • set actualDensity(v): void
  • Parameters

    • v: ControlDisplayDensity

    Returns void

  • get actualFilterListDensity(): ControlDisplayDensity
  • Gets the actual display filterListDensity to use for the component.

    Returns ControlDisplayDensity

  • set actualFilterListDensity(v): void
  • Parameters

    • v: ControlDisplayDensity

    Returns void

  • get actualSummaryListDensity(): ControlDisplayDensity
  • Gets the actual display density used for the summary list menu.

    Returns ControlDisplayDensity

  • set actualSummaryListDensity(v): void
  • Parameters

    • v: ControlDisplayDensity

    Returns void

  • get applyFiltersButtonCaption(): string
  • Returns string

  • set applyFiltersButtonCaption(v): void
  • Parameters

    • v: string

    Returns void

  • get autoSize(): boolean
  • Gets or sets the autoSize for which this AutoSizeOptions will apply.

    Returns boolean

  • set autoSize(v): void
  • Parameters

    • v: boolean

    Returns void

  • get backgroundColor(): string
  • Gets or sets the color to use for the background of the component.

    Returns string

  • set backgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get baseTheme(): BaseControlTheme
  • Gets or sets the base built in theme to use for the component.

    Returns BaseControlTheme

  • set baseTheme(v): void
  • Parameters

    • v: BaseControlTheme

    Returns void

  • get buttonDensity(): ControlDisplayDensity
  • Gets or sets the display Density to use for the buttons in the component.

    Returns ControlDisplayDensity

  • set buttonDensity(v): void
  • Parameters

    • v: ControlDisplayDensity

    Returns void

  • get buttonTextStyle(): string
  • Gets or sets the font to use for buttons.

    Returns string

  • set buttonTextStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get cancelFiltersButtonCaption(): string
  • Returns string

  • set cancelFiltersButtonCaption(v): void
  • Parameters

    • v: string

    Returns void

  • get clearColumnFiltersCaption(): string
  • Returns string

  • set clearColumnFiltersCaption(v): void
  • Parameters

    • v: string

    Returns void

  • get columnNameTextStyle(): string
  • Gets or sets the font to use for columnNames.

    Returns string

  • set columnNameTextStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get density(): ControlDisplayDensity
  • Gets or sets the display density to use for the component.

    Returns ControlDisplayDensity

  • set density(v): void
  • Parameters

    • v: ControlDisplayDensity

    Returns void

  • get filterListDensity(): ControlDisplayDensity
  • Gets or sets the display Density to use for the buttons in the component.

    Returns ControlDisplayDensity

  • set filterListDensity(v): void
  • Parameters

    • v: ControlDisplayDensity

    Returns void

  • get filterListPlaceholderText(): string
  • Returns string

  • set filterListPlaceholderText(v): void
  • Parameters

    • v: string

    Returns void

  • get filterOptionsVisible(): boolean
  • Returns boolean

  • set filterOptionsVisible(v): void
  • Parameters

    • v: boolean

    Returns void

  • get filterOptionsVisibleResolved(): boolean
  • Returns boolean

  • get groupOptionsVisible(): boolean
  • Returns boolean

  • set groupOptionsVisible(v): void
  • Parameters

    • v: boolean

    Returns void

  • get groupOptionsVisibleResolved(): boolean
  • Returns boolean

  • get headerOptionsVisibleResolved(): boolean
  • Returns boolean

  • get headerVisible(): boolean
  • Returns boolean

  • set headerVisible(v): void
  • Parameters

    • v: boolean

    Returns void

  • get height(): string
  • Returns string

  • set height(value): void
  • Parameters

    • value: string

    Returns void

  • get hideOptionsVisible(): boolean
  • Returns boolean

  • set hideOptionsVisible(v): void
  • Parameters

    • v: boolean

    Returns void

  • get hideOptionsVisibleResolved(): boolean
  • Returns boolean

  • get i(): GridColumnOptions
  • Returns GridColumnOptions

  • get labelTextStyle(): string
  • Gets or sets the font to use for labels.

    Returns string

  • set labelTextStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get moveHeaderCaption(): string
  • Returns string

  • set moveHeaderCaption(v): void
  • Parameters

    • v: string

    Returns void

  • get moveLeftCaption(): string
  • Returns string

  • set moveLeftCaption(v): void
  • Parameters

    • v: string

    Returns void

  • get moveOptionsVisible(): boolean
  • Returns boolean

  • set moveOptionsVisible(v): void
  • Parameters

    • v: boolean

    Returns void

  • get moveOptionsVisibleResolved(): boolean
  • Returns boolean

  • get moveRightCaption(): string
  • Returns string

  • set moveRightCaption(v): void
  • Parameters

    • v: string

    Returns void

  • get nativeElement(): HTMLElement
  • Returns HTMLElement

  • get paddingBottom(): number
  • Gets or sets the amount of left padding to use for the bottom edge of the component.

    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 left edge of the component.

    Returns number

  • set paddingLeft(v): void
  • Parameters

    • v: number

    Returns void

  • get paddingRight(): number
  • Gets or sets the amount of left padding to use for the right edge of the component.

    Returns number

  • set paddingRight(v): void
  • Parameters

    • v: number

    Returns void

  • get paddingTop(): number
  • Gets or sets the amount of left padding to use for the top edge of the component.

    Returns number

  • set paddingTop(v): void
  • Parameters

    • v: number

    Returns void

  • get pinHeaderCaption(): string
  • Returns string

  • set pinHeaderCaption(v): void
  • Parameters

    • v: string

    Returns void

  • get pinLeftCaption(): string
  • Returns string

  • set pinLeftCaption(v): void
  • Parameters

    • v: string

    Returns void

  • get pinOptionsVisible(): boolean
  • Returns boolean

  • set pinOptionsVisible(v): void
  • Parameters

    • v: boolean

    Returns void

  • get pinOptionsVisibleResolved(): boolean
  • Returns boolean

  • get pinRightCaption(): string
  • Returns string

  • set pinRightCaption(v): void
  • Parameters

    • v: string

    Returns void

  • get sortAscendingCaption(): string
  • Returns string

  • set sortAscendingCaption(v): void
  • Parameters

    • v: string

    Returns void

  • get sortDescendingCaption(): string
  • Returns string

  • set sortDescendingCaption(v): void
  • Parameters

    • v: string

    Returns void

  • get sortHeaderCaption(): string
  • Returns string

  • set sortHeaderCaption(v): void
  • Parameters

    • v: string

    Returns void

  • get sortOptionsVisible(): boolean
  • Returns boolean

  • set sortOptionsVisible(v): void
  • Parameters

    • v: boolean

    Returns void

  • get sortOptionsVisibleResolved(): boolean
  • Returns boolean

  • get summaryListBackground(): string
  • Gets or sets the background color for the summary options menu.

    Returns string

  • set summaryListBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get summaryListDensity(): ControlDisplayDensity
  • Gets or sets the display density to use for the summary list menu.

    Returns ControlDisplayDensity

  • set summaryListDensity(v): void
  • Parameters

    • v: ControlDisplayDensity

    Returns void

  • get summaryListTextColor(): string
  • Gets or sets the text color for the summary options menu.

    Returns string

  • set summaryListTextColor(v): void
  • Parameters

    • v: string

    Returns void

  • get summaryOptionsVisible(): boolean
  • Returns boolean

  • set summaryOptionsVisible(v): void
  • Parameters

    • v: boolean

    Returns void

  • get summaryOptionsVisibleResolved(): boolean
  • Returns boolean

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

    Returns string

  • set textColor(v): void
  • Parameters

    • v: string

    Returns void

  • get width(): string
  • Returns string

  • set width(value): void
  • Parameters

    • value: string

    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

  • Returns void

  • Parameters

    • name: string

    Returns any

  • Parameters

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

    Returns void

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

  • Returns void