Class Dot

Represents an arc figure, a subclass of the Figure class.

Hierarchy (view full)

Circle
- Dot

Constructors

constructor

new Dot(options?): Dot
Parameters
- Optional options: FigureOptions
Returns Dot
Overrides Circle.constructor
- Defined in mods/mod-geometry/src/widgets/dot.ts:5

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>[] = []

fillPaint

fillPaint: Paint

from

from: number

The starting angle of the arc in radians.

hasSet

hasSet: boolean = false

isImplemented

isImplemented: boolean = false

key

key: string = ...

last

last: Widget = ...

parent

parent: Widget

path

path: Path

pathData

pathData: ([0, string] | [1, Path, Path, any] | [2, Path, Path, number])[] = []

plugins

plugins: WidgetPlugin[] = []

progress

progress: number

radius

radius: number

The radius of the arc.

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

style

style: FigureStyle

to

to: number

The ending angle of the arc in radians.

updates

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

Type declaration

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

Methods

_isAsyncWidget

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

addFromPathInterpolation

addFromPathInterpolation(start, end, weight): Dot
Parameters
- start: Path
- end: Path
- weight: number
Returns Dot
Inherited from Circle.addFromPathInterpolation
- Defined in packages/basic/src/widgets/figures/path.ts:130

addPathFromOptions

addPathFromOptions(one, two, options): Dot
Parameters
- one: Path
- two: Path
- options: any
Returns Dot
Inherited from Circle.addPathFromOptions
- Defined in packages/basic/src/widgets/figures/path.ts:124

addPathFromSVGString

addPathFromSVGString(svg): Dot
Parameters
- svg: string
Returns Dot
Inherited from Circle.addPathFromSVGString
- Defined in packages/basic/src/widgets/figures/path.ts:118

animate

animate(animation, startAt, duration, params?): this
Parameters
- animation: Animation<any>
- startAt: number
- duration: number
- Optional params: Record<string, any>
Returns this
Inherited from Circle.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 Circle.calculateIn
- Defined in packages/basic/src/widgets/figures/path.ts:144

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 Circle.calculateRange
- Defined in packages/basic/src/widgets/figures/path.ts:148

coordinateChildToParent

coordinateChildToParent(x, y): {
x: number;
y: number;
}
Parameters
- x: number
- y: number
Returns {
x: number;
y: number;
}
- x: number
- y: number
Inherited from Circle.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 Circle.coordinateParentToChild
- Defined in packages/core/src/widget.ts:504

copy

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

draw

draw(canvas): void
Draws the arc figure on the canvas.
Parameters
- canvas: Canvas
  The canvas to draw on.
Returns void
Inherited from Circle.draw
- Defined in packages/basic/src/widgets/figures/arc.ts:70

emitEvent

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

hide

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

init

init(ck): void
Initializes the arc figure.
Parameters
- ck: CanvasKit
  The CanvasKit instance.
Returns void
Inherited from Circle.init
- Defined in packages/basic/src/widgets/figures/arc.ts:38

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

kill

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

predraw

predraw(ck, propertyChanged?): void
Updates the arc figure based on property changes.
Parameters
- ck: CanvasKit
  The CanvasKit instance.
- Optional propertyChanged: string
  The name of the property that changed.
Returns void
Inherited from Circle.predraw
- Defined in packages/basic/src/widgets/figures/arc.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 Circle.preupdate
- Defined in packages/core/src/widget.ts:126

processSetups

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

registerEvent

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

resurrect

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

runAnimation

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

setEventListener

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

setup

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

show

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

use

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

Class Dot

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Dot

Properties

animationInstances

centerX

centerY

children

display

eventInstances

fillPaint

from

hasSet

isImplemented

key

last

parent

path

pathData

plugins

progress

radius

registeredEvents

setups

Type declaration

nextFrame: number

status

strokePaint

style

to

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

addFromPathInterpolation

Parameters

Returns Dot

addPathFromOptions

Parameters

Returns Dot

addPathFromSVGString

Parameters

Returns Dot

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

Returns {
x: number;
y: number;
}

`Static` absoluteToRelative

Returns {
x: number;
y: number;
}