@rendley/sdk - v1.12.6
    Preparing search index...

    Class TextStyle

    Hierarchy (View Summary)

    Index

    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 getCrop getFontFamily getFontSize getFontStyle getFontWeight getHeight getPadding getPosition getRawHeight getRawSize getRawWidth getRotation getScale getSize getStrokeColor getStrokeThickness getTextAlign getWidth getWordWrapWidth getZIndex invalidateCache load positionToCenter replaceMediaDataId scaleDownToFit serialize setAlpha setAnimationAlphaMultiplier setAnimationColor setAnimationPositionOffset setAnimationRotationOffset setAnimationScaleMultiplier setBackgroundColor setColor setCornerRadius setCrop setDirty setFontFamily setFontSize setFontStyle setFontWeight setHeight setPadding setPosition setRotation setScale setSize setStrokeColor setStrokeThickness setTextAlign setWidth setWordWrapWidth setZIndex update deserialize

    Constructors

    Properties

    backgroundColor: null | string
    color: string
    fontFamily: string
    fontSize: number
    fontStyle: "normal" | "italic" | "oblique"
    fontWeight:
        | "normal"
        | "bold"
        | "bolder"
        | "lighter"
        | "100"
        | "200"
        | "300"
        | "400"
        | "500"
        | "600"
        | "700"
        | "800"
        | "900"
    padding: number[]
    strokeColor: string
    strokeThickness: number
    textAlign: "center" | "left" | "right" | "justify"
    wordWrapWidth: null | number

    Methods

    • Returns string

    • Returns null | string

    • Returns string

    • Returns the current crop values of the clip. The returned array contains four numbers: [left, top, right, bottom]

      Returns number[]

      The current crop values of the clip.

    • Returns string

    • Returns number

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

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

    • Returns number[]

    • Returns [number, number]

    • Returns [number, number]

    • Returns string

    • Returns number

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

    • Returns null | number

    • Parameters

      • sprite: TextSprite

      Returns void

    • Returns {
          alpha: number;
          backgroundColor: null | string;
          clipId: string;
          color: string;
          cornerRadius?: [number, number, number, number];
          crop: [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;
          padding: number[];
          position: [number, number];
          relativeCornerRadius: boolean;
          rotation: number;
          scale: [number, number];
          strokeColor: string;
          strokeThickness: number;
          textAlign: "center" | "left" | "right" | "justify";
          width?: number;
          wordWrapWidth: null | number;
          zIndex: number;
      }

    • Parameters

      • alpha: number

      Returns void

    • Parameters

      • color: string

      Returns void

    • Parameters

      • multiplierX: number
      • multiplierY: number

      Returns void

    • Parameters

      • backgroundColor: null | string

      Returns void

    • Parameters

      • color: string

      Returns void

    • Parameters

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

      Returns void

    • Sets the crop values for the clip's sprite. This will clip the original texture to the given coordinates. If the sprite is not a video, gif or image, it will not be updated. If the sprite has no texture, or the texture is not valid, it will not be updated. If updatePosition is true, it will also update the position of the sprite, so that the cropped area will maintain it's visual position.

      Parameters

      • left: number

        The left coordinate of the crop area

      • top: number

        The top coordinate of the crop area

      • right: number

        The right coordinate of the crop area

      • bottom: number

        The bottom coordinate of the crop area

      • updatePosition: boolean = true

        If true, it will also update the position of the sprite, so that the middle of the cropped area is at the same position as the middle of the original texture. Default is true.

      Returns void

    • Returns void

    • Parameters

      • fontFamily: string

      Returns void

    • Parameters

      • fontSize: number

      Returns void

    • Parameters

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

      Returns void

    • Parameters

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

      Returns void

    • Parameters

      • height: number

      Returns void

    • Parameters

      • padding: number | number[]

      Returns void

    • Parameters

      • x: number
      • y: number

      Returns void

    • Parameters

      • rotation: number

      Returns void

    • Parameters

      • scaleX: number
      • scaleY: number

      Returns void

    • Parameters

      • width: number
      • height: number

      Returns void

    • Parameters

      • strokeColor: string

      Returns void

    • Parameters

      • strokeThickness: number

      Returns void

    • Parameters

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

      Returns void

    • Parameters

      • width: number

      Returns void

    • Parameters

      • wordWrapWidth: null | number

      Returns void

    • Parameters

      • zIndex: number

      Returns void

    • Parameters

      • container: TextSprite

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    destroygetAlphagetAnimationAlphaMultipliergetAnimationColorgetAnimationPositionOffsetgetAnimationRotationOffsetgetAnimationScaleMultipliergetBackgroundColorgetColorgetCornerRadiusgetCornerRadiusRelativegetCropgetFontFamilygetFontSizegetFontStylegetFontWeightgetHeightgetPaddinggetPositiongetRawHeightgetRawSizegetRawWidthgetRotationgetScalegetSizegetStrokeColorgetStrokeThicknessgetTextAligngetWidthgetWordWrapWidthgetZIndexinvalidateCacheloadpositionToCenterreplaceMediaDataIdscaleDownToFitserializesetAlphasetAnimationAlphaMultipliersetAnimationColorsetAnimationPositionOffsetsetAnimationRotationOffsetsetAnimationScaleMultipliersetBackgroundColorsetColorsetCornerRadiussetCropsetDirtysetFontFamilysetFontSizesetFontStylesetFontWeightsetHeightsetPaddingsetPositionsetRotationsetScalesetSizesetStrokeColorsetStrokeThicknesssetTextAlignsetWidthsetWordWrapWidthsetZIndexupdatedeserialize