An advanced grid for displaying data.

Type Parameters

Hierarchy

Hierarchy

  • Component<P, {}>
    • IgrDataGridFilterDialog

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<P> & 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 actualPixelScalingRatio(): number
  • Gets the actual pixel scaling ratio used to affect the pixel density of the control. A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

    Returns number

  • set actualPixelScalingRatio(v): void
  • Parameters

    • v: number

    Returns void

  • get commandCompleted(): ((arg1) => void)
  • Returns ((arg1) => void)

      • (arg1): void
      • Parameters

        • arg1: ToolCommand

        Returns void

  • set commandCompleted(v): void
  • Parameters

    • v: ((arg1) => void)
        • (arg1): void
        • Parameters

          • arg1: ToolCommand

          Returns void

    Returns void

  • get iconColor(): string
  • Returns string

  • set iconColor(v): void
  • Parameters

    • v: string

    Returns void

  • get invalidateActions(): (() => void)
  • Returns (() => void)

      • (): void
      • Returns void

  • set invalidateActions(v): void
  • Parameters

    • v: (() => void)
        • (): void
        • Returns void

    Returns void

  • get isAnimationEnabled(): boolean
  • Returns boolean

  • set isAnimationEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get isOpen(): boolean
  • Returns boolean

  • get nativeElement(): HTMLElement
  • Returns HTMLElement

  • get pixelScalingRatio(): number
  • Gets or sets the scaling value used to affect the pixel density of the control. A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control to appear blurry.

    Returns number

  • set pixelScalingRatio(v): void
  • Parameters

    • v: number

    Returns void

  • get viewSize(): number
  • Returns number

  • set viewSize(v): void
  • Parameters

    • v: number

    Returns void

Methods

  • Parameters

    • listener: ICommandAvailabilityListener

    Returns void

  • Parameters

    • listener: ICommandStateChangedListener

    Returns void

  • 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

    • prevProps: Readonly<P>
    • prevState: Readonly<{}>
    • Optional snapshot: any

    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

  • Returns ToolActionInfo[]

  • 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

    • prevProps: Readonly<P>
    • prevState: Readonly<{}>

    Returns any

  • Returns void

  • Returns void

  • Parameters

    • width: number
    • height: number

    Returns void

  • Parameters

    • accessor: IToolbarContextAccessor

    Returns void

  • Parameters

    • listener: ICommandAvailabilityListener

    Returns void

  • Parameters

    • listener: ICommandStateChangedListener

    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

  • Returns void