Winter Cardinal UI - v0.457.0 / DTableDataFilter

Interface: DTableDataFilter<ROW>

Table data filter.

Type parameters

Name
ROW

Hierarchy

• EventEmitter

  ↳ DTableDataFilter

Implemented by

• DTableDataListFilter
• DTableDataTreeFilter

Table of contents

Properties

• id
• indices

Methods

• addListener
• apply
• emit
• eventNames
• get
• isApplied
• listenerCount
• listeners
• map
• off
• on
• once
• removeAllListeners
• removeListener
• set
• unapply
• unmap

Properties

id

• Readonly id: number

Defined in

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

---

indices

• Readonly indices: null | number[]

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

Defined in

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

Methods

addListener

▸ addListener(event, fn, context?): this

Alias method for on

Parameters

Name	Type
event	string | symbol
fn	Function
context?	any

Returns

this

Inherited from

utils.EventEmitter.addListener

Defined in

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

---

apply

▸ apply(): void

Applys a filter.

Returns

void

Defined in

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

---

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.

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)[]

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>

Defined in

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

---

isApplied

▸ isApplied(): boolean

Returns true if a filter is applied.

Returns

boolean

Defined in

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

---

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

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[]

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

Defined in

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

---

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

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.

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.

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.

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.

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

Defined in

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

---

unapply

▸ unapply(): void

Unapplys a filter.

Returns

void

Defined in

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

---

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

Defined in

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

Edit this page.