Winter Cardinal UI - v0.457.0 / DChartSeriesLine

Class: DChartSeriesLine<CHART>

A series represents a polyline. Data points must be sorted in ascending order on the X axis.

Type parameters

Name	Type
CHART	extends DBase = DBase

Hierarchy

• DChartSeriesBase<CHART>

  ↳ DChartSeriesLine

Table of contents

Constructors

• constructor

Properties

• _centerX
• _centerY
• _container
• _coordinate
• _domain
• _index
• _isShown
• _line
• _options
• _pointId
• _pointIdUpdated
• _points
• _range
• _regionPointId
• _state
• _stroke
• WORK

Accessors

• container
• coordinate
• domain
• index
• points
• range
• shape
• state

Methods

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

Constructors

constructor

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

Type parameters

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

Parameters

Name	Type
options?	DChartSeriesLineOptions

Returns

DChartSeriesLine<CHART>

Overrides

DChartSeriesBase.constructor

Defined in

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

Properties

_centerX

• Protected _centerX: number

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line.ts:41

---

_centerY

• Protected _centerY: number

Defined in

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

---

_container

• Protected Optional _container: DChartSeriesContainer<CHART>

Inherited from

DChartSeriesBase._container

Defined in

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

---

_coordinate

• Protected _coordinate: DChartSeriesBaseCoordinateContainer<CHART>

Inherited from

DChartSeriesBase._coordinate

Defined in

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

---

_domain

• Protected _domain: DChartRegionImpl

Inherited from

DChartSeriesBase._domain

Defined in

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

---

_index

• Protected _index: number

Inherited from

DChartSeriesBase._index

Defined in

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

---

_isShown

• Protected _isShown: boolean

Inherited from

DChartSeriesBase._isShown

Defined in

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

---

_line

• Protected _line: null | EShapeLine

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line.ts:35

---

_options

• Protected Optional _options: DChartSeriesLineOptions

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line.ts:36

---

_pointId

• Protected _pointId: number

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line.ts:38

---

_pointIdUpdated

• Protected _pointIdUpdated: number

Defined in

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

---

_points

• Protected _points: (null | number)[]

Defined in

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

---

_range

• Protected _range: DChartRegionImpl

Inherited from

DChartSeriesBase._range

Defined in

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

---

_regionPointId

• Protected _regionPointId: number

Inherited from

DChartSeriesBase._regionPointId

Defined in

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

---

_state

• Protected _state: DBaseStateSet

Inherited from

DChartSeriesBase._state

Defined in

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

---

_stroke

• Protected Optional _stroke: DChartSeriesStrokeComputed

Defined in

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

---

WORK

▪ Static Protected WORK: Point

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line.ts:34

Accessors

container

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

Returns

null | DChartSeriesContainer<CHART>

Inherited from

DChartSeriesBase.container

Defined in

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

---

coordinate

• get coordinate(): DChartSeriesCoordinateContainer<CHART>

Returns

DChartSeriesCoordinateContainer<CHART>

Inherited from

DChartSeriesBase.coordinate

Defined in

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

---

domain

• get domain(): DChartRegionImmutable

Returns

DChartRegionImmutable

Inherited from

DChartSeriesBase.domain

Defined in

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

---

index

• get index(): number

Returns

number

Inherited from

DChartSeriesBase.index

Defined in

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

---

points

• get points(): (null | number)[]

Returns

(null | number)[]

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line.ts:84

• set points(points): void

Parameters

Name	Type
points	(null | number)[]

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line.ts:88

---

range

• get range(): DChartRegionImmutable

Returns

DChartRegionImmutable

Inherited from

DChartSeriesBase.range

Defined in

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

---

shape

• get shape(): null | EShapeLine

Returns

null | EShapeLine

Overrides

DChartSeriesBase.shape

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line.ts:80

---

state

• get state(): DBaseStateSet

Returns

DBaseStateSet

Inherited from

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

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

Overrides

DChartSeriesBase.bind

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line.ts:55

---

calcHitPoint

▸ calcHitPoint(x, y, result): boolean

Parameters

Name	Type
x	number
y	number
result	DChartSeriesHitResult

Returns

boolean

Overrides

DChartSeriesBase.calcHitPoint

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line.ts:289

---

calcHitPointHitTester

▸ calcHitPointHitTester(this, x, y, p0x, p0y, p1x, p1y, index, threshold, result): boolean

Parameters

Name	Type
this	unknown
x	number
y	number
p0x	number
p0y	number
p1x	number
p1y	number
index	number
threshold	number
result	DChartSeriesHitResult

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line.ts:326

---

calcHitPointTestRange

▸ calcHitPointTestRange(this, x, y, threshold, values, result): [number, number]

Parameters

Name	Type
this	unknown
x	number
y	number
threshold	number
values	number[]
result	[number, number]

Returns

[number, number]

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line.ts:312

---

destroy

▸ destroy(): this

Returns

this

Overrides

DChartSeriesBase.destroy

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line.ts:263

---

doUpdate

▸ doUpdate(render): boolean

Parameters

Name	Type
render	boolean

Returns

boolean

Defined in

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

---

doUpdateLine

▸ doUpdateLine(line, xcoordinate, ycoordinate, isPointsDirty): void

Parameters

Name	Type
line	EShapeLine
xcoordinate	DChartCoordinate<CHART>
ycoordinate	DChartCoordinate<CHART>
isPointsDirty	boolean

Returns

void

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line.ts:140

---

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

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

DChartSeriesBase.eventNames

Defined in

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

---

hide

▸ hide(): this

Returns

this

Inherited from

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

Overrides

DChartSeriesBase.hitTest

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line.ts:278

---

isHidden

▸ isHidden(): boolean

Returns

boolean

Inherited from

DChartSeriesBase.isHidden

Defined in

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

---

isShown

▸ isShown(): boolean

Returns

boolean

Inherited from

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

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

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

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

DChartSeriesBase.on

Defined in

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

---

onHide

▸ onHide(): void

Returns

void

Inherited from

DChartSeriesBase.onHide

Defined in

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

---

onRender

▸ onRender(): this

Returns

this

Overrides

DChartSeriesBase.onRender

Defined in

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

---

onShow

▸ onShow(): void

Returns

void

Inherited from

DChartSeriesBase.onShow

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

Inherited from

DChartSeriesBase.onStateChange

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

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

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

DChartSeriesBase.removeListener

Defined in

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

---

show

▸ show(): this

Returns

this

Inherited from

DChartSeriesBase.show

Defined in

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

---

toDirty

▸ toDirty(): this

Returns

this

Overrides

DChartSeriesBase.toDirty

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line.ts:93

---

toThreshold

▸ toThreshold(this, strokeWidth, strokeScale): number

Parameters

Name	Type
this	unknown
strokeWidth	number
strokeScale	number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line.ts:308

---

unbind

▸ unbind(): this

Returns

this

Overrides

DChartSeriesBase.unbind

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line.ts:71

---

update

▸ update(): this

Returns

this

Overrides

DChartSeriesBase.update

Defined in

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

---

updateRegion

▸ updateRegion(): void

Returns

void

Overrides

DChartSeriesBase.updateRegion

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line.ts:238

Edit this page.