Class ChartDataUnit<ChartStyle>

ChartDataUnit

Type Parameters

ChartStyle
Chart style type (which may differ depending on the chart type)

Hierarchy (view full)

Widget
- ChartDataUnit

Constructors

constructor

new ChartDataUnit<ChartStyle>(value, options?): ChartDataUnit<ChartStyle>
ChartDataUnit constructor
Type Parameters
- ChartStyle
Parameters
- value: number | ChartData
  Value
- Optional options: ChartDataOptions<ChartStyle>
  Options
Returns ChartDataUnit<ChartStyle>
Overrides Widget.constructor
- Defined in mods/mod-chart/src/widgets/chartDataUnit.ts:73

Properties

animationInstances

animationInstances: AnimationInstance<Widget>[] = []

centerX

centerX: number

centerY

centerY: number

children

children: Widget[] = []

The child-widgets of the widget.

display

display: boolean = true

eventInstances

eventInstances: EventInstance<Widget>[] = []

hasSet

hasSet: boolean = false

`Optional` intervalUnit

intervalUnit?: DateTimeUnit

Interval unit

isImplemented

isImplemented: boolean = false

key

key: string = ...

last

last: Widget = ...

parent

parent: Widget

plugins

plugins: WidgetPlugin[] = []

progress

progress: number

registeredEvents

registeredEvents: Map<string, Event<Widget>> = ...

setups

setups: {
    generator: Generator<number | {
        animation: Animation<any>;
        duration: number;
        mode: "async" | "sync";
        params: Record<string, any>;
        setAsync: (() => { animation: Animation<any>; mode: "async" | "sync"; duration: number; params: Record<string, any>; setAsync: () => ...; setSync: () => ...; });
        setSync: (() => { animation: Animation<any>; mode: "async" | "sync"; duration: number; params: Record<string, any>; setAsync: () => ...; setSync: () => ...; });
    }, void, unknown>;
    nextFrame: number;
}[] = []

Type declaration

generator: Generator<number | {
    animation: Animation<any>;
    duration: number;
    mode: "async" | "sync";
    params: Record<string, any>;
    setAsync: (() => { animation: Animation<any>; mode: "async" | "sync"; duration: number; params: Record<string, any>; setAsync: () => ...; setSync: () => ...; });
    setSync: (() => { animation: Animation<any>; mode: "async" | "sync"; duration: number; params: Record<string, any>; setAsync: () => ...; setSync: () => ...; });
}, void, unknown>
nextFrame: number

status

status: Status = 'unborn'

style

style: ChartStyle

Chart style

updates

updates: (<T>(elapsed, widget) => void)[] = []

Type declaration

- <T>(elapsed, widget): void
- Type Parameters
  - T extends ChartDataUnit<ChartStyle>
  Parameters
  - elapsed: number
  - widget: T
  Returns void

value

value: number | ChartData

Value

x

x: number

y

y: number

Accessors

cross

get cross(): number
Cross value

Returns number
- Defined in mods/mod-chart/src/widgets/chartDataUnit.ts:128
set cross(cross): void
Set cross value
Parameters
- cross: number
Returns void
- Defined in mods/mod-chart/src/widgets/chartDataUnit.ts:151

index

get index(): number
Index value

Returns number
- Defined in mods/mod-chart/src/widgets/chartDataUnit.ts:85
set index(index): void
Set index value
Parameters
- index: number | DateTime<boolean>
Returns void
- Defined in mods/mod-chart/src/widgets/chartDataUnit.ts:143

range

get range(): WidgetRange
The range of the widget, taking into account the children, based on the parent coordinate. To be noted that this method should not be overridden.

Returns WidgetRange
The range of the widget.
Inherited from Widget.range
- Defined in packages/core/src/widget.ts:455

singleRange

get singleRange(): WidgetRange
The range of the widget, taking into account the children, based on the parent coordinate. To be noted that this method should not be overridden.

Returns WidgetRange
The range of the widget.
Inherited from Widget.singleRange
- Defined in packages/core/src/widget.ts:485

weight

get weight(): number
Weight value

Returns number
- Defined in mods/mod-chart/src/widgets/chartDataUnit.ts:135
set weight(weight): void
Set weight value
Parameters
- weight: number
Returns void
- Defined in mods/mod-chart/src/widgets/chartDataUnit.ts:159

Methods

_isAsyncWidget

_isAsyncWidget(): boolean
Returns boolean
Inherited from Widget._isAsyncWidget
- Defined in packages/core/src/widget.ts:401

add

add(...children): this
Add children widgets for the widget.
Parameters
- Rest ...children: Widget[] | ((parent) => Widget)[]
  The added children.
Returns this
Inherited from Widget.add
- Defined in packages/core/src/widget.ts:156

animate

animate(animation, startAt, duration, params?): this
Parameters
- animation: Animation<any>
- startAt: number
- duration: number
- Optional params: Record<string, any>
Returns this
Inherited from Widget.animate
- Defined in packages/core/src/widget.ts:197

calculateIn

calculateIn(_x, _y): boolean
Calculate the range of the widget, based on the self-coordinate. To be noted that this method should be overridden.
Parameters
- _x: number
- _y: number
Returns boolean
Inherited from Widget.calculateIn
- Defined in packages/core/src/widget.ts:425

calculateRange

calculateRange(): WidgetRange
Calculate the range of the widget, based on the self-coordinate. To be noted that this method should be overridden.

Returns WidgetRange
The range of the widget.
Inherited from Widget.calculateRange
- Defined in packages/core/src/widget.ts:446

coordinateChildToParent

coordinateChildToParent(x, y): {
x: number;
y: number;
}
Parameters
- x: number
- y: number
Returns {
x: number;
y: number;
}
- x: number
- y: number
Inherited from Widget.coordinateChildToParent
- Defined in packages/core/src/widget.ts:520

coordinateParentToChild

coordinateParentToChild(x, y): {
x: number;
y: number;
}
Parameters
- x: number
- y: number
Returns {
x: number;
y: number;
}
- x: number
- y: number
Inherited from Widget.coordinateParentToChild
- Defined in packages/core/src/widget.ts:504

copy

copy(): this
Returns this
Inherited from Widget.copy
- Defined in packages/core/src/widget.ts:415

draw

draw(_canvas): void
Draw the object according to the parameters of the widget. Called when the parameters are changed.
Parameters
- _canvas: Canvas
  The canvas object of CanvasKit-WASM.
Returns void
Inherited from Widget.draw
- Defined in packages/core/src/widget.ts:119

emitEvent

emitEvent(name, ...args): this
Parameters
- name: string
- Rest ...args: any[]
Returns this
Inherited from Widget.emitEvent
- Defined in packages/core/src/widget.ts:225

hide

hide(): this
Returns this
Inherited from Widget.hide
- Defined in packages/core/src/widget.ts:410

indexDate

indexDate(): DateTime<boolean>
returns the index value as a DateTime

Returns DateTime<boolean>
- Defined in mods/mod-chart/src/widgets/chartDataUnit.ts:105

indexDuration

indexDuration(): number
returns the index duration value as a number

Returns number
- Defined in mods/mod-chart/src/widgets/chartDataUnit.ts:112

init

init(_ck): void
Called when the widget is registered.
Parameters
- _ck: CanvasKit
  The CanvasKit namespace
Returns void
Inherited from Widget.init
- Defined in packages/core/src/widget.ts:102

isIn

isIn(x, y): boolean
Determine whether the point is in the widget, based on the parent coordinate. To be noted that this method should not be overridden.
Parameters
- x: number
- y: number
Returns boolean
Inherited from Widget.isIn
- Defined in packages/core/src/widget.ts:435

isIndexDate

isIndexDate(): boolean
returns whether the index value is a DateTime

Returns boolean
- Defined in mods/mod-chart/src/widgets/chartDataUnit.ts:121

kill

kill(): this
Returns this
Inherited from Widget.kill
- Defined in packages/core/src/widget.ts:572

on

on(event, effect): this
Parameters
- event: string | Event<Widget>
- effect: ((widget, ...args) => any)
  - - (widget, ...args): any
    - Parameters
      widget: Widget
      Rest ...args: any[]
      Returns any
Returns this
Inherited from Widget.on
- Defined in packages/core/src/widget.ts:237

predraw

predraw(_ck, _propertyChanged): void
Preload the necessary items duration drawing. Called when the properties changed. In common, we use it to initializing Paint, Rect, Path, etc.
Parameters
- _ck: CanvasKit
  The namespace of CanvasKit-WASM.
- _propertyChanged: string
  The changed property of this widget
Returns void
Inherited from Widget.predraw
- Defined in packages/core/src/widget.ts:112

preupdate

preupdate(ck, propertyChanged?): void
Called when the parameters are changed.
Parameters
- ck: CanvasKit
  The namespace of CanvasKit-WASM.
- Optional propertyChanged: string
Returns void
Inherited from Widget.preupdate
- Defined in packages/core/src/widget.ts:126

processSetups

processSetups(elapsed): void
Parameters
- elapsed: number
Returns void
Inherited from Widget.processSetups
- Defined in packages/core/src/widget.ts:365

registerEvent

registerEvent(name): this
Parameters
- name: string
Returns this
Inherited from Widget.registerEvent
- Defined in packages/core/src/widget.ts:215

resurrect

resurrect(): this
Returns this
Inherited from Widget.resurrect
- Defined in packages/core/src/widget.ts:578

runAnimation

runAnimation(elapsed, ck): void
Parameters
- elapsed: number
- ck: CanvasKit
Returns void
Inherited from Widget.runAnimation
- Defined in packages/core/src/widget.ts:258

setEventListener

setEventListener(element): void
Parameters
- element: HTMLCanvasElement
Returns void
Inherited from Widget.setEventListener
- Defined in packages/core/src/widget.ts:326

setUpdate

setUpdate(updateFunc): this
Set up an update function to call it when the widget is changed.
Parameters
- updateFunc: (<T>(elapsed, widget) => void)
  The frame from having gone to current frame.
  - - <T>(elapsed, widget): void
    - Type Parameters
      T extends ChartDataUnit<ChartStyle>
      Parameters
      elapsed: number
      widget: T
      Returns void
Returns this
Inherited from Widget.setUpdate
- Defined in packages/core/src/widget.ts:338

setup

setup<T>(setupFunc): this
Type Parameters
- T extends ChartDataUnit<ChartStyle>
Parameters
- setupFunc: SetupFunction<T>
Returns this
Inherited from Widget.setup
- Defined in packages/core/src/widget.ts:344

show

show(): this
Returns this
Inherited from Widget.show
- Defined in packages/core/src/widget.ts:405

update

update(canvas): void
Update the object according to the style of the widget. Called when the style is changed.
Parameters
- canvas: Canvas
  The canvas object of CanvasKit-WASM.
Returns void
Inherited from Widget.update
- Defined in packages/core/src/widget.ts:135

use

use(...plugins): void
Parameters
- Rest ...plugins: WidgetPlugin[]
Returns void
Inherited from Widget.use
- Defined in packages/core/src/widget.ts:397

`Static` absoluteToRelative

absoluteToRelative(widget, x, y): {
x: number;
y: number;
}
Parameters
- widget: Widget
- x: number
- y: number
Returns {
x: number;
y: number;
}
- x: number
- y: number
Inherited from Widget.absoluteToRelative
- Defined in packages/core/src/widget.ts:555

`Static` getAbsoluteCoordinates

getAbsoluteCoordinates(widget): {
x: number;
y: number;
}
Parameters
- widget: Widget
Returns {
x: number;
y: number;
}
- x: number
- y: number
Inherited from Widget.getAbsoluteCoordinates
- Defined in packages/core/src/widget.ts:533

Class ChartDataUnit<ChartStyle>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns ChartDataUnit<ChartStyle>

Properties

animationInstances

centerX

centerY

children

display

eventInstances

hasSet

Optional intervalUnit

isImplemented

key

last

parent

plugins

progress

registeredEvents

setups

Type declaration

nextFrame: number

status

style

updates

Type declaration

Type Parameters

Parameters

Returns void

value

x

y

Accessors

cross

Returns number

Parameters

Returns void

index

Returns number

Parameters

Returns void

range

Returns WidgetRange

singleRange

Returns WidgetRange

weight

Returns number

Parameters

Returns void

Methods

_isAsyncWidget

Returns boolean

add

Parameters

Returns this

animate

Parameters

Returns this

calculateIn

Parameters

Returns boolean

calculateRange

Returns WidgetRange

coordinateChildToParent

Parameters

Returns { x: number; y: number; }

x: number

y: number

coordinateParentToChild

Parameters

`Optional` intervalUnit

Returns {
x: number;
y: number;
}

Returns {
x: number;
y: number;
}