Winter Cardinal UI - v0.457.0 / DListDataSelection

Interface: DListDataSelection<ITEM>

Type parameters

Name
ITEM

Hierarchy

• EventEmitter

  ↳ DListDataSelection

  ↳↳ DListDataImplSelection

Implemented by

• DListDataSelectionMultiple
• DListDataSelectionNone
• DListDataSelectionSingle

Table of contents

Properties

• first
• last
• type

Methods

• add
• addListener
• clear
• clearAndAdd
• clearAndAddAll
• contains
• each
• emit
• eventNames
• get
• isEmpty
• listenerCount
• listeners
• off
• on
• once
• remove
• removeAllListeners
• removeListener
• size
• toArray
• toggle

Properties

first

• Readonly first: null | ITEM

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection.ts:62

---

last

• Readonly last: null | ITEM

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection.ts:63

---

type

• Readonly type: DListDataSelectionType

Defined in

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

Methods

add

▸ add(target): boolean

Adds the given item

Parameters

Name	Type	Description
target	ITEM	an item

Returns

boolean

true if succeeded.

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection.ts:79

---

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

---

clear

▸ clear(): void

Clears all the items.

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection.ts:100

---

clearAndAdd

▸ clearAndAdd(target): boolean

Clears all the existing items and adds the given item.

Parameters

Name	Type	Description
target	ITEM	an item to be added

Returns

boolean

true if the selection is changed

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection.ts:108

---

clearAndAddAll

▸ clearAndAddAll(targets): boolean

Clears the existing items and add all the given items.

Parameters

Name	Type	Description
targets	ITEM[]	items to be added

Returns

boolean

true if the selection is changed

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection.ts:116

---

contains

▸ contains(target): boolean

Returns true if the given item is selected.

Parameters

Name	Type	Description
target	ITEM	an item to be checked

Returns

boolean

true if the given item is selected

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection.ts:124

---

each

▸ each(iteratee): void

Iterates over selected items.

Parameters

Name	Type	Description
iteratee	(item: ITEM) => boolean | void	an iteratee

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection.ts:145

---

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(index): null | ITEM

Returns an item at the given index or null.

Parameters

Name	Type	Description
index	number	an index

Returns

null | ITEM

an item at the given index or null

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection.ts:71

---

isEmpty

▸ isEmpty(): boolean

Returns true if the selection is empty.

Returns

boolean

true if the selection is empty

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection.ts:138

---

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

---

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

---

remove

▸ remove(target): boolean

Removes the given item.

Parameters

Name	Type	Description
target	ITEM	an item

Returns

boolean

true if succeeded

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection.ts:87

---

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

---

size

▸ size(): number

Returns the number of selected items.

Returns

number

the number of selected items

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection.ts:131

---

toArray

▸ toArray(): ITEM[]

Returns an array of selected items.

Returns

ITEM[]

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection.ts:150

---

toggle

▸ toggle(target): boolean

Toggles the given item.

Parameters

Name	Type	Description
target	ITEM	an item

Returns

boolean

true if succeeded.

Defined in

src/main/typescript/wcardinal/ui/d-list-data-selection.ts:95

Edit this page.