Interface TextStyle

interface TextStyle {
    antiAlias?: boolean;
    backgroundColor?: Color;
    blendMode?: BlendMode;
    border?: boolean;
    borderColor?: Color;
    borderShader?: Shader;
    borderWidth?: number;
    cap?: StrokeCap;
    color?: Color;
    decoration?: number;
    decorationColor?: Color;
    decorationThickness?: number;
    fill?: boolean;
    fillColor?: Color;
    fillShader?: Shader;
    fontFamilies?: string[];
    fontSize?: number;
    fontStyle?: FontStyle;
    foregroundColor?: Color;
    halfLeading?: boolean;
    heightMultiplier?: number;
    interval?: number[];
    join?: StrokeJoin;
    layout?: Layout;
    letterSpacing?: number;
    locale?: string;
    margin?: number | [number, number, number, number] | [number, number];
    offset?: number;
    rotation?: number;
    scaleX?: number;
    scaleY?: number;
    shader?: Shader;
    textBaseline?: TextBaseline;
    transparency?: number;
    wordSpacing?: number;
}

Hierarchy (view full)

Properties

antiAlias? backgroundColor? blendMode? border? borderColor? borderShader? borderWidth? cap? color? decoration? decorationColor? decorationThickness? fill? fillColor? fillShader? fontFamilies? fontSize? fontStyle? foregroundColor? halfLeading? heightMultiplier? interval? join? layout? letterSpacing? locale? margin? offset? rotation? scaleX? scaleY? shader? textBaseline? transparency? wordSpacing?

Properties

Optional antiAlias

antiAlias?: boolean

Optional backgroundColor

backgroundColor?: Color

The background color of the text this.

Optional blendMode

blendMode?: BlendMode

Optional border

border?: boolean

Optional borderColor

borderColor?: Color

Optional borderShader

borderShader?: Shader

Optional borderWidth

borderWidth?: number

Optional cap

cap?: StrokeCap

Optional color

color?: Color

The color of the text.

Optional decoration

decoration?: number

The decoration style to be applied to the text.

Optional decorationColor

decorationColor?: Color

The color of the decoration applied to the text.

Optional decorationThickness

decorationThickness?: number

The thickness of the decoration applied to the text.

Optional fill

fill?: boolean

Optional fillColor

fillColor?: Color

Optional fillShader

fillShader?: Shader

Optional fontFamilies

fontFamilies?: string[]

An array of font families to be used for rendering the text.

Optional fontSize

fontSize?: number

The size of the font used for the text.

Optional fontStyle

fontStyle?: FontStyle

The style of the font used for the text (e.g., normal, italic).

Optional foregroundColor

foregroundColor?: Color

The foreground color of the text.

Optional halfLeading

halfLeading?: boolean

Specifies whether to use half leading for the text.

Optional heightMultiplier

heightMultiplier?: number

Multiplier for height adjustment of the text.

Optional interval

interval?: number[]

Optional join

join?: StrokeJoin

Optional layout

layout?: Layout

Optional letterSpacing

letterSpacing?: number

The spacing between characters in the text.

Optional locale

locale?: string

The locale to be used for the text.

Optional margin

margin?: number | [number, number, number, number] | [number, number]

Optional offset

offset?: number

Optional rotation

rotation?: number

Optional scaleX

scaleX?: number

Optional scaleY

scaleY?: number

Optional shader

shader?: Shader

Optional textBaseline

textBaseline?: TextBaseline

The baseline alignment of the text.

Optional transparency

transparency?: number

Optional wordSpacing

wordSpacing?: number

The spacing between words in the text.

Settings

Member Visibility

Theme

On This Page

antiAliasbackgroundColorblendModeborderborderColorborderShaderborderWidthcapcolordecorationdecorationColordecorationThicknessfillfillColorfillShaderfontFamiliesfontSizefontStyleforegroundColorhalfLeadingheightMultiplierintervaljoinlayoutletterSpacinglocalemarginoffsetrotationscaleXscaleYshadertextBaselinetransparencywordSpacing