Class AsyncWidget

See

Widget

Hierarchy (view full)

Widget
- AsyncWidget

Constructors

constructor

new AsyncWidget(options?): AsyncWidget
Parameters
- Optional options: WidgetOptions
Returns AsyncWidget
Overrides Widget.constructor
- Defined in asyncWidget.ts:15

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

hasSet

hasSet: boolean = false

isImplemented

isImplemented: boolean = false

key

key: string = ...

last

last: Widget = ...

parent

parent: Widget

plugins

plugins: WidgetPlugin[] = []

progress

progress: number

ready

ready: boolean = false

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

style

style: WidgetStyle = ...

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
Overrides Widget._isAsyncWidget
- Defined in asyncWidget.ts:47

add

add(...children): this
Add children widgets for the widget.
Parameters
- Rest ...children: Widget[]
  The added children.
Returns this
Inherited from Widget.add
- Defined in 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 Widget.animate
- Defined in widget.ts:153

animateTree

animateTree(tree, startAt): void
Parameters
- tree: AnimationTree
- startAt: number
Returns void
Inherited from Widget.animateTree
- Defined in widget.ts:184

copy

copy(): this
Returns this
Inherited from Widget.copy
- Defined in widget.ts:298

draw

draw(_canvas): void
Draw the object according to the parameters of the widget. Called when the parameters is changed.
Parameters
- _canvas: Canvas
  The canvas object of CanvasKit-WASM.
Returns void
Inherited from Widget.draw
- Defined in widget.ts:112

hide

hide(): this
Returns this
Inherited from Widget.hide
- Defined in widget.ts:293

init

init(_ck): Promise<AsyncWidgetResponse>
Called when the widget is registered.
Parameters
- _ck: CanvasKit
  The CanvasKit namespace
Returns Promise<AsyncWidgetResponse>
Overrides Widget.init
- Defined in asyncWidget.ts:19

isIn

isIn(x, y): boolean
Parameters
- x: number
- y: number
Returns boolean
Inherited from Widget.isIn
- Defined in 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 Widget.on
- Defined in widget.ts:171

predraw

predraw(_ck, _propertyChanged): Promise<AsyncWidgetResponse>
Preload the necessary items during drawing. Called when the properties of the widget is changed. In common, we use it to initializing Paint, Rect, Path, etc.
Parameters
- _ck: CanvasKit
- _propertyChanged: string
Returns Promise<AsyncWidgetResponse>
Overrides Widget.predraw
- Defined in asyncWidget.ts:25

preupdate

preupdate(ck, propertyChanged?): Promise<AsyncWidgetResponse>
Called when the parameters is changed.
Parameters
- ck: CanvasKit
  The namespace of CanvasKit-WASM.
- Optional propertyChanged: string
Returns Promise<AsyncWidgetResponse>
Overrides Widget.preupdate
- Defined in asyncWidget.ts:34

processSetups

processSetups(elapsed): void
Parameters
- elapsed: number
Returns void
Inherited from Widget.processSetups
- Defined in widget.ts:259

runAnimation

runAnimation(elapsed): void
Parameters
- elapsed: number
Returns void
Inherited from Widget.runAnimation
- Defined in widget.ts:188

setEventListener

setEventListener(element): void
Parameters
- element: HTMLCanvasElement
Returns void
Inherited from Widget.setEventListener
- Defined in 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 Widget.setUpdate
- Defined in widget.ts:231

setup

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

show

show(): this
Returns this
Inherited from Widget.show
- Defined in 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 Widget.update
- Defined in widget.ts:127

use

use(...plugins): void
Parameters
- Rest ...plugins: WidgetPlugin[]
Returns void
Inherited from Widget.use
- Defined in 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 Widget.absoluteToRelative
- Defined in 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 Widget.getAbsoluteCoordinates
- Defined in widget.ts:307

Class AsyncWidget

See

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns AsyncWidget

Properties

animationInstances

centerX

centerY

children

display

eventInstances

hasSet

isImplemented

key

last

parent

plugins

progress

ready

setups

Type declaration

nextFrame: number

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 Promise<AsyncWidgetResponse>

isIn

Parameters

Returns boolean

on

Parameters

Parameters

Returns any

Returns this

predraw

Parameters

Returns Promise<AsyncWidgetResponse>

preupdate

Parameters

Returns Promise<AsyncWidgetResponse>

processSetups

Parameters

Returns void

runAnimation

Parameters

Returns void

setEventListener

Parameters

`Static` absoluteToRelative

Returns {
x: number;
y: number;
}

`Static` getAbsoluteCoordinates

Returns {
x: number;
y: number;
}