Winter Cardinal UI - v0.442.0 / DChartSeriesBar

Class: DChartSeriesBar<CHART>

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

Type parameters

Name	Type
CHART	extends DBase = DBase

Hierarchy

• DChartSeriesLineOfAny<CHART>

  ↳ DChartSeriesBar

Table of contents

Constructors

• constructor

Properties

• _barCount
• _barIndex
• _container
• _coordinate
• _domain
• _fill
• _index
• _isShown
• _isSizeAutomatic
• _line
• _offset
• _options
• _padding
• _pointId
• _pointIdUpdated
• _points
• _range
• _regionPointId
• _size
• _state
• _stroke
• _xcoordinateId
• _xcoordinateTransformId
• WORK
• WORK_REGION

Accessors

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

Methods

• addListener
• adjustLineRegion
• applyLine
• bind
• calcHitPoint
• calcHitPointHitTester
• calcHitPointTestRange
• calcRegion
• calcSizeX
• destroy
• doUpdate
• doUpdateLine
• emit
• eventNames
• getOffsetDefault
• getSizeDefault
• hide
• hitTest
• initLine
• isHidden
• isShown
• listenerCount
• listeners
• newLineOfAny
• off
• on
• onHide
• onRender
• onShow
• onStateChange
• once
• removeAllListeners
• removeListener
• show
• toDirty
• unbind
• update
• updateBarCountAndIndex
• updateRegion

Constructors

constructor

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

Type parameters

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

Parameters

Name	Type
options?	DChartSeriesBarOptions

Returns

DChartSeriesBar<CHART>

Overrides

DChartSeriesLineOfAny.constructor

Defined in

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

Properties

_barCount

• Protected _barCount: number

Defined in

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

---

_barIndex

• Protected _barIndex: number

Defined in

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

---

_container

• Protected Optional _container: DChartSeriesContainer<CHART>

Inherited from

DChartSeriesLineOfAny._container

Defined in

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

---

_coordinate

• Protected _coordinate: DChartSeriesBaseCoordinateContainer<CHART>

Inherited from

DChartSeriesLineOfAny._coordinate

Defined in

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

---

_domain

• Protected _domain: DChartRegionImpl

Inherited from

DChartSeriesLineOfAny._domain

Defined in

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

---

_fill

• Protected Optional _fill: DChartSeriesFillComputed

Inherited from

DChartSeriesLineOfAny._fill

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:68

---

_index

• Protected _index: number

Inherited from

DChartSeriesLineOfAny._index

Defined in

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

---

_isShown

• Protected _isShown: boolean

Inherited from

DChartSeriesLineOfAny._isShown

Defined in

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

---

_isSizeAutomatic

• Protected _isSizeAutomatic: boolean

Defined in

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

---

_line

• Protected _line: null | EShapeLineOfAny

Inherited from

DChartSeriesLineOfAny._line

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:61

---

_offset

• Protected Optional _offset: DChartSeriesPointComputed

Inherited from

DChartSeriesLineOfAny._offset

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:70

---

_options

• Protected Optional _options: DChartSeriesLineOfAnyOptions

Inherited from

DChartSeriesLineOfAny._options

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:62

---

_padding

• Protected Optional _padding: DChartSeriesPaddingComputed

Defined in

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

---

_pointId

• Protected _pointId: number

Inherited from

DChartSeriesLineOfAny._pointId

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:64

---

_pointIdUpdated

• Protected _pointIdUpdated: number

Inherited from

DChartSeriesLineOfAny._pointIdUpdated

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:65

---

_points

• Protected _points: (null | number)[]

Inherited from

DChartSeriesLineOfAny._points

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:63

---

_range

• Protected _range: DChartRegionImpl

Inherited from

DChartSeriesLineOfAny._range

Defined in

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

---

_regionPointId

• Protected _regionPointId: number

Inherited from

DChartSeriesLineOfAny._regionPointId

Defined in

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

---

_size

• Protected Optional _size: DChartSeriesPointComputed

Inherited from

DChartSeriesLineOfAny._size

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:69

---

_state

• Protected _state: DBaseStateSet

Inherited from

DChartSeriesLineOfAny._state

Defined in

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

---

_stroke

• Protected Optional _stroke: DChartSeriesStrokeComputed

Inherited from

DChartSeriesLineOfAny._stroke

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:67

---

_xcoordinateId

• Protected _xcoordinateId: number

Defined in

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

---

_xcoordinateTransformId

• Protected _xcoordinateTransformId: number

Defined in

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

---

WORK

▪ Static Protected WORK: Point

Inherited from

DChartSeriesLineOfAny.WORK

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:58

---

WORK_REGION

▪ Static Protected Optional WORK_REGION: DChartSeriesLineOfAnyRegion

Inherited from

DChartSeriesLineOfAny.WORK_REGION

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:59

Accessors

container

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

Returns

null | DChartSeriesContainer<CHART>

Inherited from

DChartSeriesLineOfAny.container

Defined in

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

---

coordinate

• get coordinate(): DChartSeriesCoordinateContainer<CHART>

Returns

DChartSeriesCoordinateContainer<CHART>

Inherited from

DChartSeriesLineOfAny.coordinate

Defined in

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

---

domain

• get domain(): DChartRegionImmutable

Returns

DChartRegionImmutable

Inherited from

DChartSeriesLineOfAny.domain

Defined in

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

---

index

• get index(): number

Returns

number

Inherited from

DChartSeriesLineOfAny.index

Defined in

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

---

points

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

Returns

(null | number)[]

Inherited from

DChartSeriesLineOfAny.points

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:148

• set points(points): void

Parameters

Name	Type
points	(null | number)[]

Returns

void

Inherited from

DChartSeriesLineOfAny.points

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:152

---

range

• get range(): DChartRegionImmutable

Returns

DChartRegionImmutable

Inherited from

DChartSeriesLineOfAny.range

Defined in

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

---

shape

• get shape(): null | EShapeLineOfAny

Returns

null | EShapeLineOfAny

Inherited from

DChartSeriesLineOfAny.shape

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:144

---

state

• get state(): DBaseStateSet

Returns

DBaseStateSet

Inherited from

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

DChartSeriesLineOfAny.addListener

Defined in

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

---

adjustLineRegion

▸ adjustLineRegion(xmin, xmax, ymin, ymax, result): DChartSeriesLineOfAnyRegion

Parameters

Name	Type
xmin	number
xmax	number
ymin	number
ymax	number
result	DChartSeriesLineOfAnyRegion

Returns

DChartSeriesLineOfAnyRegion

Overrides

DChartSeriesLineOfAny.adjustLineRegion

Defined in

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

---

applyLine

▸ applyLine(line, xcoordinate, ycoordinate, sx, sy, cx, cy, values): void

Parameters

Name	Type
line	EShapeLineOfAny
xcoordinate	DChartCoordinate<CHART>
ycoordinate	DChartCoordinate<CHART>
sx	number
sy	number
cx	number
cy	number
values	number[]

Returns

void

Overrides

DChartSeriesLineOfAny.applyLine

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-bar.ts:111

---

bind

▸ bind(container, index): this

Parameters

Name	Type
container	DChartSeriesContainer<CHART>
index	number

Returns

this

Overrides

DChartSeriesLineOfAny.bind

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-bar.ts:50

---

calcHitPoint

▸ calcHitPoint(x, y, result): boolean

Parameters

Name	Type
x	number
y	number
result	DChartSeriesHitResult

Returns

boolean

Inherited from

DChartSeriesLineOfAny.calcHitPoint

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:364

---

calcHitPointHitTester

▸ calcHitPointHitTester(this, x, y, ax, ay, ox, oy, px, py, sw, ss, sa, index, threshold, result): boolean

Parameters

Name	Type
this	unknown
x	number
y	number
ax	number
ay	number
ox	number
oy	number
px	number
py	number
sw	number
ss	number
sa	number
index	number
threshold	number
result	DChartSeriesHitResult

Returns

boolean

Inherited from

DChartSeriesLineOfAny.calcHitPointHitTester

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:408

---

calcHitPointTestRange

▸ calcHitPointTestRange(this, x, y, ax, ay, ox, oy, threshold, values, result): [number, number]

Parameters

Name	Type
this	unknown
x	number
y	number
ax	number
ay	number
ox	number
oy	number
threshold	number
values	number[]
result	[number, number]

Returns

[number, number]

Inherited from

DChartSeriesLineOfAny.calcHitPointTestRange

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:383

---

calcRegion

▸ calcRegion(points, domain, range): void

Parameters

Name	Type
points	(null | number)[]
domain	DChartRegion
range	DChartRegion

Returns

void

Overrides

DChartSeriesLineOfAny.calcRegion

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-bar.ts:223

---

calcSizeX

▸ calcSizeX(def): number

Parameters

Name	Type
def	number

Returns

number

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-bar.ts:206

---

destroy

▸ destroy(): this

Returns

this

Inherited from

DChartSeriesLineOfAny.destroy

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:338

---

doUpdate

▸ doUpdate(render): boolean

Parameters

Name	Type
render	boolean

Returns

boolean

Inherited from

DChartSeriesLineOfAny.doUpdate

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:172

---

doUpdateLine

▸ doUpdateLine(line, xcoordinate, ycoordinate): void

Parameters

Name	Type
line	EShapeLineOfAny
xcoordinate	DChartCoordinate<CHART>
ycoordinate	DChartCoordinate<CHART>

Returns

void

Inherited from

DChartSeriesLineOfAny.doUpdateLine

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:199

---

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

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

DChartSeriesLineOfAny.eventNames

Defined in

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

---

getOffsetDefault

▸ getOffsetDefault(): number

Returns

number

Inherited from

DChartSeriesLineOfAny.getOffsetDefault

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:85

---

getSizeDefault

▸ getSizeDefault(): number

Returns

number

Overrides

DChartSeriesLineOfAny.getSizeDefault

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-bar.ts:73

---

hide

▸ hide(): this

Returns

this

Inherited from

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

Inherited from

DChartSeriesLineOfAny.hitTest

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:353

---

initLine

▸ initLine(line, options, container, index): void

Parameters

Name	Type
line	EShapeLineOfAny
options	undefined | DChartSeriesLineOfAnyOptions
container	DChartSeriesContainer<CHART>
index	number

Returns

void

Overrides

DChartSeriesLineOfAny.initLine

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-bar.ts:59

---

isHidden

▸ isHidden(): boolean

Returns

boolean

Inherited from

DChartSeriesLineOfAny.isHidden

Defined in

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

---

isShown

▸ isShown(): boolean

Returns

boolean

Inherited from

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

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

DChartSeriesLineOfAny.listeners

Defined in

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

---

newLineOfAny

▸ newLineOfAny(): EShapeLineOfAny

Returns

EShapeLineOfAny

Overrides

DChartSeriesLineOfAny.newLineOfAny

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-bar.ts:69

---

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

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

DChartSeriesLineOfAny.on

Defined in

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

---

onHide

▸ onHide(): void

Returns

void

Inherited from

DChartSeriesLineOfAny.onHide

Defined in

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

---

onRender

▸ onRender(): this

Returns

this

Inherited from

DChartSeriesLineOfAny.onRender

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:167

---

onShow

▸ onShow(): void

Returns

void

Inherited from

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

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

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

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

DChartSeriesLineOfAny.removeListener

Defined in

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

---

show

▸ show(): this

Returns

this

Inherited from

DChartSeriesLineOfAny.show

Defined in

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

---

toDirty

▸ toDirty(): this

Returns

this

Inherited from

DChartSeriesLineOfAny.toDirty

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:157

---

unbind

▸ unbind(): this

Returns

this

Inherited from

DChartSeriesLineOfAny.unbind

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:135

---

update

▸ update(): this

Returns

this

Inherited from

DChartSeriesLineOfAny.update

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-line-of-any.ts:162

---

updateBarCountAndIndex

▸ updateBarCountAndIndex(): boolean

Returns

boolean

Defined in

src/main/typescript/wcardinal/ui/d-chart-series-bar.ts:87

---

updateRegion

▸ updateRegion(): void

Returns

void

Inherited from

DChartSeriesLineOfAny.updateRegion

Defined in

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

Edit this page.