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<IIgrGridColumnOptionsSimpleSectionBaseProps> & 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 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 caption(): string
  • Returns string

  • set caption(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 i(): GridColumnPinOptions
  • Returns GridColumnPinOptions

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

    Returns string

  • set labelTextStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get nativeElement(): HTMLElement
  • Returns HTMLElement

  • get pinLeftCaption(): string
  • Returns string

  • set pinLeftCaption(v): void
  • Parameters

    • v: string

    Returns void

  • get pinRightCaption(): string
  • Returns string

  • set pinRightCaption(v): void
  • Parameters

    • v: string

    Returns void

  • get showCaption(): boolean
  • Returns boolean

  • set showCaption(v): void
  • Parameters

    • v: boolean

    Returns void

  • 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

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

  • 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

  • Returns void