Class TextStyle

constructor

• new TextStyle(options): TextStyle

• Parameters

  • options: TextClipStyleOptions

  Returns TextStyle

backgroundColor

color

fontFamily

fontSize

fontStyle

fontWeight

textAlign

wordWrapWidth

getBackgroundColor

• getBackgroundColor(): null | string

• Returns null | string

getColor

• getColor(): string

• Returns string

getFontFamily

• getFontFamily(): string

• Returns string

getFontSize

• getFontSize(): number

• Returns number

getFontStyle

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

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

getFontWeight

• getFontWeight(): "normal" | "bold" | "bolder" | "lighter" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900"

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

getTextAlign

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

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

getWordWrapWidth

• getWordWrapWidth(): null | number

• Returns null | number

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: "normal" | "bold" | "bolder" | "lighter" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900";
      height?: number;
      mediaDataId?: string;
      position: [number, number];
      relativeCornerRadius: boolean;
      rotation: number;
      scale: [number, number];
      textAlign: "left" | "center" | "right" | "justify";
      width?: 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: "normal" | "bold" | "bolder" | "lighter" | "100" | "200" | "300" | "400" | "500" | "600" | "700" | "800" | "900";
      height?: number;
      mediaDataId?: string;
      position: [number, number];
      relativeCornerRadius: boolean;
      rotation: number;
      scale: [number, number];
      textAlign: "left" | "center" | "right" | "justify";
      width?: number;
      zIndex: number;
  }

  • alpha: number

  • backgroundColor: null | string

  • clipId: string

  • color: string

  • Optional cornerRadius?: [number, number, number, number]

  • fontFamily: string

  • fontSize: number

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

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

  • Optional height?: number

  • Optional mediaDataId?: string

  • position: [number, number]

  • relativeCornerRadius: boolean

  • rotation: number

  • scale: [number, number]

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

  • Optional width?: number

  • zIndex: number

setBackgroundColor

• setBackgroundColor(backgroundColor): void

• Parameters

  • backgroundColor: null | string

  Returns void

setColor

• setColor(color): void

• Parameters

  • color: string

  Returns void

setFontFamily

• setFontFamily(fontFamily): void

• Parameters

  • fontFamily: string

  Returns void

setFontSize

• setFontSize(fontSize): void

• Parameters

  • fontSize: number

  Returns void

setFontStyle

• setFontStyle(fontStyle): void

• Parameters

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

  Returns void

setFontWeight

• setFontWeight(fontWeight): void

• Parameters

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

  Returns void

setRotation

• setRotation(rotation): void

• Parameters

  • rotation: number

  Returns void

setTextAlign

• setTextAlign(textAlign): void

• Parameters

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

  Returns void

setWordWrapWidth

• setWordWrapWidth(wordWrapWidth): void

• Parameters

  • wordWrapWidth: null | number

  Returns void

update

• update(container): void

• Parameters

  • container: TextSprite

  Returns void

Static deserialize

• deserialize(payload): TextStyle

• Parameters

  • payload: object

  Returns TextStyle