Class Markdown

Hierarchy (view full)

Widget
- Markdown

Constructors

constructor

new Markdown(text, options): Markdown
Parameters
- text: string
- options: MarkdownOptions
Returns Markdown
Overrides Widget.constructor
- Defined in mods/mod-markdown/src/index.ts:22

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 = ...

`Private` paragraph

paragraph: Paragraph

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 = ...

text

text: string

`Private` textStyle

textStyle: TextStyle

updates

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

Type declaration

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

`Private` width

width: number

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 Widget.range
- Defined in packages/core/src/widget.ts:409

Methods

_isAsyncWidget

_isAsyncWidget(): boolean
Returns boolean
Inherited from Widget._isAsyncWidget
- Defined in packages/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 Widget.add
- Defined in packages/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 Widget.animate
- Defined in packages/core/src/widget.ts:197

animateTree

animateTree(tree, startAt): void
Parameters
- tree: AnimationTree
- startAt: number
Returns void
Inherited from Widget.animateTree
- Defined in packages/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 Widget.calculateIn
- Defined in packages/core/src/widget.ts:380

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 Widget.calculateRange
- Defined in packages/core/src/widget.ts:400

coordinateChildToParent

coordinateChildToParent(x, y): {
x: number;
y: number;
}
Parameters
- x: number
- y: number
Returns {
x: number;
y: number;
}
- x: number
- y: number
Inherited from Widget.coordinateChildToParent
- Defined in packages/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 Widget.coordinateParentToChild
- Defined in packages/core/src/widget.ts:426

copy

copy(): this
Returns this
Inherited from Widget.copy
- Defined in packages/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 Widget.draw
- Defined in mods/mod-markdown/src/index.ts:50

`Private` handleImage

handleImage(markdownLine, builder, _ck): void
Parameters
- markdownLine: string
- builder: ParagraphBuilder
- _ck: CanvasKit
Returns void
- Defined in mods/mod-markdown/src/index.ts:145

hide

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

init

init(ck): void
Called when the widget is registered.
Parameters
- ck: CanvasKit
  The CanvasKit namespace
Returns void
Overrides Widget.init
- Defined in mods/mod-markdown/src/index.ts:31

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

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

`Private` parseMarkdown

parseMarkdown(text, builder, ck): void
Parameters
- text: string
- builder: ParagraphBuilder
- ck: CanvasKit
Returns void
- Defined in mods/mod-markdown/src/index.ts:59

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 Widget.predraw
- Defined in mods/mod-markdown/src/index.ts:54

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

processSetups

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

runAnimation

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

setEventListener

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

setup

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

show

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

use

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

Class Markdown

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Markdown

Properties

animationInstances

centerX

centerY

children

display

eventInstances

hasSet

isImplemented

key

last

Private paragraph

parent

plugins

progress

setups

Type declaration

nextFrame: number

style

text

Private textStyle

updates

Type declaration

Parameters

Returns void

Private width

x

y

Accessors

range

Returns WidgetRange

Methods

_isAsyncWidget

Returns boolean

add

Parameters

Returns this

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

x: number

y: number

copy

Returns this

draw

Parameters

Returns void

Private handleImage

Parameters

Returns void

hide

Returns this

init

`Private` paragraph

`Private` textStyle

`Private` width

Returns {
x: number;
y: number;
}

Returns {
x: number;
y: number;
}

`Private` handleImage

`Private` parseMarkdown

`Static` absoluteToRelative

Returns {
x: number;
y: number;
}

`Static` getAbsoluteCoordinates

Returns {
x: number;
y: number;
}