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<IIgrDataGridPagerProps> & 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 actualDataSource(): IDataSource
  • Returns IDataSource

  • 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 border color around the grid.

    Returns string

  • set border(v): void
  • Parameters

    • v: string

    Returns void

  • get currentPage(): number
  • Gets or sets the current page for the pager.

    Returns number

  • set currentPage(v): void
  • Parameters

    • v: number

    Returns void

  • get dataSource(): any
  • Returns any

  • set dataSource(value): void
  • Gets or sets the data used by the pager.

    Parameters

    • value: any

    Returns void

  • get i(): Pager
  • Returns Pager

  • get pageChanged(): ((s, e) => void)
  • Event called when the page has changed.

    Returns ((s, e) => void)

  • set pageChanged(ev): void
  • Parameters

    Returns void

  • get pageCount(): number
  • Gets the page count.

    Returns number

  • set pageCount(v): void
  • Parameters

    • v: number

    Returns void

  • get pageSize(): number
  • Gets or sets the page size.

    Returns number

  • set pageSize(v): void
  • Parameters

    • v: number

    Returns void

  • get pagerText(): string
  • Returns string

  • set pagerText(v): void
  • Parameters

    • v: string

    Returns void

  • get targetGrid(): IgrDataGrid
  • Returns IgrDataGrid

  • set targetGrid(value): void
  • Gets or sets the target grid for the pager.

    Parameters

    Returns void

  • get textStyle(): string
  • Gets or sets the font to use for content cells

    Returns string

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

  • 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

  • Returns a serialized copy of the exported visual model

    Returns string

  • Exports visual information about the current state of the grid.

    Returns any

  • Parameters

    • name: string

    Returns any

  • Returns void

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

  • Returns void

  • Returns void

  • Parameters

    • container: any

    Returns void

  • Returns DetailedReactHTMLElement<{
        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