Interface TextFlowMaterialOptions

interface TextFlowMaterialOptions {
    align?: TextAlign;
    backgroundColor?: string | {
        image: string | ImageLike;
    };
    borderColor?: string;
    borderDash?: false | number[];
    borderDashOffset?: number;
    borderRadius?: number | number[];
    borderWidth?: number;
    ellipsis?: string;
    fill?: string;
    fillOpacity?: number;
    flowDirection?: "vertical" | "horizon";
    flowSpeed?: number;
    font?: string;
    fontFamily?: string;
    fontSize?: string | number;
    fontStyle?: FontStyle;
    fontWeight?: FontWeight;
    geometryHeight: number;
    geometryWidth: number;
    height?: number;
    lineDash?: false | number[];
    lineDashOffset?: number;
    lineHeight?: number;
    lineOverflow?: "truncate";
    lineWidth?: number;
    margin?: number;
    opacity?: number;
    overflow?: "none" | "break" | "breakAll" | "truncate";
    padding?: number | number[];
    placeholder?: string;
    rich?: Dictionary<TextStylePropsPart>;
    shadowBlur?: number;
    shadowColor?: string;
    shadowOffsetX?: number;
    shadowOffsetY?: number;
    stroke?: string;
    strokeNoScale?: boolean;
    strokeOpacity?: number;
    tag?: string;
    text?: string;
    textFont?: string;
    textShadowBlur?: number;
    textShadowColor?: string;
    textShadowOffsetX?: number;
    textShadowOffsetY?: number;
    truncateMinChar?: number;
    verticalAlign?: TextVerticalAlign;
    width?: number;
    x?: number;
    y?: number;
}

Hierarchy (view full)

Properties

align? backgroundColor? borderColor? borderDash? borderDashOffset? borderRadius? borderWidth? ellipsis? fill? fillOpacity? flowDirection? flowSpeed? font? fontFamily? fontSize? fontStyle? fontWeight? geometryHeight geometryWidth height? lineDash? lineDashOffset? lineHeight? lineOverflow? lineWidth? margin? opacity? overflow? padding? placeholder? rich? shadowBlur? shadowColor? shadowOffsetX? shadowOffsetY? stroke? strokeNoScale? strokeOpacity? tag? text? textFont? textShadowBlur? textShadowColor? textShadowOffsetX? textShadowOffsetY? truncateMinChar? verticalAlign? width? x? y?

Properties

Optional align

align?: TextAlign

Optional backgroundColor

backgroundColor?: string | {
    image: string | ImageLike;
}

Type declaration

  • image: string | ImageLike

Optional borderColor

borderColor?: string

Optional borderDash

borderDash?: false | number[]

Optional borderDashOffset

borderDashOffset?: number

Optional borderRadius

borderRadius?: number | number[]

Optional borderWidth

borderWidth?: number

Optional ellipsis

ellipsis?: string

Epllipsis used if text is truncated

Optional fill

fill?: string

Optional fillOpacity

fillOpacity?: number

Optional flowDirection

flowDirection?: "vertical" | "horizon"

Optional flowSpeed

flowSpeed?: number

Optional font

font?: string

If fontSize or fontFamily exists, font will be reset by fontSize, fontStyle, fontWeight, fontFamily. So do not visit it directly in upper application (like ), but use contain/text#makeFont instead.

Optional fontFamily

fontFamily?: string

It helps merging respectively, rather than parsing an entire font string.

Optional fontSize

fontSize?: string | number

It helps merging respectively, rather than parsing an entire font string. Should be 12 but not '12px'.

Optional fontStyle

fontStyle?: FontStyle

It helps merging respectively, rather than parsing an entire font string.

Optional fontWeight

fontWeight?: FontWeight

It helps merging respectively, rather than parsing an entire font string.

geometryHeight

geometryHeight: number

geometryWidth

geometryWidth: number

Optional height

height?: number

Height of text block. Not include padding Used for background, truncate

Optional lineDash

lineDash?: false | number[]

Optional lineDashOffset

lineDashOffset?: number

Optional lineHeight

lineHeight?: number

Line height. Default to be text height of '国'

Optional lineOverflow

lineOverflow?: "truncate"

Strategy when text lines exceeds textHeight. Do nothing if not set

Optional lineWidth

lineWidth?: number

textStroke may be set as some color as a default value in upper applicaion, where the default value of lineWidth should be 0 to make sure that user can choose to do not use text stroke.

Optional margin

margin?: number

Margin of label. Used when layouting the label.

Optional opacity

opacity?: number

Optional overflow

overflow?: "none" | "break" | "breakAll" | "truncate"

Strategy when calculated text width exceeds textWidth. break: break by word break: will break inside the word truncate: truncate the text and show ellipsis Do nothing if not set

Optional padding

padding?: number | number[]

Can be 2 or [2, 4] or [2, 3, 4, 5]

Optional placeholder

placeholder?: string

Placeholder used if text is truncated to empty

Optional rich

rich?: Dictionary<TextStylePropsPart>

Text styles for rich text.

Optional shadowBlur

shadowBlur?: number

Shadow blur for background box.

Optional shadowColor

shadowColor?: string

Shadow color for background box.

Optional shadowOffsetX

shadowOffsetX?: number

Shadow offset x for background box.

Optional shadowOffsetY

shadowOffsetY?: number

Shadow offset y for background box.

Optional stroke

stroke?: string

Optional strokeNoScale

strokeNoScale?: boolean

Optional strokeOpacity

strokeOpacity?: number

Optional tag

tag?: string

Reserved for special functinality, like 'hr'.

Optional text

text?: string

Optional textFont

textFont?: string

The same as font. Use font please.

Deprecated

Optional textShadowBlur

textShadowBlur?: number

Optional textShadowColor

textShadowColor?: string

Optional textShadowOffsetX

textShadowOffsetX?: number

Optional textShadowOffsetY

textShadowOffsetY?: number

Optional truncateMinChar

truncateMinChar?: number

Min characters for truncating

Optional verticalAlign

verticalAlign?: TextVerticalAlign

Optional width

width?: number

Only support number in the top block.

Optional x

x?: number

Optional y

y?: number

Settings

Member Visibility

Theme

On This Page