Class DeepToolsDimension

Hierarchy (View Summary)

Constructors

constructor

Properties

bgfArray bgfData data deepToolsWorker dimensions displayData filterArguments filterArray filterBuffer filterColumns filterIndexes filterMethod localFilter order orderBuffer parent sortWorker types

Methods

clearBackGroundFilter destroy filter filterOnIndex filterPredicate getLocalFilter getValueSet reFilterOnDataChanged removeFilter setBackgroundFilter setParameters setSortOrder sort updateData updateSize

Constructors

constructor

Properties

bgfArray

bgfArray: undefined | null | Uint8Array<any>

bgfData

bgfData: undefined | null | { cat: string; column: string }

data

data: any

deepToolsWorker

deepToolsWorker: Worker

dimensions

dimensions: undefined | { columns: any; groups: any; length: any; rows: any }

displayData

displayData: any

filterArguments

filterArguments: undefined | null | string | object

filterArray

filterArray: Uint8Array<SharedArrayBuffer>

filterBuffer

filterBuffer: SharedArrayBuffer

filterColumns

filterColumns: undefined | string[]

filterIndexes

filterIndexes: any

filterMethod

filterMethod: undefined | null | string

localFilter

localFilter: any

order

order: Uint32Array<SharedArrayBuffer>

orderBuffer

orderBuffer: SharedArrayBuffer

parent

parent: DataStore

sortWorker

sortWorker: Worker

Statictypes

types: { [k: string]: undefined | typeof Dimension }

Methods

clearBackGroundFilter

destroy

filter

  • filter(
        method: string,
        columns: string[],
        args: string | object,
        notify?: boolean,
    ): void

  • Filters the data

    Parameters

    • method: string

      The name of the filter method. if 'filterPredicate' then the args should contain a predicate function

    • columns: string[]

      a list of column ids used in the filtering

    • args: string | object

      any extra arguments for filtering

    • Optionalnotify: boolean = true

      notify any listeners in the dataStore that the data has been filtered

    Returns void

filterOnIndex

filterPredicate

getLocalFilter

getValueSet

reFilterOnDataChanged

  • reFilterOnDataChanged(columns: string[]): boolean

  • updates the filter if data in the supplied columns has been altered does not propagate (call any listeners)

    Parameters

    • columns: string[]

      a list of columns whose data has changes

    Returns boolean

    True if refiltering has taken place

removeFilter

setBackgroundFilter

setParameters

  • setParameters(
        __namedParameters: {
            columns: any;
            data: any;
            displayData: any;
            groups: any;
            length: any;
            rows: any;
        },
    ): void

  • Parameters

    • __namedParameters: {
          columns: any;
          data: any;
          displayData: any;
          groups: any;
          length: any;
          rows: any;
      }

    Returns void

setSortOrder

sort

  • sort(sortColumns: any[]): Promise<any>

  • Sorts the dimension based on the columns and order

    Parameters

    • sortColumns: any[]

      An array of objects with the following properties

    Returns Promise<any>

    • A promise that resolves to the new order

updateData

updateSize

Settings

Member Visibility

On This Page

Constructors
Properties
Methods