Winter Cardinal UI - v0.442.0 / DTableDataTreeFilter

Class: DTableDataTreeFilter<NODE>

Table data filter.

Type parameters

Name	Type
NODE	extends DTableDataTreeNode<NODE, NODE>

Hierarchy

• EventEmitter

  ↳ DTableDataTreeFilter

Implements

• DTableDataFilter<NODE>

Table of contents

Constructors

• constructor

Properties

• _filter
• _filtered
• _id
• _idUpdated
• _isApplied
• _parent

Accessors

• id
• indices

Methods

• addAllToFiltered
• addListener
• apply
• emit
• eventNames
• get
• hasFiltered
• isApplied
• isFiltered
• listenerCount
• listeners
• map
• newFiltered
• newFilteredSub
• off
• on
• once
• removeAllListeners
• removeListener
• set
• toDirty
• unapply
• unmap
• update

Constructors

constructor

• new DTableDataTreeFilter<NODE>(parent): DTableDataTreeFilter<NODE>

Type parameters

Name	Type
NODE	extends DTableDataTreeNode<NODE, NODE>

Parameters

Name	Type
parent	DTableDataTreeFilterParent<NODE>

Returns

DTableDataTreeFilter<NODE>

Overrides

utils.EventEmitter.constructor

Defined in

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

Properties

_filter

• Protected _filter: null | DTableDataFilterer<NODE>

Defined in

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

---

_filtered

• Protected _filtered: null | number[]

Defined in

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

---

_id

• Protected _id: number

Defined in

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

---

_idUpdated

• Protected _idUpdated: number

Defined in

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

---

_isApplied

• Protected _isApplied: boolean

Defined in

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

---

_parent

• Protected _parent: DTableDataTreeFilterParent<NODE>

Defined in

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

Accessors

id

• get id(): number

Returns

number

Implementation of

DTableDataFilter.id

Defined in

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

---

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-tree-filter.ts:197

Methods

addAllToFiltered

▸ addAllToFiltered(parent, nodes, filtered, cursor): void

Parameters

Name	Type
parent	DTableDataTreeFilterParent<NODE>
nodes	NODE[]
filtered	number[]
cursor	[number]

Returns

void

Defined in

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

---

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-tree-filter.ts:46

---

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<NODE>

Returns a current filter.

Returns

null | DTableDataFilterer<NODE>

Implementation of

DTableDataFilter.get

Defined in

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

---

hasFiltered

▸ hasFiltered(parent, nodes, filter): boolean

Parameters

Name	Type
parent	DTableDataTreeFilterParent<NODE>
nodes	NODE[]
filter	DTableDataFilterer<NODE>

Returns

boolean

Defined in

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

---

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-tree-filter.ts:60

---

isFiltered

▸ isFiltered(node, index, filter): boolean

Parameters

Name	Type
node	NODE
index	number
filter	DTableDataFilterer<NODE>

Returns

boolean

Defined in

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

---

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-tree-filter.ts:202

---

newFiltered

▸ newFiltered(): null | number[]

Returns

null | number[]

Defined in

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

---

newFilteredSub

▸ newFilteredSub(parent, nodes, filter, filtered, cursor): boolean

Parameters

Name	Type
parent	DTableDataTreeFilterParent<NODE>
nodes	NODE[]
filter	DTableDataFilterer<NODE>
filtered	number[]
cursor	[number]

Returns

boolean

Defined in

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

---

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<NODE>	A filter

Returns

void

Implementation of

DTableDataFilter.set

Defined in

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

---

toDirty

▸ toDirty(): void

Returns

void

Defined in

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

---

unapply

▸ unapply(): void

Unapplys a filter.

Returns

void

Implementation of

DTableDataFilter.unapply

Defined in

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

---

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-tree-filter.ts:218

---

update

▸ update(): void

Returns

void

Defined in

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

Edit this page.