Class Widget

Hierarchy (view full)

Widget
- AsyncWidget

Constructors

constructor

new Widget(options?): Widget
Parameters
- Optional options: WidgetOptions
Returns Widget
- Defined in widget.ts:71

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

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

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.
- Defined in widget.ts:391

Methods

_isAsyncWidget

_isAsyncWidget(): boolean
Returns boolean
- Defined in widget.ts:354

add

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

animateTree

animateTree(tree, startAt): void
Parameters
- tree: AnimationTree
- startAt: number
Returns void
- Defined in widget.ts:228

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.
- Defined in widget.ts:382

coordinateChildToParent

coordinateChildToParent(x, y): {
x: number;
y: number;
}
Parameters
- x: number
- y: number
Returns {
x: number;
y: number;
}
- x: number
- y: number
- Defined in 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
- Defined in widget.ts:408

copy

copy(): this
Returns this
- Defined in widget.ts:368

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
- Defined in widget.ts:124

hide

hide(): this
Returns this
- Defined in widget.ts:363

init

init(_ck): void
Called when the widget is registered.
Parameters
- _ck: CanvasKit
  The CanvasKit namespace
Returns void
- Defined in widget.ts:107

isIn

isIn(x, y): boolean
Parameters
- x: number
- y: number
Returns boolean
- Defined in widget.ts:372

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
- Defined in widget.ts:215

predraw

predraw(_ck, _propertyChanged): void
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
  The namespace of CanvasKit-WASM.
- _propertyChanged: string
  The changed property of this widget
Returns void
- Defined in widget.ts:117

preupdate

preupdate(ck, propertyChanged?): void
Called when the parameters is changed.
Parameters
- ck: CanvasKit
  The namespace of CanvasKit-WASM.
- Optional propertyChanged: string
Returns void
- Defined in widget.ts:131

processSetups

processSetups(elapsed): void
Parameters
- elapsed: number
Returns void
- Defined in widget.ts:318

runAnimation

runAnimation(elapsed): void
Parameters
- elapsed: number
Returns void
- Defined in widget.ts:233

setEventListener

setEventListener(element): void
Parameters
- element: HTMLCanvasElement
Returns void
- Defined in 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
- Defined in widget.ts:278

setup

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

show

show(): this
Returns this
- Defined in 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
- Defined in widget.ts:140

use

use(...plugins): void
Parameters
- Rest ...plugins: WidgetPlugin[]
Returns void
- Defined in 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
- Defined in widget.ts:459

`Static` getAbsoluteCoordinates

getAbsoluteCoordinates(widget): {
x: number;
y: number;
}
Parameters
- widget: Widget
Returns {
x: number;
y: number;
}
- x: number
- y: number
- Defined in widget.ts:437

Class Widget

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Widget

Properties

animationInstances

centerX

centerY

children

display

eventInstances

hasSet

isImplemented

key

last

parent

plugins

progress

setups

Type declaration

nextFrame: number

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

isIn

Parameters

Returns boolean

on

Parameters

Parameters

Returns any

Returns this

Returns {
x: number;
y: number;
}

Returns {
x: number;
y: number;
}

`Static` absoluteToRelative

Returns {
x: number;
y: number;
}

`Static` getAbsoluteCoordinates

Returns {
x: number;
y: number;
}