Class TextStyle

Hierarchy (View Summary)

Constructors

constructor

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

Properties

backgroundColor

backgroundColor: null | string

color

color: string

fontFamily

fontFamily: string

fontSize

fontSize: number

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

getAlpha

getAnimationAlphaMultiplier

getAnimationColor

  • getAnimationColor(): string

  • Returns string

getAnimationPositionOffset

getAnimationRotationOffset

getAnimationScaleMultiplier

getBackgroundColor

  • getBackgroundColor(): null | string

  • Returns null | string

getColor

  • getColor(): string

  • Returns string

getCornerRadius

getCornerRadiusRelative

getFontFamily

  • getFontFamily(): string

  • Returns string

getFontSize

  • getFontSize(): number

  • Returns number

getFontStyle

  • getFontStyle(): "normal" | "italic" | "oblique"

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

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"

getHeight

getPadding

  • getPadding(): number[]

  • Returns number[]

getPosition

getRawHeight

getRawWidth

getRotation

getScale

  • getScale(): [number, number]

  • Returns [number, number]

getStrokeColor

  • getStrokeColor(): string

  • Returns string

getStrokeThickness

  • getStrokeThickness(): number

  • Returns number

getTextAlign

  • getTextAlign(): "left" | "center" | "right" | "justify"

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

getWidth

getWordWrapWidth

  • getWordWrapWidth(): null | number

  • Returns null | number

getZIndex

load

  • load(sprite: TextSprite): void

  • Parameters

    • sprite: TextSprite

    Returns void

positionToCenter

replaceMediaDataId

scaleDownToFit

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

setAlpha

  • setAlpha(alpha: number): void

  • Parameters

    • alpha: number

    Returns void

setAnimationAlphaMultiplier

setAnimationColor

  • setAnimationColor(color: string): void

  • Parameters

    • color: string

    Returns void

setAnimationPositionOffset

setAnimationRotationOffset

setAnimationScaleMultiplier

  • setAnimationScaleMultiplier(multiplierX: number, multiplierY: number): void

  • Parameters

    • multiplierX: number
    • multiplierY: number

    Returns void

setBackgroundColor

  • setBackgroundColor(backgroundColor: null | string): void

  • Parameters

    • backgroundColor: null | string

    Returns void

setColor

  • setColor(color: string): void

  • Parameters

    • color: string

    Returns void

setCornerRadius

  • setCornerRadius(
        radii: number | [number, number, number, number],
        relative?: boolean,
    ): void

  • Parameters

    • radii: number | [number, number, number, number]
    • relative: boolean = false

    Returns void

setDirty

  • setDirty(): void

  • Returns void

setFontFamily

  • setFontFamily(fontFamily: string): void

  • Parameters

    • fontFamily: string

    Returns void

setFontSize

  • setFontSize(fontSize: number): void

  • Parameters

    • fontSize: number

    Returns void

setFontStyle

  • setFontStyle(fontStyle: "normal" | "italic" | "oblique"): void

  • Parameters

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

    Returns void

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

setPadding

  • setPadding(padding: number | number[]): void

  • Parameters

    • padding: number | number[]

    Returns void

setPosition

  • setPosition(x: number, y: number): void

  • Parameters

    • x: number
    • y: number

    Returns void

setRotation

  • setRotation(rotation: number): void

  • Parameters

    • rotation: number

    Returns void

setScale

  • setScale(scaleX: number, scaleY: number): void

  • Parameters

    • scaleX: number
    • scaleY: number

    Returns void

setStrokeColor

  • setStrokeColor(strokeColor: string): void

  • Parameters

    • strokeColor: string

    Returns void

setStrokeThickness

  • setStrokeThickness(strokeThickness: number): void

  • Parameters

    • strokeThickness: number

    Returns void

setTextAlign

  • setTextAlign(textAlign: "left" | "center" | "right" | "justify"): void

  • Parameters

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

    Returns void

setWordWrapWidth

  • setWordWrapWidth(wordWrapWidth: null | number): void

  • Parameters

    • wordWrapWidth: null | number

    Returns void

setZIndex

  • setZIndex(zIndex: number): void

  • Parameters

    • zIndex: number

    Returns void

update

  • update(container: TextSprite): void

  • Parameters

    • container: TextSprite

    Returns void

Staticdeserialize

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
destroygetAlphagetAnimationAlphaMultipliergetAnimationColorgetAnimationPositionOffsetgetAnimationRotationOffsetgetAnimationScaleMultipliergetBackgroundColorgetColorgetCornerRadiusgetCornerRadiusRelativegetFontFamilygetFontSizegetFontStylegetFontWeightgetHeightgetPaddinggetPositiongetRawHeightgetRawWidthgetRotationgetScalegetStrokeColorgetStrokeThicknessgetTextAligngetWidthgetWordWrapWidthgetZIndexloadpositionToCenterreplaceMediaDataIdscaleDownToFitserializesetAlphasetAnimationAlphaMultipliersetAnimationColorsetAnimationPositionOffsetsetAnimationRotationOffsetsetAnimationScaleMultipliersetBackgroundColorsetColorsetCornerRadiussetDirtysetFontFamilysetFontSizesetFontStylesetFontWeightsetPaddingsetPositionsetRotationsetScalesetStrokeColorsetStrokeThicknesssetTextAlignsetWordWrapWidthsetZIndexupdatedeserialize