Class Rect

Hierarchy (view full)

Path
- Rect

Constructors

constructor

new Rect(from, to, options?): Rect
Parameters
- from: Vector2
- to: Vector2
- Optional options: RectOptions
Returns Rect
Overrides Path.constructor
- Defined in basic/src/widgets/figures/rect.ts:31

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: Vector2

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, number, number, number, number, number, number, number] = ...

rect

rect: Float32Array

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

strokePaint

strokePaint: Paint

style

style: RectStyle

to

to: Vector2

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, based on the parent coordinate. To be noted that this method should not be overridden.

Returns WidgetRange
The range of the widget.
Inherited from Path.range
- Defined in core/src/widget.ts:409

Methods

_isAsyncWidget

_isAsyncWidget(): boolean
Returns boolean
Inherited from Path._isAsyncWidget
- Defined in core/src/widget.ts:356

add

add(...children): this
Add children widgets for the widget.
Parameters
- Rest ...children: Widget[] | ((parent) => Widget)[]
  The added children.
Returns this
Inherited from Path.add
- Defined in core/src/widget.ts:157

addFromPathInterpolation

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

addPathFromOptions

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

addPathFromSVGString

addPathFromSVGString(svg): Rect
Parameters
- svg: string
Returns Rect
Inherited from Path.addPathFromSVGString
- Defined in basic/src/widgets/figures/path.ts:127

animate

animate(animation, startAt, during, params?): this
Parameters
- animation: Animation<any>
- startAt: number
- during: number
- Optional params: Record<string, any>
Returns this
Inherited from Path.animate
- Defined in core/src/widget.ts:197

animateTree

animateTree(tree, startAt): void
Parameters
- tree: AnimationTree
- startAt: number
Returns void
Inherited from Path.animateTree
- Defined in core/src/widget.ts:228

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 Path.calculateIn
- Defined in basic/src/widgets/figures/path.ts:153

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

coordinateChildToParent

coordinateChildToParent(x, y): {
x: number;
y: number;
}
Parameters
- x: number
- y: number
Returns {
x: number;
y: number;
}
- x: number
- y: number
Inherited from Path.coordinateChildToParent
- Defined in core/src/widget.ts:442

coordinateParentToChild

coordinateParentToChild(x, y): {
x: number;
y: number;
}
Parameters
- x: number
- y: number
Returns {
x: number;
y: number;
}
- x: number
- y: number
Inherited from Path.coordinateParentToChild
- Defined in core/src/widget.ts:426

copy

copy(): this
Returns this
Inherited from Path.copy
- Defined in core/src/widget.ts:370

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
Overrides Path.draw
- Defined in basic/src/widgets/figures/rect.ts:53

hide

hide(): this
Returns this
Inherited from Path.hide
- Defined in core/src/widget.ts:365

init

init(ck): void
Called when the widget is registered.
Parameters
- ck: CanvasKit
  The CanvasKit namespace
Returns void
Overrides Path.init
- Defined in basic/src/widgets/figures/rect.ts:39

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 Path.isIn
- Defined in core/src/widget.ts:390

mapRadius

mapRadius(): void
Returns void
- Defined in basic/src/widgets/figures/rect.ts:79

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 Path.on
- Defined in core/src/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
Overrides Path.predraw
- Defined in basic/src/widgets/figures/rect.ts:69

preupdate

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

processSetups

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

runAnimation

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

setEventListener

setEventListener(element): void
Parameters
- element: HTMLCanvasElement
Returns void
Inherited from Path.setEventListener
- Defined in core/src/widget.ts:268

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 Path.setUpdate
- Defined in core/src/widget.ts:280

setup

setup<T>(setupFunc): this
Type Parameters
- T extends Widget
Parameters
- setupFunc: SetupFunction<T>
Returns this
Inherited from Path.setup
- Defined in core/src/widget.ts:286

show

show(): this
Returns this
Inherited from Path.show
- Defined in core/src/widget.ts:360

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 Path.update
- Defined in core/src/widget.ts:140

use

use(...plugins): void
Parameters
- Rest ...plugins: WidgetPlugin[]
Returns void
Inherited from Path.use
- Defined in core/src/widget.ts:352

`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 Path.absoluteToRelative
- Defined in core/src/widget.ts:477

`Static` getAbsoluteCoordinates

getAbsoluteCoordinates(widget): {
x: number;
y: number;
}
Parameters
- widget: Widget
Returns {
x: number;
y: number;
}
- x: number
- y: number
Inherited from Path.getAbsoluteCoordinates
- Defined in core/src/widget.ts:455

Class Rect

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Rect

Properties

animationInstances

centerX

centerY

children

display

eventInstances

fillPaint

from

hasSet

isImplemented

key

last

parent

path

pathData

plugins

progress

radius

rect

setups

Type declaration

nextFrame: number

strokePaint

style

to

updates

Type declaration

Parameters

Returns void

x

y

Accessors

range

Returns WidgetRange

Methods

_isAsyncWidget

Returns boolean

add

Parameters

Returns this

addFromPathInterpolation

Parameters

Returns Rect

addPathFromOptions

Parameters

Returns Rect

addPathFromSVGString

Parameters

Returns Rect

animate

Parameters

Returns this

animateTree

Parameters

Returns void

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

Returns {
x: number;
y: number;
}

`Static` absoluteToRelative

Returns {
x: number;
y: number;
}

`Static` getAbsoluteCoordinates

Returns {
x: number;
y: number;
}