JavaScript & React libraryAPI

Class: FilteringClient

Implements

  • ClauseSource

Constructors

Constructor

new FilteringClient(config): FilteringClient

Parameters

ParameterType
configFilteringClientConfig

Returns

FilteringClient

Accessors

selection

Get Signature

get selection(): Selection | undefined

Returns

Selection | undefined


tableName

Get Signature

get tableName(): string

Returns

string


accessor

Get Signature

get accessor(): string | undefined

Returns

string | undefined


id

Get Signature

get id(): string

Returns

string


active

Get Signature

get active(): boolean

Returns

boolean


currentData

Get Signature

get currentData(): CosmographData | undefined

Returns

CosmographData | undefined


fieldsToQuery

Get Signature

get fieldsToQuery(): (string | ColumnRefNode)[]

Returns

(string | ColumnRefNode)[]

Methods

getOrCreateClient()

static getOrCreateClient(config): FilteringClient

Parameters

ParameterType
configFilteringClientConfig

Returns

FilteringClient


setActive()

setActive(value): void

Parameters

ParameterType
valueboolean

Returns

void


getCurrentData()

getCurrentData(): Promise<CosmographData>

Returns

Promise<CosmographData>


applyFilter()

applyFilter(predicate): void

Parameters

ParameterType
predicateExprNode | null | undefined

Returns

void


applyRangeFilter()

applyRangeFilter(range): void

Parameters

ParameterType
range[number, number] | [Date, Date] | undefined

Returns

void


applyExactFilter()

applyExactFilter(value): void

Parameters

ParameterType
valuestring | number | undefined

Returns

void


applyInFilter()

applyInFilter(values): void

Parameters

ParameterType
values(string | number)[] | ArrayLike<string | number> | undefined

Returns

void


applyLessOrEqFilter()

applyLessOrEqFilter(value): void

Parameters

ParameterType
valuenumber | undefined

Returns

void


applyGreaterOrEqFilter()

applyGreaterOrEqFilter(value): void

Parameters

ParameterType
valuenumber | undefined

Returns

void


resetFilter()

resetFilter(): void

Returns

void


update()

update(): void

Returns

void


destroy()

destroy(): void

Returns

void


regenerateClient()

regenerateClient(): void

Returns

void


reset()

reset(): void

Required by the ClauseSource interface so that this FilteringClient can be used as the source of a SelectionClause. Internally this method simply delegates to resetFilter.

Returns

void

Implementation of

ClauseSource.reset