RevGrid - v0.10.0
    Preparing search index...

    Type Parameters

    Implements

    Index

    Constructors

    Accessors

    • get allChangedRecentDuration(): number

      Returns number

    • set allChangedRecentDuration(value: number): void

      Parameters

      • value: number

      Returns void

    • get continuousFiltering(): boolean

      Returns boolean

    • set continuousFiltering(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get isFiltered(): boolean

      Returns boolean

    • get recordCount(): number

      Returns number

    • get recordInsertedRecentDuration(): number

      Returns number

    • set recordInsertedRecentDuration(value: number): void

      Parameters

      • value: number

      Returns void

    • get recordUpdatedRecentDuration(): number

      Returns number

    • set recordUpdatedRecentDuration(value: number): void

      Parameters

      • value: number

      Returns void

    • get rowCount(): number

      Returns number

    • get rowOrderReversed(): boolean

      Returns boolean

    • set rowOrderReversed(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get sortColumnCount(): number

      Returns number

    • get sortFieldSpecifierCount(): number

      Returns number

    • get valueChangedRecentDuration(): number

      Returns number

    • set valueChangedRecentDuration(value: number): void

      Parameters

      • value: number

      Returns void

    Methods

    • Returns boolean

    • Returns void

    • Returns void

    • Get a field's value at the specified row in a format suitable for editing.

      This function only needs to be implemented if cells can be edited. See RevCellEditor for more information about editing data. The core of the client does not need to know the type of the return value. getEditValue() is called by the Cell Editor associated with the cell. A cell editor expects a certain type of view value and casts the result accordingly.

      Parameters

      • field: SF
      • rowIndex: number

      Returns unknown

    • Parameters

      • field: number | SF

      Returns undefined | boolean

    • Parameters

      • field: number | SF

      Returns undefined | number

    • Parameters

      • rowIndex: number

      Returns number

    • Gets current count of rows in the associated subgrid at the server.

      Returns number

    • Gets a unique identifier for a row which is not affected by sorting, filtering or reordering.

      This optional method needs to be implemented for selection and focus to be preserved across row sorting, filtering and reordering.

      Parameters

      • rowIndex: number

      Returns unknown

    • Gets the current subgrid row index of a row from a row identifier.

      This optional method does not need to be implemented for selection and focus to be preserved row across sorting, filtering and reordering however, if implemented, it will make restoring focus and selection more efficient.

      Parameters

      Returns undefined | number

    • Parameters

      • recordIndex: number

      Returns undefined | number

    • Get a field's value at the specified row in a format suitable for display.

      The core of the client does not need to know the type of the return value. getViewValue() is called by the Cell Painter associated with the cell/subgrid. The cell painter expects a certain type of view value and casts the result accordingly.

      Parameters

      • field: SF
      • rowIndex: number

      Returns unknown

      The value of the field at the specified row.

    • Parameters

      • fieldIndexes: readonly number[]

      Returns void

    • Parameters

      • recordIndex: number
      • Optionalrecent: boolean

      Returns void

    • Parameters

      • recordIndex: number
      • fieldIndex: number
      • fieldCount: number

      Returns void

    • Parameters

      • recordIndex: number
      • count: number
      • Optionalrecent: boolean

      Returns void

    • Parameters

      • rangeFieldIndex: number
      • rangeCount: number

      Returns boolean

    • Parameters

      • fieldIndexes: readonly number[]

      Returns boolean

    • Parameters

      • fieldIndex: number

      Returns boolean

    • Parameters

      • recordIndex: number
      • Optionalrecent: boolean

      Returns void

    • Parameters

      • fromIndex: number
      • toIndex: number

      Returns void

    • Parameters

      • recordIndex: number
      • count: number

      Returns void

    • Parameters

      • firstInsertedRecordIndex: number
      • count: number
      • Optionalrecent: boolean

      Returns void

    • Parameters

      • fromIndex: number
      • toIndex: number
      • moveCount: number

      Returns void

    • Parameters

      • recordIndex: number
      • count: number

      Returns void

    • Parameters

      • recordIndex: number
      • deleteCount: number
      • insertCount: number

      Returns void

    • Returns void

    • Parameters

      • rowIndex: number

      Returns number

    • Parameters

      • rowIndex: number

      Returns number

    • Set a cell's value given its column schema & row indexes and a new value.

      If not implemented, the cell cannot be edited.

      Parameters

      • field: SF
      • rowIndex: number
      • value: unknown

      Returns void

    • Returns void

    • Parameters

      • OptionalfieldIndex: number
      • OptionalisAscending: boolean

      Returns boolean