Winter Cardinal UI - v0.457.0 / DChartSeriesBase

Class: DChartSeriesBase<CHART>

A series represents a polyline.

Type parameters

Name	Type
CHART	extends DBase = DBase

Hierarchy

• EventEmitter

  ↳ DChartSeriesBase

  ↳↳ DChartSeriesLineOfAny

  ↳↳ DChartSeriesLine

  ↳↳ DChartSeriesLinear

Implements

• DChartSeries<CHART>

Table of contents

Constructors

• constructor

Properties

• _container
• _coordinate
• _domain
• _index
• _isShown
• _range
• _regionPointId
• _state
• shape

Accessors

• container
• coordinate
• domain
• index
• range
• state

Methods

• addListener
• bind
• calcHitPoint
• destroy
• emit
• eventNames
• hide
• hitTest
• isHidden
• isShown
• listenerCount
• listeners
• off
• on
• onHide
• onRender
• onShow
• onStateChange
• once
• removeAllListeners
• removeListener
• show
• toDirty
• unbind
• update
• updateRegion

Constructors

constructor

• new DChartSeriesBase<CHART>(options?): DChartSeriesBase<CHART>

Type parameters

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

Parameters

Name	Type
options?	DChartSeriesBaseOptions<any>

Returns

DChartSeriesBase<CHART>

Overrides

utils.EventEmitter.constructor

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:51

Properties

_container

• Protected Optional _container: DChartSeriesContainer<CHART>

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:39

---

_coordinate

• Protected _coordinate: DChartSeriesBaseCoordinateContainer<CHART>

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:37

---

_domain

• Protected _domain: DChartRegionImpl

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:42

---

_index

• Protected _index: number

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:40

---

_isShown

• Protected _isShown: boolean

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:47

---

_range

• Protected _range: DChartRegionImpl

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:43

---

_regionPointId

• Protected _regionPointId: number

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:44

---

_state

• Protected _state: DBaseStateSet

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:46

---

shape

• Readonly Abstract shape: null | EShape

Implementation of

DChartSeries.shape

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:49

Accessors

container

• get container(): null | DChartSeriesContainer<CHART>

Returns

null | DChartSeriesContainer<CHART>

Implementation of

DChartSeries.container

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:108

---

coordinate

• get coordinate(): DChartSeriesCoordinateContainer<CHART>

Returns

DChartSeriesCoordinateContainer<CHART>

Implementation of

DChartSeries.coordinate

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:116

---

domain

• get domain(): DChartRegionImmutable

Returns

DChartRegionImmutable

Implementation of

DChartSeries.domain

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:98

---

index

• get index(): number

Returns

number

Implementation of

DChartSeries.index

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:112

---

range

• get range(): DChartRegionImmutable

Returns

DChartRegionImmutable

Implementation of

DChartSeries.range

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:103

---

state

• get state(): DBaseStateSet

Returns

DBaseStateSet

Implementation of

DChartSeries.state

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:120

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, index): this

Parameters

Name	Type
container	DChartSeriesContainer<CHART>
index	number

Returns

this

Implementation of

DChartSeries.bind

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:77

---

calcHitPoint

▸ calcHitPoint(x, y, result): boolean

Parameters

Name	Type
x	number
y	number
result	DChartSeriesHitResult

Returns

boolean

Implementation of

DChartSeries.calcHitPoint

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:174

---

destroy

▸ destroy(): this

Returns

this

Implementation of

DChartSeries.destroy

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:164

---

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

---

hide

▸ hide(): this

Returns

this

Implementation of

DChartSeries.hide

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:143

---

hitTest

▸ hitTest(x, y): boolean

Parameters

Name	Type
x	number
y	number

Returns

boolean

Implementation of

DChartSeries.hitTest

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:170

---

isHidden

▸ isHidden(): boolean

Returns

boolean

Implementation of

DChartSeries.isHidden

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:158

---

isShown

▸ isShown(): boolean

Returns

boolean

Implementation of

DChartSeries.isShown

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:139

---

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

---

onHide

▸ onHide(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:151

---

onRender

▸ onRender(): this

Returns

this

Implementation of

DChartSeries.onRender

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:96

---

onShow

▸ onShow(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:132

---

onStateChange

▸ onStateChange(newState, oldState): void

Parameters

Name	Type
newState	DBaseStateSet
oldState	DBaseStateSet

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:178

---

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

---

show

▸ show(): this

Returns

this

Implementation of

DChartSeries.show

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:124

---

toDirty

▸ toDirty(): this

Returns

this

Implementation of

DChartSeries.toDirty

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:94

---

unbind

▸ unbind(): this

Returns

this

Implementation of

DChartSeries.unbind

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:89

---

update

▸ update(): this

Returns

this

Implementation of

DChartSeries.update

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:95

---

updateRegion

▸ updateRegion(): void

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-base.ts:162

Edit this page.