Class ChartLayout

Chart Layout

Description

Chart layout widget. It provides the layout for the chart. It includes the axis, the grid, and the legend. It should not be used directly. It is used by the chart widgets.

Hierarchy

BaseChart
- ChartLayout

Constructors

constructor

new ChartLayout(data, options?): ChartLayout
Create a chart layout.
Parameters
- data: BaseChartData
  The data of the chart.
- Optional options: ChartLayoutOptions
  The options of the chart.
Returns ChartLayout
Overrides BaseChart.constructor
- Defined in mods/mod-chart/src/widgets/chartLayout.ts:218

Properties

animationInstances

animationInstances: AnimationInstance<Widget>[] = []

centerX

centerX: number

centerY

centerY: number

children

children: Widget[] = []

The child-widgets of the widget.

cross

cross: ChartAxis

The cross-axis of the chart.

data

data: BaseChartData

The data of the chart.

`Optional` dateFormatOptions

dateFormatOptions?: DateTimeFormatOptions

The date format options of the index-axis.

Description

BaseChartOptions#dateFormatOptions

display

display: boolean = true

edgeOffset

edgeOffset: boolean

Whether the grid aligns with the edge.

Default

false

Description

Whether the grid aligns with the edge.

eventInstances

eventInstances: EventInstance<Widget>[] = []

fillPaint

fillPaint: Paint

gridAlign

gridAlign: boolean

Whether the grid aligns with the index-axis.

Default

true

Description

Whether the grid aligns with the index-axis.

hasSet

hasSet: boolean = false

index

index: ChartAxis

The index-axis of the chart.

indexAxis

indexAxis: "x" | "y"

The index-axis of the chart.

Default

'x'

Description

The index-axis of the chart.

`Optional` indexIntervalUnit

indexIntervalUnit?: DateTimeUnit

The interval unit of the index-axis.

Description

BaseChartOptions#indexIntervalUnit

indexType

indexType: "number" | "label" | "date"

The type of the index-axis.

Default

'label'

Description

BaseChartOptions#indexType

isImplemented

isImplemented: boolean = false

key

key: string = ...

last

last: Widget = ...

legendLabels

legendLabels: Text[]

The legend labels of the chart.

legends

legends: Rect[]

The legends of the chart.

paint

paint: Paint

The paint of the chart layout.

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

size

size: {
height: number;
width: number;
}

The size of the chart layout.

Type declaration

height: number
The height of the chart layout.
Default
```
300
```
Description
The height of the chart layout. To be noted that the height is the height of chart layout (excluding label, legend, etc.).
width: number
The width of the chart layout.
Default
```
300
```
Description
The width of the chart layout. To be noted that the width is the width of chart layout (excluding label, legend, etc.).

Default

{ width: 300, height: 300 }

Description

The size of the chart layout.

status

status: Status = 'unborn'

strokePaint

strokePaint: Paint

style

style: ChartLayoutStyle

The style of the chart layout.

updates

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

Type declaration

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

x

x: number

y

y: number

Accessors

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 BaseChart.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 BaseChart.singleRange
- Defined in packages/core/src/widget.ts:485

Methods

_isAsyncWidget

_isAsyncWidget(): boolean
Returns boolean
Inherited from BaseChart._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 BaseChart.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 BaseChart.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 BaseChart.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 BaseChart.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 BaseChart.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 BaseChart.coordinateParentToChild
- Defined in packages/core/src/widget.ts:504

copy

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

draw

draw(_canvas): void
Parameters
- _canvas: Canvas
Returns void
Overrides BaseChart.draw
- Defined in mods/mod-chart/src/widgets/chartLayout.ts:630

emitEvent

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

`Private` generateAxisRange

generateAxisRange(axis, data): void
Private
Generate the axis range and the positions of the axis labels.
Parameters
- axis: ChartAxis
  The axis.
- data: number[]
  The data.
Returns void
- Defined in mods/mod-chart/src/widgets/chartLayout.ts:650

`Private` generateDateAxisRange

generateDateAxisRange(axis, data): void
Parameters
- axis: ChartAxis
- data: DateTime<boolean>[]
Returns void
- Defined in mods/mod-chart/src/widgets/chartLayout.ts:667

hide

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

init

init(_ck): void
Parameters
- _ck: CanvasKit
Returns void
Overrides BaseChart.init
- Defined in mods/mod-chart/src/widgets/chartLayout.ts:626

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 BaseChart.isIn
- Defined in packages/core/src/widget.ts:435

kill

kill(): this
Returns this
Inherited from BaseChart.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 BaseChart.on
- Defined in packages/core/src/widget.ts:237

predraw

predraw(ck, propertyChanged): void
Parameters
- ck: CanvasKit
- propertyChanged: string
Returns void
Inherited from BaseChart.predraw
- Defined in packages/basic/src/widgets/figures/figure.ts:56

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 BaseChart.preupdate
- Defined in packages/core/src/widget.ts:126

processSetups

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

registerEvent

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

`Private` relayLegends

relayLegends(): void
Returns void
- Defined in mods/mod-chart/src/widgets/chartLayout.ts:709

resurrect

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

runAnimation

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

setEventListener

setEventListener(element): void
Parameters
- element: HTMLCanvasElement
Returns void
Inherited from BaseChart.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 ChartLayout
      Parameters
      elapsed: number
      widget: T
      Returns void
Returns this
Inherited from BaseChart.setUpdate
- Defined in packages/core/src/widget.ts:338

setup

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

show

show(): this
Returns this
Inherited from BaseChart.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 BaseChart.update
- Defined in packages/core/src/widget.ts:135

use

use(...plugins): void
Parameters
- Rest ...plugins: WidgetPlugin[]
Returns void
Inherited from BaseChart.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 BaseChart.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 BaseChart.getAbsoluteCoordinates
- Defined in packages/core/src/widget.ts:533

Class ChartLayout

Description

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ChartLayout

Properties

animationInstances

centerX

centerY

children

cross

data

Optional dateFormatOptions

Description

display

edgeOffset

Default

Description

eventInstances

fillPaint

gridAlign

Default

Description

hasSet

index

indexAxis

Default

Description

Optional indexIntervalUnit

Description

indexType

Default

Description

isImplemented

key

last

legendLabels

legends

paint

parent

plugins

progress

registeredEvents

setups

Type declaration

nextFrame: number

size

Type declaration

height: number

Default

Description

width: number

Default

Description

Default

Description

status

strokePaint

style

updates

Type declaration

Type Parameters

Parameters

Returns void

x

y

Accessors

range

Returns WidgetRange

singleRange

Returns WidgetRange

Methods

_isAsyncWidget

`Optional` dateFormatOptions

`Optional` indexIntervalUnit

Returns {
x: number;
y: number;
}

Returns {
x: number;
y: number;
}

`Private` generateAxisRange

`Private` generateDateAxisRange

`Private` relayLegends