Class ScatterChart

ScatterChart

Description

The ScatterChart is a variation of the LineChart that displays individual data points. In fact, the ScatterChart is a LineChart with the showLine option set to false and the animateIndex option set to true when the index type is a number.

Hierarchy (view full)

LineChart
- ScatterChart

Constructors

constructor

new ScatterChart(data, options?): ScatterChart
Parameters
- data: ScatterChartData
- Optional options: ScatterChartOptions
Returns ScatterChart
Overrides LineChart.constructor
- Defined in mods/mod-chart/src/widgets/scatterChart.ts:55

Properties

animationInstances

animationInstances: AnimationInstance<Widget>[] = []

centerX

centerX: number

centerY

centerY: number

children

children: Widget[] = []

The child-widgets of the widget.

data

data: ScatterChartData

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

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

Methods

_isAsyncWidget

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

add

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

animate

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

animateTree

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

copy

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

draw

draw(canvas): void
Parameters
- canvas: Canvas
Returns void
Inherited from LineChart.draw
- Defined in mods/mod-chart/src/widgets/lineChart.ts:298

hide

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

init

init(ck): void
Parameters
- ck: CanvasKit
Returns void
Inherited from LineChart.init
- Defined in mods/mod-chart/src/widgets/lineChart.ts:233

isIn

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

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

predraw

predraw(ck, propertyChanged): void
Parameters
- ck: CanvasKit
- propertyChanged: string
Returns void
Inherited from LineChart.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 LineChart.preupdate
- Defined in packages/core/src/widget.ts:118

processSetups

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

runAnimation

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

setEventListener

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

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

setup

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

show

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

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

use

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

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

`Static` getAbsoluteCoordinates

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

Class ScatterChart

Description

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ScatterChart

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

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

init

Parameters

Returns void

isIn

Parameters

Returns boolean

on

Parameters

Parameters

Returns any

Returns this

predraw

Parameters

Returns void

preupdate

Parameters

Returns void

processSetups

Parameters

`Static` absoluteToRelative

Returns {
x: number;
y: number;
}

`Static` getAbsoluteCoordinates

Returns {
x: number;
y: number;
}