Hierarchy

Hierarchy

Implements

  • IExternalListPanel

Constructors

Properties

Accessors

Methods

Constructors

  • Parameters

    Returns IgrListPanel

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<IIgrListPanelProps> & 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 activationBorder(): string
  • Gets or sets the activation border color to use.

    Returns string

  • set activationBorder(v): void
  • Parameters

    • v: string

    Returns void

  • get activationBorderBottomWidth(): number
  • Gets or sets the amount of bottom activation border to use for the cell content of this column.

    Returns number

  • set activationBorderBottomWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get activationBorderLeftWidth(): number
  • Gets or sets the amount of left activation border to use for the cell content for this column.

    Returns number

  • set activationBorderLeftWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get activationBorderRightWidth(): number
  • Gets or sets the amount of right activation border to use for the cell content of this column.

    Returns number

  • set activationBorderRightWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get activationBorderTopWidth(): number
  • Gets or sets the amount of top activation border to use for the cell content for this column.

    Returns number

  • set activationBorderTopWidth(v): void
  • Parameters

    • v: number

    Returns void

  • get activeRow(): number
  • Gets or sets the position of the active row.

    Returns number

  • set activeRow(v): void
  • Parameters

    • v: number

    Returns void

  • get activeRowChanged(): ((s, e) => void)
  • Called when the active row changes.

    Returns ((s, e) => void)

  • set activeRowChanged(ev): void
  • Parameters

    Returns void

  • get actualPrimaryKey(): string[]
  • Gets either the inferred primary key from the data source, or the user provided primary key, if present. Represents the actual primary key that the grid will use in operations that require it.

    Returns string[]

  • set actualPrimaryKey(v): void
  • Parameters

    • v: string[]

    Returns void

  • get actualPrimaryKeyChange(): ((s, e) => void)
  • Returns ((s, e) => void)

      • (s, e): void
      • Parameters

        Returns void

  • set actualPrimaryKeyChange(ev): void
  • Parameters

    • ev: ((s, e) => void)
        • (s, e): void
        • Parameters

          Returns void

    Returns void

  • get actualRowHeight(): number
  • Returns number

  • set actualRowHeight(v): void
  • Parameters

    • v: number

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

    Returns string

  • set cellTextStyle(v): void
  • Parameters

    • v: string

    Returns void

  • get hasUnevenSizes(): boolean
  • Returns boolean

  • get height(): string
  • Returns string

  • set height(value): void
  • Parameters

    • value: string

    Returns void

  • get i(): ListPanel
  • Returns ListPanel

  • get isActiveRowStyleEnabled(): boolean
  • Gets or sets whether the active row style will be applied to rows when made active.

    Returns boolean

  • set isActiveRowStyleEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

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

    Returns boolean

  • set isCustomRowHeightEnabled(v): void
  • Parameters

    • v: boolean

    Returns void

  • get itemClicked(): ((s, e) => void)
  • Returns ((s, e) => void)

  • set itemClicked(ev): void
  • Parameters

    Returns void

  • get itemRebind(): ((s, e) => void)
  • Called when item content is rebound.

    Returns ((s, e) => void)

  • set itemRebind(ev): void
  • Parameters

    Returns void

  • get itemRecycled(): ((s, e) => void)
  • Called when item content is recycled.

    Returns ((s, e) => void)

  • set itemRecycled(ev): void
  • Parameters

    Returns void

  • get itemSpacing(): number
  • Gets or sets the spacing between items.

    Returns number

  • set itemSpacing(v): void
  • Parameters

    • v: number

    Returns void

  • get normalBackground(): string
  • Gets or sets the background color to use.

    Returns string

  • set normalBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get notifyOnAllSelectionChanges(): boolean
  • Gets or sets if the grid should notify on programmatic selection changes as well as changes from the UI.

    Returns boolean

  • set notifyOnAllSelectionChanges(v): void
  • Parameters

    • v: boolean

    Returns void

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

    Returns ListPanelOrientation

  • set orientation(v): void
  • Parameters

    Returns void

  • get primaryKey(): string[]
  • Sets or gets the user provided primary key to assume for the data. Certain functionality of the grid requires a way to uniquely identify items in order to work correctly. If a primary key cannot be inferred from the data source, you may need to provide one here.

    Returns string[]

  • set primaryKey(v): void
  • Parameters

    • v: string[]

    Returns void

  • get rowHeight(): number
  • Gets or Sets the property name that contains the values.

    Returns number

  • set rowHeight(v): void
  • Parameters

    • v: number

    Returns void

  • get schemaIncludedProperties(): string[]
  • Gets either the filtered properties to include in the schema of the data source.

    Returns string[]

  • set schemaIncludedProperties(v): void
  • Parameters

    • v: string[]

    Returns void

  • get scrollbarBackground(): string
  • Gets or sets the scrollbar background color.

    Returns string

  • set scrollbarBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get scrollbarStyle(): ScrollbarStyle
  • Gets or sets the style of scrollbar.

    Returns ScrollbarStyle

  • set scrollbarStyle(v): void
  • Parameters

    • v: ScrollbarStyle

    Returns void

  • get selectedBackground(): string
  • Gets or sets the background color to use for the cells when they are selected

    Returns string

  • set selectedBackground(v): void
  • Parameters

    • v: string

    Returns void

  • get selectedItemsChanged(): ((s, e) => void)
  • Called when the selected items change.

    Returns ((s, e) => void)

  • set selectedItemsChanged(ev): void
  • Parameters

    Returns void

  • get selectedKeysChanged(): ((s, e) => void)
  • Called when the selected keys change.

    Returns ((s, e) => void)

  • set selectedKeysChanged(ev): void
  • Parameters

    Returns void

  • get selectionChanged(): ((s, e) => void)
  • Called when an individual selection operation has been made.

    Returns ((s, e) => void)

  • set selectionChanged(ev): void
  • Parameters

    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

  • 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

  • Parameters

    • itemsSource: any
    • schemaIncludedProperties: string[]

    Returns IDataSource

  • Returns the data index of an item within the bound data source.

    Parameters

    • item: any
      • The item from which to get the index.

    Returns number

  • Parameters

    • key: any[]

    Returns number

  • Deselects all currently selected rows.

    Returns void

  • Returns void

  • Returns string

  • Returns any

  • Parameters

    • name: string

    Returns any

  • Parameters

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

    Returns void

  • Gets the first visible index in the grid.

    Returns number

  • Gets the last visible index in the grid.

    Returns number

  • 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

  • Invalidates the bound data for the rows currently visible.

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Manually notifies the grid's data source that the data it has bound to has been cleared and needs to be re-examined. This should not be called if the data that the grid is bound to is already observable.

    Returns void

  • Parameters

    • index: number
    • newItem: any

    Returns void

  • Parameters

    • index: number
    • oldItem: any

    Returns void

  • Parameters

    • index: number
    • oldItem: any
    • newItem: any

    Returns void

  • Returns void

  • Returns void

  • Returns void

  • Returns void

  • Returns void

  • Returns DetailedReactHTMLElement<{
        className: string;
        ref: ((ref) => void);
    }, any>

  • Parameters

    • x: number
    • y: number

    Returns void

  • Scrolls the grid so that a row is the last visible, by index.

    Parameters

    • rowNumber: number
      • The row index to scroll to.

    Returns void

  • Scrolls the grid to given row, by index

    Parameters

    • rowNumber: number
      • The row index to scroll to.

    Returns void

  • Selects all of the rows in the grid.

    Returns void

  • Parameters

    • color: any

    Returns void

  • Parameters

    • style: ScrollbarStyle

    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