Class Svg

Draw a image made from svg string.

Hierarchy (view full)

Widget
- Svg

Index

Constructors

constructor

new Svg(svg, options?): Svg
Parameters
- svg: string
  The SVG string
- Optional options: SvgOptions
  The options
Returns Svg
Overrides Widget.constructor
- Defined in basic/src/widgets/svg.ts:51

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

`Private` image

image: HTMLImageElement = ...

`Private` imageData

imageData: Image

isImplemented

isImplemented: boolean = false

key

key: string = ...

last

last: Widget = ...

`Private` paint

paint: Paint

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

svg

svg: string

The SVG string

updates

updates: ((elapsed, widget) => void)[] = []

Type declaration

- (elapsed, widget): void
- Parameters
  - elapsed: number
  - widget: Widget
  Returns void

`Private` vcanvas

vcanvas: OffscreenCanvas

`Private` vcanvasContext

vcanvasContext: OffscreenCanvasRenderingContext2D

x

x: number

y

y: number

Accessors

range

get range(): WidgetRange
Returns WidgetRange
Overrides Widget.range
- Defined in basic/src/widgets/svg.ts:87

Methods

_isAsyncWidget

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

add

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

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 core/src/widget.ts:196

animateTree

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

copy

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

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 Widget.draw
- Defined in basic/src/widgets/svg.ts:82

hide

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

init

init(ck): void
Called when the widget is registered.
Parameters
- ck: CanvasKit
  The CanvasKit namespace
Returns void
Overrides Widget.init
- Defined in basic/src/widgets/svg.ts:61

isIn

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

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
- propertyChanged: string
Returns void
Overrides Widget.predraw
- Defined in basic/src/widgets/svg.ts:75

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

processSetups

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

runAnimation

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

setEventListener

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

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 core/src/widget.ts:277

setup

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

show

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

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 core/src/widget.ts:139

use

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

`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 core/src/widget.ts:402

`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 core/src/widget.ts:380

Class Svg

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Svg

Properties

animationInstances

centerX

centerY

children

display

eventInstances

hasSet

Private image

Private imageData

isImplemented

key

last

Private paint

parent

plugins

progress

ready

setups

Type declaration

nextFrame: number

style

svg

updates

Type declaration

Parameters

Returns void

Private vcanvas

Private vcanvasContext

x

y

Accessors

range

Returns WidgetRange

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 void

isIn

Parameters

Returns boolean

on

Parameters

Parameters

Returns any

Returns this

predraw

Parameters

Returns void

preupdate

Parameters

`Private` image

`Private` imageData

`Private` paint

`Private` vcanvas

`Private` vcanvasContext

`Static` absoluteToRelative

Returns {
x: number;
y: number;
}

`Static` getAbsoluteCoordinates

Returns {
x: number;
y: number;
}