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

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

style

style: ChartStyle

Chart style

updates

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

Type declaration

- (elapsed, widget): void
- Parameters
  - elapsed: number
  - widget: Widget
  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
Returns WidgetRange
Inherited from Widget.range
- Defined in packages/core/src/widget.ts:376

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:353

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, during, params?): this
Parameters
- animation: Animation<any>
- startAt: number
- during: number
- Optional params: Record<string, any>
Returns this
Inherited from Widget.animate
- Defined in packages/core/src/widget.ts:196

animateTree

animateTree(tree, startAt): void
Parameters
- tree: AnimationTree
- startAt: number
Returns void
Inherited from Widget.animateTree
- Defined in packages/core/src/widget.ts:227

copy

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

draw

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

hide

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

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:107

isIn

isIn(x, y): boolean
Parameters
- x: number
- y: number
Returns boolean
Inherited from Widget.isIn
- Defined in packages/core/src/widget.ts:372

isIndexDate

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

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

on

on(event, effect): this
Parameters
- event: 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:214

predraw

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

preupdate

preupdate(ck, propertyChanged?): void
Called when the parameters is 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:130

processSetups

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

runAnimation

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

setEventListener

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

setUpdate

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

setup

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

show

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

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:139

use

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

`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:402

`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:380

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

setups

Type declaration

nextFrame: number

style

updates

Type declaration

Parameters

Returns void

value

x

y

Accessors

cross

Returns number

Parameters

Returns void

index

Returns number

Parameters

Returns void

range

Returns WidgetRange

weight

Returns number

Parameters

Returns void

Methods

_isAsyncWidget

Returns boolean

add

Parameters

Returns this

animate

Parameters

Returns this

animateTree

Parameters

Returns void

copy

Returns this

draw

Parameters

Returns void

hide

Returns this

indexDate

Returns DateTime<boolean>

indexDuration

Returns number

init

Parameters

Returns void

`Optional` intervalUnit

`Static` absoluteToRelative

Returns {
x: number;
y: number;
}

`Static` getAbsoluteCoordinates

Returns {
x: number;
y: number;
}