Class TextStyle

Hierarchy (View Summary)

ClipStyle<TextSprite>
- TextStyle

Index

Constructors

Properties

backgroundColor color fontFamily fontSize fontStyle fontWeight padding strokeColor strokeThickness textAlign wordWrapWidth

Methods

destroy getAlpha getAnimationAlphaMultiplier getAnimationColor getAnimationPositionOffset getAnimationRotationOffset getAnimationScaleMultiplier getBackgroundColor getColor getCornerRadius getCornerRadiusRelative getFontFamily getFontSize getFontStyle getFontWeight getHeight getPadding getPosition getRawHeight getRawWidth getRotation getScale getStrokeColor getStrokeThickness getTextAlign getWidth getWordWrapWidth getZIndex load positionToCenter replaceMediaDataId scaleDownToFit serialize setAlpha setAnimationAlphaMultiplier setAnimationColor setAnimationPositionOffset setAnimationRotationOffset setAnimationScaleMultiplier setBackgroundColor setColor setCornerRadius setDirty setFontFamily setFontSize setFontStyle setFontWeight setPadding setPosition setRotation setScale setStrokeColor setStrokeThickness setTextAlign setWordWrapWidth setZIndex update deserialize

Constructors

constructor

new TextStyle(options: TextClipStyleOptions): TextStyle
Parameters
- options: TextClipStyleOptions
Returns TextStyle
Overrides ClipStyle.constructor
- Defined in src/modules/clip/clips/text/TextStyle.ts:63

Properties

backgroundColor

backgroundColor: null | string

color

color: string

fontFamily

fontFamily: string

fontStyle

fontStyle: "normal" | "italic" | "oblique"

fontWeight

fontWeight:
    | "bold"
    | "normal"
    | "bolder"
    | "lighter"
    | "100"
    | "200"
    | "300"
    | "400"
    | "500"
    | "600"
    | "700"
    | "800"
    | "900"

padding

padding: number[]

strokeColor

strokeColor: string

strokeThickness

strokeThickness: number

textAlign

textAlign: "left" | "center" | "right" | "justify"

wordWrapWidth

wordWrapWidth: null | number

Methods

destroy

destroy(): void
Returns void
Inherited from ClipStyle.destroy
- Defined in src/modules/clip/ClipStyle.ts:473

getAlpha

getAlpha(): number
Returns number
Inherited from ClipStyle.getAlpha
- Defined in src/modules/clip/ClipStyle.ts:218

getAnimationAlphaMultiplier

getAnimationAlphaMultiplier(): number
Returns number
Inherited from ClipStyle.getAnimationAlphaMultiplier
- Defined in src/modules/clip/ClipStyle.ts:230

getAnimationColor

getAnimationColor(): string
Returns string
- Defined in src/modules/clip/clips/text/TextStyle.ts:205

getAnimationPositionOffset

getAnimationPositionOffset(): [number, number]
Returns [number, number]
Inherited from ClipStyle.getAnimationPositionOffset
- Defined in src/modules/clip/ClipStyle.ts:290

getAnimationRotationOffset

getAnimationRotationOffset(): number
Returns number
Inherited from ClipStyle.getAnimationRotationOffset
- Defined in src/modules/clip/ClipStyle.ts:260

getAnimationScaleMultiplier

getAnimationScaleMultiplier(): [number, number]
Returns [number, number]
Inherited from ClipStyle.getAnimationScaleMultiplier
- Defined in src/modules/clip/ClipStyle.ts:184

getBackgroundColor

getBackgroundColor(): null | string
Returns null | string
- Defined in src/modules/clip/clips/text/TextStyle.ts:315

getColor

getColor(): string
Returns string
- Defined in src/modules/clip/clips/text/TextStyle.ts:189

getCornerRadius

getCornerRadius(): number[]
Returns number[]
Inherited from ClipStyle.getCornerRadius
- Defined in src/modules/clip/ClipStyle.ts:150

getCornerRadiusRelative

getCornerRadiusRelative(): boolean
Returns boolean
Inherited from ClipStyle.getCornerRadiusRelative
- Defined in src/modules/clip/ClipStyle.ts:154

getFontFamily

getFontFamily(): string
Returns string
- Defined in src/modules/clip/clips/text/TextStyle.ts:249

getFontSize

getFontSize(): number
Returns number
- Defined in src/modules/clip/clips/text/TextStyle.ts:147

getFontStyle

getFontStyle(): "normal" | "italic" | "oblique"
Returns "normal" | "italic" | "oblique"
- Defined in src/modules/clip/clips/text/TextStyle.ts:293

getFontWeight

getFontWeight(): | "bold"
| "normal"
| "bolder"
| "lighter"
| "100"
| "200"
| "300"
| "400"
| "500"
| "600"
| "700"
| "800"
| "900"
Returns
    | "bold"
    | "normal"
    | "bolder"
    | "lighter"
    | "100"
    | "200"
    | "300"
    | "400"
    | "500"
    | "600"
    | "700"
    | "800"
    | "900"
- Defined in src/modules/clip/clips/text/TextStyle.ts:227

getHeight

getHeight(): number
Returns number
Inherited from ClipStyle.getHeight
- Defined in src/modules/clip/ClipStyle.ts:192

getPadding

getPadding(): number[]
Returns number[]
- Defined in src/modules/clip/clips/text/TextStyle.ts:341

getPosition

getPosition(): [number, number]
Returns [number, number]
Inherited from ClipStyle.getPosition
- Defined in src/modules/clip/ClipStyle.ts:278

getRawHeight

getRawHeight(): number
Returns number
Inherited from ClipStyle.getRawHeight
- Defined in src/modules/clip/ClipStyle.ts:200

getRawWidth

getRawWidth(): number
Returns number
Inherited from ClipStyle.getRawWidth
- Defined in src/modules/clip/ClipStyle.ts:196

getRotation

getRotation(): number
Returns number
Inherited from ClipStyle.getRotation
- Defined in src/modules/clip/ClipStyle.ts:248

getScale

getScale(): [number, number]
Returns [number, number]
Inherited from ClipStyle.getScale
- Defined in src/modules/clip/ClipStyle.ts:172

getStrokeColor

getStrokeColor(): string
Returns string
- Defined in src/modules/clip/clips/text/TextStyle.ts:103

getStrokeThickness

getStrokeThickness(): number
Returns number
- Defined in src/modules/clip/clips/text/TextStyle.ts:125

getTextAlign

getTextAlign(): "left" | "center" | "right" | "justify"
Returns "left" | "center" | "right" | "justify"
- Defined in src/modules/clip/clips/text/TextStyle.ts:271

getWidth

getWidth(): number
Returns number
Inherited from ClipStyle.getWidth
- Defined in src/modules/clip/ClipStyle.ts:188

getWordWrapWidth

getWordWrapWidth(): null | number
Returns null | number
- Defined in src/modules/clip/clips/text/TextStyle.ts:151

getZIndex

getZIndex(): number
Returns number
Inherited from ClipStyle.getZIndex
- Defined in src/modules/clip/ClipStyle.ts:304

load

load(sprite: TextSprite): void
Parameters
- sprite: TextSprite
Returns void
Inherited from ClipStyle.load
- Defined in src/modules/clip/ClipStyle.ts:308

positionToCenter

positionToCenter(): void
Returns void
Inherited from ClipStyle.positionToCenter
- Defined in src/modules/clip/ClipStyle.ts:97

replaceMediaDataId

replaceMediaDataId(mediaDataId: string): void
Parameters
- mediaDataId: string
Returns void
Inherited from ClipStyle.replaceMediaDataId
- Defined in src/modules/clip/ClipStyle.ts:129

scaleDownToFit

scaleDownToFit(): void
Returns void
Inherited from ClipStyle.scaleDownToFit
- Defined in src/modules/clip/ClipStyle.ts:104

serialize

serialize(): {
    alpha: number;
    backgroundColor: null
    | string;
    clipId: string;
    color: string;
    cornerRadius?: [number, number, number, number];
    fontFamily: string;
    fontSize: number;
    fontStyle: "normal" | "italic" | "oblique";
    fontWeight:
        | "bold"
        | "normal"
        | "bolder"
        | "lighter"
        | "100"
        | "200"
        | "300"
        | "400"
        | "500"
        | "600"
        | "700"
        | "800"
        | "900";
    height?: number;
    mediaDataId?: string;
    padding: number[];
    position: [number, number];
    relativeCornerRadius: boolean;
    rotation: number;
    scale: [number, number];
    strokeColor: string;
    strokeThickness: number;
    textAlign: "left" | "center" | "right" | "justify";
    width?: number;
    wordWrapWidth: null | number;
    zIndex: number;
}
Returns {
    alpha: number;
    backgroundColor: null | string;
    clipId: string;
    color: string;
    cornerRadius?: [number, number, number, number];
    fontFamily: string;
    fontSize: number;
    fontStyle: "normal" | "italic" | "oblique";
    fontWeight:
        | "bold"
        | "normal"
        | "bolder"
        | "lighter"
        | "100"
        | "200"
        | "300"
        | "400"
        | "500"
        | "600"
        | "700"
        | "800"
        | "900";
    height?: number;
    mediaDataId?: string;
    padding: number[];
    position: [number, number];
    relativeCornerRadius: boolean;
    rotation: number;
    scale: [number, number];
    strokeColor: string;
    strokeThickness: number;
    textAlign: "left" | "center" | "right" | "justify";
    width?: number;
    wordWrapWidth: null | number;
    zIndex: number;
}
Overrides ClipStyle.serialize
- Defined in src/modules/clip/clips/text/TextStyle.ts:399

setAlpha

setAlpha(alpha: number): void
Parameters
- alpha: number
Returns void
Inherited from ClipStyle.setAlpha
- Defined in src/modules/clip/ClipStyle.ts:204

setAnimationAlphaMultiplier

setAnimationAlphaMultiplier(alpha: number): void
Parameters
- alpha: number
Returns void
Inherited from ClipStyle.setAnimationAlphaMultiplier
- Defined in src/modules/clip/ClipStyle.ts:222

setAnimationColor

setAnimationColor(color: string): void
Parameters
- color: string
Returns void
- Defined in src/modules/clip/clips/text/TextStyle.ts:193

setAnimationPositionOffset

setAnimationPositionOffset(x: number, y: number): void
Parameters
- x: number
- y: number
Returns void
Inherited from ClipStyle.setAnimationPositionOffset
- Defined in src/modules/clip/ClipStyle.ts:282

setAnimationRotationOffset

setAnimationRotationOffset(rotation: number): void
Parameters
- rotation: number
Returns void
Inherited from ClipStyle.setAnimationRotationOffset
- Defined in src/modules/clip/ClipStyle.ts:252

setAnimationScaleMultiplier

setAnimationScaleMultiplier(multiplierX: number, multiplierY: number): void
Parameters
- multiplierX: number
- multiplierY: number
Returns void
Inherited from ClipStyle.setAnimationScaleMultiplier
- Defined in src/modules/clip/ClipStyle.ts:176

setBackgroundColor

setBackgroundColor(backgroundColor: null | string): void
Parameters
- backgroundColor: null | string
Returns void
- Defined in src/modules/clip/clips/text/TextStyle.ts:297

setColor

setColor(color: string): void
Parameters
- color: string
Returns void
- Defined in src/modules/clip/clips/text/TextStyle.ts:173

setCornerRadius

setCornerRadius(
radii: number | [number, number, number, number],
relative?: boolean,
): void
Parameters
- radii: number | [number, number, number, number]
- relative: boolean = false
Returns void
Inherited from ClipStyle.setCornerRadius
- Defined in src/modules/clip/ClipStyle.ts:133

setDirty

setDirty(): void
Returns void
- Defined in src/modules/clip/clips/text/TextStyle.ts:81

setFontFamily

setFontFamily(fontFamily: string): void
Parameters
- fontFamily: string
Returns void
- Defined in src/modules/clip/clips/text/TextStyle.ts:231

setFontSize

setFontSize(fontSize: number): void
Parameters
- fontSize: number
Returns void
- Defined in src/modules/clip/clips/text/TextStyle.ts:129

setFontStyle

setFontStyle(fontStyle: "normal" | "italic" | "oblique"): void
Parameters
- fontStyle: "normal" | "italic" | "oblique"
Returns void
- Defined in src/modules/clip/clips/text/TextStyle.ts:275

setFontWeight

setFontWeight(
    fontWeight:
        | "bold"
        | "normal"
        | "bolder"
        | "lighter"
        | "100"
        | "200"
        | "300"
        | "400"
        | "500"
        | "600"
        | "700"
        | "800"
        | "900",
): void
Parameters
- fontWeight:
      | "bold"
      | "normal"
      | "bolder"
      | "lighter"
      | "100"
      | "200"
      | "300"
      | "400"
      | "500"
      | "600"
      | "700"
      | "800"
      | "900"
Returns void
- Defined in src/modules/clip/clips/text/TextStyle.ts:209

setPadding

setPadding(padding: number | number[]): void
Parameters
- padding: number | number[]
Returns void
- Defined in src/modules/clip/clips/text/TextStyle.ts:319

setPosition

setPosition(x: number, y: number): void
Parameters
- x: number
- y: number
Returns void
Inherited from ClipStyle.setPosition
- Defined in src/modules/clip/ClipStyle.ts:264

setRotation

setRotation(rotation: number): void
Parameters
- rotation: number
Returns void
Inherited from ClipStyle.setRotation
- Defined in src/modules/clip/ClipStyle.ts:234

setScale

setScale(scaleX: number, scaleY: number): void
Parameters
- scaleX: number
- scaleY: number
Returns void
Inherited from ClipStyle.setScale
- Defined in src/modules/clip/ClipStyle.ts:158

setStrokeColor

setStrokeColor(strokeColor: string): void
Parameters
- strokeColor: string
Returns void
- Defined in src/modules/clip/clips/text/TextStyle.ts:85

setStrokeThickness

setStrokeThickness(strokeThickness: number): void
Parameters
- strokeThickness: number
Returns void
- Defined in src/modules/clip/clips/text/TextStyle.ts:107

setTextAlign

setTextAlign(textAlign: "left" | "center" | "right" | "justify"): void
Parameters
- textAlign: "left" | "center" | "right" | "justify"
Returns void
- Defined in src/modules/clip/clips/text/TextStyle.ts:253

setWordWrapWidth

setWordWrapWidth(wordWrapWidth: null | number): void
Parameters
- wordWrapWidth: null | number
Returns void
- Defined in src/modules/clip/clips/text/TextStyle.ts:155

setZIndex

setZIndex(zIndex: number): void
Parameters
- zIndex: number
Returns void
Inherited from ClipStyle.setZIndex
- Defined in src/modules/clip/ClipStyle.ts:294

update

update(container: TextSprite): void
Parameters
- container: TextSprite
Returns void
Overrides ClipStyle.update
- Defined in src/modules/clip/clips/text/TextStyle.ts:345

`Static`deserialize

deserialize(payload: object): TextStyle
Parameters
- payload: object
Returns TextStyle
Overrides ClipStyle.deserialize
- Defined in src/modules/clip/clips/text/TextStyle.ts:416

Class TextStyle

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TextStyle

Properties

backgroundColor

color

fontFamily

fontSize

fontStyle

fontWeight

padding

strokeColor

strokeThickness

textAlign

wordWrapWidth

Methods

destroy

Returns void

getAlpha

Returns number

getAnimationAlphaMultiplier

Returns number

getAnimationColor

Returns string

getAnimationPositionOffset

Returns [number, number]

getAnimationRotationOffset

Returns number

getAnimationScaleMultiplier

Returns [number, number]

getBackgroundColor

Returns null | string

getColor

Returns string

getCornerRadius

Returns number[]

getCornerRadiusRelative

Returns boolean

getFontFamily

Returns string

getFontSize

Returns number

getFontStyle

Returns "normal" | "italic" | "oblique"

getFontWeight

Returns | "bold" | "normal" | "bolder" | "lighter" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900"

getHeight

Returns number

getPadding

Returns number[]

getPosition

Returns [number, number]

getRawHeight

Returns number

getRawWidth

Returns number

getRotation

Returns number

getScale

Returns [number, number]

getStrokeColor

Returns string

getStrokeThickness

Returns number

getTextAlign

Returns "left" | "center" | "right" | "justify"

getWidth

Returns number

getWordWrapWidth

Returns null | number

getZIndex

Returns number

load

Returns
| "bold"
| "normal"
| "bolder"
| "lighter"
| "100"
| "200"
| "300"
| "400"
| "500"
| "600"
| "700"
| "800"
| "900"