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

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'

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: (<T>(elapsed, widget) => void)[] = []

Type declaration

- <T>(elapsed, widget): void
- Type Parameters
  - T extends ScatterChart
  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 LineChart.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 LineChart.singleRange
- Defined in packages/core/src/widget.ts:485

Methods

_isAsyncWidget

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

calculateIn

calculateIn(x, y): boolean
Parameters
- x: number
- y: number
Returns boolean
Inherited from LineChart.calculateIn
- Defined in mods/mod-chart/src/widgets/lineChart.ts:371

calculateRange

calculateRange(): WidgetRange
Returns WidgetRange
Inherited from LineChart.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 LineChart.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 LineChart.coordinateParentToChild
- Defined in packages/core/src/widget.ts:504

copy

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

draw

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

emitEvent

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

hide

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

init

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

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

kill

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

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

processSetups

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

registerEvent

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

resurrect

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

runAnimation

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

setEventListener

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

setup

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

show

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

use

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

Class ScatterChart

Description

Hierarchy (view full)

Index

Constructors

Properties

Accessors

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

registeredEvents

setups

Type declaration

nextFrame: number

status

strokePaint

strokePaints

style

updates

Type declaration

Type Parameters

Parameters

Returns void

x

y

Accessors

range

Returns WidgetRange

singleRange

Returns WidgetRange

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

Returns { x: number; y: number; }

x: number

y: number

copy

Returns this

draw

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;
}