Class Dimension

constructor

• new Dimension(parent: DataStore): Dimension

• Parameters

  • parent: DataStore

  Returns Dimension

bgfArray

bgfData

filterArguments

filterArray

filterBuffer

filterColumns

filterIndexes

filterMethod

localFilter

parent

Statictypes

clearBackGroundFilter

• clearBackGroundFilter(): void

• Returns void

destroy

• destroy(notify?: boolean): void

• Parameters

  • notify: boolean = true

  Returns void

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

• filterOnIndex(indexSet: any): void

• Parameters

  • indexSet: any

  Returns void

filterPredicate

• filterPredicate(args: any, columns: any): void

• Filters the data based on a predicate function. The function should return false if the row should be filtered out.

  Parameters

  • args: any
  • columns: any

  Returns void

getLocalFilter

• getLocalFilter(): Uint8Array<SharedArrayBuffer>

• Returns Uint8Array<SharedArrayBuffer>

getValueSet

• getValueSet(column: any): Promise<Set<any>>

• Parameters

  • column: any

  Returns Promise<Set<any>>

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

• removeFilter(notify?: boolean): void

• Parameters

  • notify: boolean = true

  Returns void

setBackgroundFilter

• setBackgroundFilter(column: string, cat: string): void

• sets a permenant filter on the chart

  Parameters

  • column: string

    The column of the filter
  • cat: string

    the category in the column to filter on

  Returns void

updateSize

• updateSize(): void

• Experimental - should be invoked if the datastore has increased in size Will increase size of local filters

  Returns void