Class Arrow

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

Hierarchy (view full)

Figure
- Arrow

Constructors

constructor

new Arrow(from, to, options?): Arrow
Constructs a new Arrow instance.
Parameters
- from: Vector2
  The starting point of the arrow.
- to: Vector2
  The ending point of the arrow.
- Optional options: ArrowOptions
  Optional configuration options for the arrow.
Returns Arrow
Overrides Figure.constructor
- Defined in basic/src/widgets/figures/arrow.ts:65

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

The starting point of the arrow.

hasSet

hasSet: boolean = false

isImplemented

isImplemented: boolean = false

key

key: string = ...

last

last: Widget = ...

parent

parent: Widget

plugins

plugins: WidgetPlugin[] = []

progress

progress: number

radian

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

strokePaint

strokePaint: Paint

The ending point of the arrow.

`Private` trim

trim: Line

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.
Inherited from Figure.range
- Defined in core/src/widget.ts:391

Methods

_isAsyncWidget

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

add

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

animateTree

animateTree(tree, startAt): void
Parameters
- tree: AnimationTree
- startAt: number
Returns void
Inherited from Figure.animateTree
- Defined in core/src/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.
Inherited from Figure.calculateRange
- Defined in core/src/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
Inherited from Figure.coordinateChildToParent
- Defined in core/src/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
Inherited from Figure.coordinateParentToChild
- Defined in core/src/widget.ts:408

copy

copy(): this
Returns this
Inherited from Figure.copy
- Defined in core/src/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
Inherited from Figure.draw
- Defined in core/src/widget.ts:124

hide

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

init

init(_ck): void
Called when the widget is registered.
Parameters
- _ck: CanvasKit
  The CanvasKit namespace
Returns void
Inherited from Figure.init
- Defined in core/src/widget.ts:107

isIn

isIn(x, y): boolean
Parameters
- x: number
- y: number
Returns boolean
Inherited from Figure.isIn
- Defined in core/src/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
Inherited from Figure.on
- Defined in core/src/widget.ts:215

predraw

predraw(ck, propertyChanged): void
Updates the arrow figure based on property changes.
Parameters
- ck: CanvasKit
  The CanvasKit instance.
- propertyChanged: string
  The name of the property that changed.
Returns void
Overrides Figure.predraw
- Defined in basic/src/widgets/figures/arrow.ts:109

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 Figure.preupdate
- Defined in core/src/widget.ts:131

processSetups

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

runAnimation

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

setEventListener

setEventListener(element): void
Parameters
- element: HTMLCanvasElement
Returns void
Inherited from Figure.setEventListener
- Defined in core/src/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
Inherited from Figure.setUpdate
- Defined in core/src/widget.ts:278

setup

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

show

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

use

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

`Static` getAbsoluteCoordinates

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

Class Arrow

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Arrow

Properties

animationInstances

centerX

centerY

children

display

eventInstances

fillPaint

from

hasSet

isImplemented

key

last

parent

plugins

progress

radian

setups

Type declaration

nextFrame: number

strokePaint

style

Private tip

to

Private trim

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

`Private` tip

`Private` trim

Returns {
x: number;
y: number;
}

Returns {
x: number;
y: number;
}

`Static` absoluteToRelative

Returns {
x: number;
y: number;
}

`Static` getAbsoluteCoordinates

Returns {
x: number;
y: number;
}