Class LineChart

Line chart widget.

Description

LineChart is a class that extends BaseSimpleChart and is used to create a line chart widget. In fact, LineChart can also be used to create a scatter chart and a bubble chart.

Hierarchy (view full)

BaseSimpleChart
- LineChart
  - ScatterChart
  - BubbleChart

Constructors

constructor

new LineChart(data, options?): LineChart
Create a LineChart.
Parameters
- data: LineChartData
  The data of the LineChart.
- Optional options: LineChartOptions
  The options of the LineChart.
Returns LineChart
Overrides BaseSimpleChart.constructor
- Defined in mods/mod-chart/src/widgets/lineChart.ts:167

Properties

animationInstances

animationInstances: AnimationInstance<Widget>[] = []

centerX

centerX: number

centerY

centerY: number

children

children: Widget[] = []

The child-widgets of the widget.

data

data: LineChartData

The data of the LineChart.

display

display: boolean = true

dotSets

dotSets: Circle[][]

The dot sets of the LineChart.

eventInstances

eventInstances: EventInstance<Widget>[] = []

fillPaint

fillPaint: Paint

hasSet

hasSet: boolean = false

isImplemented

isImplemented: boolean = false

key

key: string = ...

last

last: Widget = ...

layout

layout: ChartLayout

Layout object for the chart.

parent

parent: Widget

paths

paths: Path[]

The paths of the lines in the LineChart.

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

strokePaint

strokePaint: Paint

strokePaints

strokePaints: Paint[]

The stroke paints for the lines in the LineChart.

style

style: LineChartStyle

The style of the LineChart.

updates

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

Type declaration

- (elapsed, widget): void
- Parameters
  - elapsed: number
  - widget: Widget
  Returns void

x

x: number

y

y: number

Accessors

range

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

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

Methods

_isAsyncWidget

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

add

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

animate

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

animateTree

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

calculateRange

calculateRange(): WidgetRange
Returns WidgetRange
Overrides BaseSimpleChart.calculateRange
- Defined in mods/mod-chart/src/widgets/lineChart.ts:375

coordinateChildToParent

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

coordinateParentToChild

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

copy

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

draw

draw(canvas): void
Parameters
- canvas: Canvas
Returns void
Overrides BaseSimpleChart.draw
- Defined in mods/mod-chart/src/widgets/lineChart.ts:299

hide

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

init

init(ck): void
Parameters
- ck: CanvasKit
Returns void
Overrides BaseSimpleChart.init
- Defined in mods/mod-chart/src/widgets/lineChart.ts:234

isIn

isIn(x, y): boolean
Parameters
- x: number
- y: number
Returns boolean
Overrides BaseSimpleChart.isIn
- Defined in mods/mod-chart/src/widgets/lineChart.ts:370

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 BaseSimpleChart.on
- Defined in packages/core/src/widget.ts:215

predraw

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

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

processSetups

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

runAnimation

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

setEventListener

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

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 BaseSimpleChart.setUpdate
- Defined in packages/core/src/widget.ts:278

setup

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

show

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

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 BaseSimpleChart.update
- Defined in packages/core/src/widget.ts:140

use

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

`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 BaseSimpleChart.absoluteToRelative
- Defined in packages/core/src/widget.ts:459

`Static` getAbsoluteCoordinates

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

Class LineChart

Description

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns LineChart

Properties

animationInstances

centerX

centerY

children

data

display

dotSets

eventInstances

fillPaint

hasSet

isImplemented

key

last

layout

parent

paths

plugins

progress

setups

Type declaration

nextFrame: number

strokePaint

strokePaints

style

updates

Type declaration

Parameters

Returns void

x

y

Accessors

range

Returns WidgetRange

Methods

_isAsyncWidget

Returns boolean

add

Parameters

Returns this

animate

Parameters

Returns this

animateTree

Parameters

Returns void

calculateRange

Returns WidgetRange

coordinateChildToParent

Parameters

Returns { x: number; y: number; }

x: number

y: number

coordinateParentToChild

Parameters

Returns { x: number; y: number; }

x: number

y: number

copy

Returns this

draw

Parameters

Returns void

hide

Returns this

init

Parameters

Returns void

Returns {
x: number;
y: number;
}

Returns {
x: number;
y: number;
}

`Static` absoluteToRelative

Returns {
x: number;
y: number;
}

`Static` getAbsoluteCoordinates

Returns {
x: number;
y: number;
}