Winter Cardinal UI - v0.442.0 / DChartSelectionSimple

Class: DChartSelectionSimple<CHART>

Type parameters

Name Type
CHART extends DBase = DBase

Hierarchy

Implements

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new DChartSelectionSimple<CHART>(options?): DChartSelectionSimple<CHART>

Type parameters

Name Type
CHART extends DBase<DThemeBase, DBaseOptions<DThemeBase, any>> = DBase<DThemeBase, DBaseOptions<DThemeBase, any>>

Parameters

Name Type
options? DChartSelectionSimpleOptions<CHART, any>

Returns

DChartSelectionSimple<CHART>

Overrides

utils.EventEmitter.constructor

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:83

Properties

_container

Protected _container: null | DChartSeriesContainer<CHART>

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:74


_dismiss

Protected _dismiss: DChartSelectionSimpleDismiss

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:77


_hovered

Protected _hovered: DChartSelectionSub<CHART>

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:76


_onLongPressBound

Protected _onLongPressBound: (target: unknown, e: InteractionEvent) => void

Type declaration

▸ (target, e): void

Parameters
Name Type
target unknown
e InteractionEvent
Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:81


_onMoveBound

Protected _onMoveBound: (e: InteractionEvent) => void

Type declaration

▸ (e): void

Parameters
Name Type
e InteractionEvent
Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:79


_onTapBound

Protected _onTapBound: (target: unknown, e: InteractionEvent) => void

Type declaration

▸ (target, e): void

Parameters
Name Type
target unknown
e InteractionEvent
Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:80


_selected

Protected _selected: DChartSelectionSub<CHART>

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:75


WORK_SELECT

Static Protected WORK_SELECT: DChartSeriesHitResult

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:72

Accessors

hovered

get hovered(): DChartSelectionSub<CHART>

Returns

DChartSelectionSub<CHART>

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:327


selected

get selected(): DChartSelectionSub<CHART>

Returns

DChartSelectionSub<CHART>

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:323

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

DChartSelection.addListener

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

Implementation of

DChartSelection.bind

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:297


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

DChartSelection.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

DChartSelection.eventNames

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

Implementation of

DChartSelection.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

DChartSelection.listeners

Inherited from

utils.EventEmitter.listeners

Defined in

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


newHovered

newHovered(point, options?): DChartSelectionSub<CHART>

Parameters

Name Type
point DChartSelectionPoint
options? DChartSelectionSubOptions<CHART, any>

Returns

DChartSelectionSub<CHART>

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:167


newSelected

newSelected(point, options?): DChartSelectionSub<CHART>

Parameters

Name Type
point DChartSelectionPoint
options? DChartSelectionSubOptions<CHART, any>

Returns

DChartSelectionSub<CHART>

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:160


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

DChartSelection.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

DChartSelection.on

Inherited from

utils.EventEmitter.on

Defined in

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


onLongPress

onLongPress(e): void

Parameters

Name Type
e InteractionEvent

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:262


onMove

onMove(e): void

Parameters

Name Type
e InteractionEvent

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:273


onRender

onRender(): void

Returns

void

Implementation of

DChartSelection.onRender

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:342


onTap

onTap(e): void

Parameters

Name Type
e InteractionEvent

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:233


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

DChartSelection.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

DChartSelection.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

DChartSelection.removeListener

Inherited from

utils.EventEmitter.removeListener

Defined in

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


toDismiss

toDismiss(options?): DChartSelectionSimpleDismiss

Parameters

Name Type
options? DChartSelectionSimpleOptions<CHART, any>

Returns

DChartSelectionSimpleDismiss

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:113


toDismissLongPress

toDismissLongPress(options?): DChartSelectionSimpleDismissLongPress

Parameters

Name Type
options? DChartSelectionSimpleDismissLongPressOptions

Returns

DChartSelectionSimpleDismissLongPress

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:144


toDismissNoSeries

toDismissNoSeries(options?): DChartSelectionSimpleDismissNoSeries

Parameters

Name Type
options? DChartSelectionSimpleDismissNoSeriesOptions

Returns

DChartSelectionSimpleDismissNoSeries

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:152


toDismissTap

toDismissTap(options?): DChartSelectionSimpleDismissTap

Parameters

Name Type
options? DChartSelectionSimpleDismissTapOptions

Returns

DChartSelectionSimpleDismissTap

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:135


toHoveredOptions

toHoveredOptions(point, options?): DChartSelectionSubOptions<CHART, any>

Parameters

Name Type
point DChartSelectionPoint
options? DChartSelectionSubOptions<CHART, any>

Returns

DChartSelectionSubOptions<CHART, any>

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:181


toSelectedOptions

toSelectedOptions(point, options?): DChartSelectionSubOptions<CHART, any>

Parameters

Name Type
point DChartSelectionPoint
options? DChartSelectionSubOptions<CHART, any>

Returns

DChartSelectionSubOptions<CHART, any>

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:174


toSubOptions

toSubOptions(point, options, state): DChartSelectionSubOptions<CHART, any>

Parameters

Name Type
point DChartSelectionPoint
options undefined | DChartSelectionSubOptions<CHART, any>
state string

Returns

DChartSelectionSubOptions<CHART, any>

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:188


unbind

unbind(): void

Returns

void

Implementation of

DChartSelection.unbind

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:308


update

update(): void

Returns

void

Implementation of

DChartSelection.update

Defined in

src/main/typescript/wcardinal/ui/d-chart-selection-simple.ts:331