Interface TextStyle

Represents the style properties that can be applied to text.

interface TextStyle {
    antiAlias?: boolean;
    applyRoundingHack?: boolean;
    blendMode?: BlendMode;
    border?: boolean;
    borderColor?: Color;
    borderShader?: Shader;
    borderWidth?: number;
    disableHinting?: boolean;
    ellipsis?: string;
    fill?: boolean;
    fillColor?: Color;
    fillShader?: Shader;
    heightMultiplier?: number;
    interval?: number[];
    layout?: Layout;
    margin?: number | [number, number, number, number] | [number, number];
    maxLines?: number;
    offset?: number;
    replaceTabCharacters?: boolean;
    rotation?: number;
    scaleX?: number;
    scaleY?: number;
    textAlign?: TextAlign;
    textDirection?: TextDirection;
    textHeightBehavior?: TextHeightBehavior;
    transparency?: number;
    width?: number;
}

Hierarchy (view full)

Properties

antiAlias? applyRoundingHack? blendMode? border? borderColor? borderShader? borderWidth? disableHinting? ellipsis? fill? fillColor? fillShader? heightMultiplier? interval? layout? margin? maxLines? offset? replaceTabCharacters? rotation? scaleX? scaleY? textAlign? textDirection? textHeightBehavior? transparency? width?

Properties

Optional antiAlias

antiAlias?: boolean

Optional applyRoundingHack

applyRoundingHack?: boolean

Specifies whether to apply a rounding hack for the text.

Optional blendMode

blendMode?: BlendMode

Optional border

border?: boolean

Specifies whether to draw a border around the text.

Optional borderColor

borderColor?: Color

The color of the border around the text.

Optional borderShader

borderShader?: Shader

The shader used to draw the border around the text.

Optional borderWidth

borderWidth?: number

The width of the border around the text.

Optional disableHinting

disableHinting?: boolean

Specifies whether hinting should be disabled for the text.

Optional ellipsis

ellipsis?: string

The ellipsis string to be used for truncating the text.

Optional fill

fill?: boolean

Specifies whether the text should be filled.

Optional fillColor

fillColor?: Color

The color used to fill the text.

Optional fillShader

fillShader?: Shader

The shader used to fill the text.

Optional heightMultiplier

heightMultiplier?: number

Multiplier for height adjustment of the text.

Optional interval

interval?: number[]

The interval for the text.

Optional layout

layout?: Layout

Optional margin

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

Optional maxLines

maxLines?: number

The maximum number of lines for the text.

Optional offset

offset?: number

The offset of the text.

Optional replaceTabCharacters

replaceTabCharacters?: boolean

Specifies whether to replace tab characters with spaces in the text.

Optional rotation

rotation?: number

Optional scaleX

scaleX?: number

Optional scaleY

scaleY?: number

Optional textAlign

textAlign?: TextAlign

The alignment of the text within its container.

Optional textDirection

textDirection?: TextDirection

The direction of the text.

Optional textHeightBehavior

textHeightBehavior?: TextHeightBehavior

The behavior of the text regarding its height.

Optional transparency

transparency?: number

Optional width

width?: number

The width of the text.

Settings

Member Visibility

Theme

On This Page

antiAliasapplyRoundingHackblendModeborderborderColorborderShaderborderWidthdisableHintingellipsisfillfillColorfillShaderheightMultiplierintervallayoutmarginmaxLinesoffsetreplaceTabCharactersrotationscaleXscaleYtextAligntextDirectiontextHeightBehaviortransparencywidth