Class TextGroup

Hierarchy (view full)

Figure
- TextGroup

Constructors

constructor

new TextGroup(texts, options?): TextGroup
Parameters
- texts: Text[]
- Optional options: TextGroupOptions
Returns TextGroup
Overrides Figure.constructor
- Defined in basic/src/widgets/textGroup.ts:108

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

hasSet

hasSet: boolean = false

`Optional` heightMultiplier

heightMultiplier?: number

`Optional` interval

interval?: number[]

isImplemented

isImplemented: boolean = false

key

key: string = ...

last

last: Widget = ...

`Private` manager

manager: FontMgr

`Optional` maxLines

maxLines?: number

`Optional` offset

offset?: number

`Private` paragraph

paragraph: Paragraph

parent

parent: Widget

plugins

plugins: WidgetPlugin[] = []

progress

progress: number

registeredEvents

registeredEvents: Map<string, Event<Widget>> = ...

`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

status

status: Status = 'unborn'

strokePaint

strokePaint: Paint

`Optional` strutStyle

strutStyle?: StrutStyle

style

style: TextGroupStyle

`Optional` textAlign

textAlign?: TextAlign

`Optional` textDirection

textDirection?: TextDirection

`Optional` textHeightBehavior

textHeightBehavior?: TextHeightBehavior

texts

texts: Text[]

updates

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

Type declaration

- <T>(elapsed, widget): void
- Type Parameters
  - T extends TextGroup
  Parameters
  - elapsed: number
  - widget: T
  Returns void

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

singleRange

get singleRange(): 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 Figure.singleRange
- Defined in core/src/widget.ts:485

Methods

_isAsyncWidget

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

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

animate

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

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 Figure.calculateIn
- Defined in basic/src/widgets/textGroup.ts:203

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 Figure.calculateRange
- Defined in basic/src/widgets/textGroup.ts:211

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

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

copy

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

draw

draw(canvas): void
Draw the object according to the parameters of the widget. Called when the parameters are changed.
Parameters
- canvas: Canvas
  The canvas object of CanvasKit-WASM.
Returns void
Overrides Figure.draw
- Defined in basic/src/widgets/textGroup.ts:199

emitEvent

emitEvent(name, ...args): this
Parameters
- name: string
- Rest ...args: any[]
Returns this
Inherited from Figure.emitEvent
- Defined in core/src/widget.ts:225

getLineMetrics

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

hide

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

init

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

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

kill

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

on

on(event, effect): this
Parameters
- event: string | 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:237

predraw

predraw(ck, propertyChanged): void
Preload the necessary items duration drawing. Called when the properties 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
Inherited from Figure.predraw
- Defined in basic/src/widgets/figures/figure.ts:56

preupdate

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

processSetups

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

registerEvent

registerEvent(name): this
Parameters
- name: string
Returns this
Inherited from Figure.registerEvent
- Defined in core/src/widget.ts:215

resurrect

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

runAnimation

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

setEventListener

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

setUpdate

setUpdate(updateFunc): this
Set up an update function to call it when the widget is changed.
Parameters
- updateFunc: (<T>(elapsed, widget) => void)
  The frame from having gone to current frame.
  - - <T>(elapsed, widget): void
    - Type Parameters
      T extends TextGroup
      Parameters
      elapsed: number
      widget: T
      Returns void
Returns this
Inherited from Figure.setUpdate
- Defined in core/src/widget.ts:338

setup

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

show

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

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

use

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

`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:555

`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:533

Class TextGroup

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TextGroup

Properties

animationInstances

Optional applyRoundingHack

Private builder

centerX

centerY

children

Optional disableHinting

display

Optional ellipsis

eventInstances

fillPaint

hasSet

Optional heightMultiplier

Optional interval

isImplemented

key

last

Private manager

Optional maxLines

Optional offset

Private paragraph

parent

plugins

progress

registeredEvents

Optional replaceTabCharacters

setups

Type declaration

nextFrame: number

status

strokePaint

Optional strutStyle

style

Optional textAlign

Optional textDirection

Optional textHeightBehavior

texts

updates

Type declaration

Type Parameters

Parameters

Returns void

width

x

y

Accessors

range

Returns WidgetRange

singleRange

Returns WidgetRange

Methods

_isAsyncWidget

Returns boolean

add

Parameters

Returns this

animate

Parameters

Returns this

calculateIn

Parameters

Returns boolean

calculateRange

Returns WidgetRange

coordinateChildToParent

Parameters

Returns { x: number; y: number; }

x: number

`Optional` applyRoundingHack

`Private` builder

`Optional` disableHinting

`Optional` ellipsis

`Optional` heightMultiplier

`Optional` interval

`Private` manager

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