Class Widget

constructor

• new Widget(options?): Widget

• Parameters

  • Optional options: WidgetOptions

  Returns Widget

animationInstances

centerX

centerY

children

display

eventInstances

hasSet

isImplemented

key

last

parent

plugins

progress

registeredEvents

setups

status

style

updates

x

y

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.

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.

_isAsyncWidget

• _isAsyncWidget(): boolean

• Returns boolean

add

• add(...children): this

• Add children widgets for the widget.

  Parameters

  • Rest ...children: Widget[] | ((parent) => Widget)[]

    The added children.

  Returns this

animate

• animate(animation, startAt, duration, params?): this

• Parameters

  • animation: Animation<any>
  • startAt: number
  • duration: number
  • Optional params: Record<string, any>

  Returns this

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

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.

coordinateChildToParent

• coordinateChildToParent(x, y): {
      x: number;
      y: number;
  }

• Parameters

  • x: number
  • y: number

  Returns {
      x: number;
      y: number;
  }

  • x: number

  • y: number

coordinateParentToChild

• coordinateParentToChild(x, y): {
      x: number;
      y: number;
  }

• Parameters

  • x: number
  • y: number

  Returns {
      x: number;
      y: number;
  }

  • x: number

  • y: number

copy

• copy(): this

• Returns this

draw

• draw(_canvas): void

• Draw the object according to the parameters of the widget. Called when the parameters are changed.

  Parameters

  • _canvas: Canvas

    The canvas object of CanvasKit-WASM.

  Returns void

emitEvent

• emitEvent(name, ...args): this

• Parameters

  • name: string
  • Rest ...args: any[]

  Returns this

hide

• hide(): this

• Returns this

init

• init(_ck): void

• Called when the widget is registered.

  Parameters

  • _ck: CanvasKit

    The CanvasKit namespace

  Returns void

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

kill

• kill(): this

• Returns this

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

predraw

• predraw(_ck, _propertyChanged): void

• Preload the necessary items duration drawing. Called when the properties 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

preupdate

• preupdate(ck, propertyChanged?): void

• Called when the parameters are changed.

  Parameters

  • ck: CanvasKit

    The namespace of CanvasKit-WASM.
  • Optional propertyChanged: string

  Returns void

processSetups

• processSetups(elapsed): void

• Parameters

  • elapsed: number

  Returns void

registerEvent

• registerEvent(name): this

• Parameters

  • name: string

  Returns this

resurrect

• resurrect(): this

• Returns this

runAnimation

• runAnimation(elapsed, ck): void

• Parameters

  • elapsed: number
  • ck: CanvasKit

  Returns void

setEventListener

• setEventListener(element): void

• Parameters

  • element: HTMLCanvasElement

  Returns void

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 Widget

        Parameters

        • elapsed: number
        • widget: T

        Returns void

  Returns this

setup

• setup<T>(setupFunc): this

• Type Parameters

  • T extends Widget

  Parameters

  • setupFunc: SetupFunction<T>

  Returns this

show

• show(): this

• Returns this

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

use

• use(...plugins): void

• Parameters

  • Rest ...plugins: WidgetPlugin[]

  Returns void

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

Static getAbsoluteCoordinates

• getAbsoluteCoordinates(widget): {
      x: number;
      y: number;
  }

• Parameters

  • widget: Widget

  Returns {
      x: number;
      y: number;
  }

  • x: number

  • y: number