Winter Cardinal UI - v0.442.0 / DChartSelectionSub

Interface: DChartSelectionSub<CHART>

Type parameters

Name	Type
CHART	extends DBase = DBase

Hierarchy

• EventEmitter

  ↳ DChartSelectionSub

Implemented by

• DChartSelectionSubImpl

Table of contents

Properties

• position
• series
• visible

Methods

• addListener
• bind
• emit
• eventNames
• listenerCount
• listeners
• off
• on
• once
• removeAllListeners
• removeListener
• set
• unbind
• unset
• update

Properties

position

• Readonly position: Point

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-sub.ts:31

---

series

• Readonly series: null | DChartSeries<CHART>

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-sub.ts:30

---

visible

• Readonly visible: boolean

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-sub.ts:29

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

---

bind

▸ bind(container): void

Parameters

Name	Type
container	DChartSeriesContainer<CHART>

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-sub.ts:33

---

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

---

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

---

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(x, y): void

Sets a series to null and set a position to the given global position.

Parameters

Name	Type	Description
x	number	a global X position
y	number	a global Y position

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-sub.ts:42

▸ set(series, result): void

Sets a series and a position.

Parameters

Name	Type	Description
series	DChartSeries<CHART>	a series to be set
result	DChartSeriesHitResult	a hit result

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-sub.ts:50

---

unbind

▸ unbind(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-sub.ts:34

---

unset

▸ unset(): void

Clear a series and a position.

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-sub.ts:55

---

update

▸ update(): boolean

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-sub.ts:56

Edit this page.