Winter Cardinal UI - v0.442.0 / DTableDataListFilter

Class: DTableDataListFilter<ROW>

Table data filter.

Type parameters

Name
ROW

Hierarchy

Implements

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new DTableDataListFilter<ROW>(parent): DTableDataListFilter<ROW>

Type parameters

Name
ROW

Parameters

Name Type
parent DTableDataListFilterParent<ROW>

Returns

DTableDataListFilter<ROW>

Overrides

utils.EventEmitter.constructor

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-filter.ts:26

Properties

_filter

Protected _filter: null | DTableDataFilterer<ROW>

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-filter.ts:23


_filtered

Protected _filtered: null | number[]

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-filter.ts:24


_id

Protected _id: number

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-filter.ts:18


_idUpdated

Protected _idUpdated: number

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-filter.ts:19


_isApplied

Protected _isApplied: boolean

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-filter.ts:20


_parent

Protected _parent: DTableDataListFilterParent<ROW>

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-filter.ts:22


_sorterId

Protected _sorterId: number

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-filter.ts:21

Accessors

id

get id(): number

Returns

number

Implementation of

DTableDataFilter.id

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-filter.ts:39


indices

get indices(): null | number[]

An indices of filtered rows. Must not change this indices directly.

Returns

null | number[]

Implementation of

DTableDataFilter.indices

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-filter.ts:135

Methods

addListener

addListener(event, fn, context?): this

Alias method for on

Parameters

Name Type
event string | symbol
fn Function
context? any

Returns

this

Implementation of

DTableDataFilter.addListener

Inherited from

utils.EventEmitter.addListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25495


apply

apply(): void

Applys a filter.

Returns

void

Implementation of

DTableDataFilter.apply

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-filter.ts:43


emit

emit(event, ...args): boolean

Calls each of the listeners registered for a given event.

Parameters

Name Type Description
event string | symbol The event name.
...args any[] Arguments that are passed to registered listeners

Returns

boolean

true if the event had listeners, else false.

Implementation of

DTableDataFilter.emit

Inherited from

utils.EventEmitter.emit

Defined in

node_modules/pixi.js/pixi.js.d.ts:25441


eventNames

eventNames(): (string | symbol)[]

Return an array listing the events for which the emitter has registered listeners.

Returns

(string | symbol)[]

Implementation of

DTableDataFilter.eventNames

Inherited from

utils.EventEmitter.eventNames

Defined in

node_modules/pixi.js/pixi.js.d.ts:25415


get

get(): null | DTableDataFilterer<ROW>

Returns a current filter.

Returns

null | DTableDataFilterer<ROW>

Implementation of

DTableDataFilter.get

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-filter.ts:107


isApplied

isApplied(): boolean

Returns true if a filter is applied.

Returns

boolean

Implementation of

DTableDataFilter.isApplied

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-filter.ts:57


listenerCount

listenerCount(event): number

Return the number of listeners listening to a given event.

Parameters

Name Type Description
event string | symbol The event name.

Returns

number

Implementation of

DTableDataFilter.listenerCount

Inherited from

utils.EventEmitter.listenerCount

Defined in

node_modules/pixi.js/pixi.js.d.ts:25432


listeners

listeners(event): Function[]

Return the listeners registered for a given event.

Parameters

Name Type Description
event string | symbol The event name.

Returns

Function[]

Implementation of

DTableDataFilter.listeners

Inherited from

utils.EventEmitter.listeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25424


map

map(sortedIndex): null | number

Returns a mapped index of the specified sorted index.

Parameters

Name Type Description
sortedIndex number an sorted index

Returns

null | number

Implementation of

DTableDataFilter.map

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-filter.ts:140


newFiltered

newFiltered(): null | number[]

Returns

null | number[]

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-filter.ts:61


off

off(event, fn?, context?, once?): this

Alias method for removeListener

Parameters

Name Type
event string | symbol
fn? Function
context? any
once? boolean

Returns

this

Implementation of

DTableDataFilter.off

Inherited from

utils.EventEmitter.off

Defined in

node_modules/pixi.js/pixi.js.d.ts:25489


on

on(event, fn, context?): this

Add a listener for a given event.

Parameters

Name Type Description
event string | symbol The event name.
fn Function The listener function.
context? any The context to invoke the listener with.

Returns

this

this.

Implementation of

DTableDataFilter.on

Inherited from

utils.EventEmitter.on

Defined in

node_modules/pixi.js/pixi.js.d.ts:25452


once

once(event, fn, context?): this

Add a one-time listener for a given event.

Parameters

Name Type Description
event string | symbol The event name.
fn Function The listener function.
context? any The context to invoke the listener with.

Returns

this

this.

Implementation of

DTableDataFilter.once

Inherited from

utils.EventEmitter.once

Defined in

node_modules/pixi.js/pixi.js.d.ts:25463


removeAllListeners

removeAllListeners(event?): this

Remove all listeners, or those of the specified event.

Parameters

Name Type Description
event? string | symbol The event name.

Returns

this

this.

Implementation of

DTableDataFilter.removeAllListeners

Inherited from

utils.EventEmitter.removeAllListeners

Defined in

node_modules/pixi.js/pixi.js.d.ts:25483


removeListener

removeListener(event, fn?, context?, once?): this

Remove the listeners of a given event.

Parameters

Name Type Description
event string | symbol The event name.
fn? Function Only remove the listeners that match this function.
context? any Only remove the listeners that have this context.
once? boolean Only remove one-time listeners.

Returns

this

this.

Implementation of

DTableDataFilter.removeListener

Inherited from

utils.EventEmitter.removeListener

Defined in

node_modules/pixi.js/pixi.js.d.ts:25475


set

set(filter): void

Sets to the given filter.

Parameters

Name Type Description
filter null | DTableDataFilterer<ROW> A filter

Returns

void

Implementation of

DTableDataFilter.set

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-filter.ts:111


toDirty

toDirty(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-filter.ts:117


unapply

unapply(): void

Unapplys a filter.

Returns

void

Implementation of

DTableDataFilter.unapply

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-filter.ts:49


unmap

unmap(index): number

Returns an sorted index of the specified mapped index. A mapped index is an index on rows filters and sorters are applied.

Parameters

Name Type Description
index number a mapped index

Returns

number

Implementation of

DTableDataFilter.unmap

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-filter.ts:156


update

update(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-table-data-list-filter.ts:121