Class Text

Hierarchy (view full)

Widget
- Text

Constructors

constructor

new Text(text, inputOptions?): Text
Create a Text widget
Parameters
- text: (string | InputItem)[]
  The text group/
- Optional inputOptions: TextOptions
  the options
Returns Text
Overrides Widget.constructor
- Defined in basic/src/widgets/text.ts:231

Properties

animationInstances

animationInstances: AnimationInstance<Widget>[] = []

`Optional` applyRoundingHack

applyRoundingHack?: boolean

`Private` builder

builder: ParagraphBuilder

centerX

centerX: number

centerY

centerY: number

children

children: Widget[] = []

The child-widgets of the widget.

`Optional` disableHinting

disableHinting?: boolean

display

display: boolean = true

`Optional` ellipsis

ellipsis?: string

eventInstances

eventInstances: EventInstance<Widget>[] = []

fillPaint

fillPaint: Paint

`Private` fontManager

fontManager: FontMgr

hasSet

hasSet: boolean = false

`Optional` heightMultiplier

heightMultiplier?: number

`Private` `Optional` inputOptions

inputOptions?: TextOptions

the options

`Optional` interval

interval?: number[]

isImplemented

isImplemented: boolean = false

key

key: string = ...

last

last: Widget = ...

`Optional` maxLines

maxLines?: number

`Optional` offset

offset?: number

`Private` paragraph

paragraph: Paragraph

parent

parent: Widget

plugins

plugins: WidgetPlugin[] = []

progress

progress: number

`Optional` replaceTabCharacters

replaceTabCharacters?: boolean

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

`Optional` strutStyle

strutStyle?: StrutStyle

style

style: TextStyle

text

text: InputItem[] = []

`Optional` textAlign

textAlign?: TextAlign

`Optional` textDirection

textDirection?: TextDirection

`Optional` textHeightBehavior

textHeightBehavior?: TextHeightBehavior

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

Methods

_isAsyncWidget

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

animateTree

animateTree(tree, startAt): void
Parameters
- tree: AnimationTree
- startAt: number
Returns void
Inherited from Widget.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
Overrides Widget.calculateIn
- Defined in basic/src/widgets/text.ts:455

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.
Overrides Widget.calculateRange
- Defined in basic/src/widgets/text.ts:462

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

copy

copy(): this
Returns this
Inherited from Widget.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 Widget.draw
- Defined in basic/src/widgets/text.ts:450

getLineMetrics

getLineMetrics(): LineMetrics[]
Returns LineMetrics[]
- Defined in basic/src/widgets/text.ts:471

hide

hide(): this
Returns this
Inherited from Widget.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 Widget.init
- Defined in basic/src/widgets/text.ts:270

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 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 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 Widget.predraw
- Defined in basic/src/widgets/text.ts:355

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

processSetups

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

runAnimation

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

setEventListener

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

show

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

use

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

Class Text

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Text

Properties

animationInstances

Optional applyRoundingHack

Private builder

centerX

centerY

children

Optional disableHinting

display

Optional ellipsis

eventInstances

fillPaint

Private fontManager

hasSet

Optional heightMultiplier

Private Optional inputOptions

Optional interval

isImplemented

key

last

Optional maxLines

Optional offset

Private paragraph

parent

plugins

progress

Optional replaceTabCharacters

setups

Type declaration

nextFrame: number

strokePaint

Optional strutStyle

style

text

Optional textAlign

Optional textDirection

Optional textHeightBehavior

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

calculateIn

Parameters

Returns boolean

calculateRange

Returns WidgetRange

coordinateChildToParent

Parameters

Returns { x: number; y: number; }

x: number

y: number

coordinateParentToChild

`Optional` applyRoundingHack

`Private` builder

`Optional` disableHinting

`Optional` ellipsis

`Private` fontManager

`Optional` heightMultiplier

`Private` `Optional` inputOptions

`Optional` interval

`Optional` maxLines

`Optional` offset

`Private` paragraph

`Optional` replaceTabCharacters

`Optional` strutStyle

`Optional` textAlign

`Optional` textDirection

`Optional` textHeightBehavior

Returns {
x: number;
y: number;
}

Returns {
x: number;
y: number;
}

`Static` absoluteToRelative

Returns {
x: number;
y: number;
}

`Static` getAbsoluteCoordinates

Returns {
x: number;
y: number;
}