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<IIgrColumnChooserProps> & 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 backgroundColor(): string
  • Gets or Sets the property name that contains the values.

    Returns string

  • set backgroundColor(v): void
  • Parameters

    • v: string

    Returns void

  • get baseTheme(): BaseControlTheme
  • Gets or Sets the property name that contains the values.

    Returns BaseControlTheme

  • set baseTheme(v): void
  • Parameters

    • v: BaseControlTheme

    Returns void

  • get density(): ControlDisplayDensity
  • Gets or Sets the property name that contains the values.

    Returns ControlDisplayDensity

  • set density(v): void
  • Parameters

    • v: ControlDisplayDensity

    Returns void

  • get filterPlaceholderText(): string
  • Gets or Sets the property name that contains the values.

    Returns string

  • set filterPlaceholderText(v): void
  • Parameters

    • v: string

    Returns void

  • get height(): string
  • Returns string

  • set height(value): void
  • Parameters

    • value: string

    Returns void

  • get i(): ColumnChooser
  • Returns ColumnChooser

  • get targetGrid(): IgrDataGrid
  • Gets or Sets the property name that contains the values.

    Returns IgrDataGrid

  • set targetGrid(v): void
  • Parameters

    Returns void

  • get title(): string
  • Gets or Sets the property name that contains the values.

    Returns string

  • set title(v): void
  • Parameters

    • v: string

    Returns void

  • get titleColor(): string
  • Gets or Sets the property name that contains the values.

    Returns string

  • set titleColor(v): void
  • Parameters

    • v: string

    Returns void

  • get titleStyle(): string
  • Gets or Sets the property name that contains the values.

    Returns string

  • set titleStyle(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

  • 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

  • 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

  • Returns DetailedReactHTMLElement<{
        children: any[];
        className: string;
        ref: ((ref) => void);
    }, 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

  • Returns void