@fishjam-cloud/js-server-sdk - v0.29.0
    Preparing search index...

    Interface Text

    Text

    interface Text {
        align?: null | HorizontalAlign;
        backgroundColor?: null | string;
        color?: null | string;
        fontFamily?: null | string;
        fontSize: number;
        height?: null | number;
        id?: null | string;
        lineHeight?: null | number;
        maxHeight?: null | number;
        maxWidth?: null | number;
        style?: null | TextStyle;
        text: string;
        type: "text";
        weight?: null | TextWeight;
        width?: null | number;
        wrap?: null | TextWrapMode;
    }
    Index

    Properties

    align? backgroundColor? color? fontFamily? fontSize height? id? lineHeight? maxHeight? maxWidth? style? text type weight? width? wrap?

    Properties

    align?: null | HorizontalAlign

    (default="left") Text align.

    Text

    backgroundColor?: null | string

    (default="#00000000") Background color in #RRGGBBAA format.

    Text

    color?: null | string

    (default="#FFFFFFFF") Font color in #RRGGBBAA format.

    Text

    fontFamily?: null | string

    (default="Verdana") Font family. Provide family-name for a specific font. "generic-family" values like e.g. "sans-serif" will not work.

    Text

    fontSize: number

    Font size in pixels.

    Text

    height?: null | number

    Height of a texture that text will be rendered on. If not provided, the resulting texture will be sized based on the defined text but limited to max_height value. It's an error to provide height if width is not defined.

    Text

    id?: null | string

    Id of a component.

    Text

    lineHeight?: null | number

    Distance between lines in pixels. Defaults to the value of the font_size property.

    Text

    maxHeight?: null | number

    (default=4320) Maximal height. Limits the height of the texture that the text will be rendered on. Value is ignored if height is defined.

    Text

    maxWidth?: null | number

    (default=7682) Maximal width. Limits the width of the texture that the text will be rendered on. Value is ignored if width is defined.

    Text

    style?: null | TextStyle

    (default="normal") Font style. The selected font needs to support the specified style.

    Text

    text

    text: string

    Text that will be rendered.

    Text

    type: "text"

    Text

    weight?: null | TextWeight

    (default="normal") Font weight. The selected font needs to support the specified weight.

    Text

    width?: null | number

    Width of a texture that text will be rendered on. If not provided, the resulting texture will be sized based on the defined text but limited to max_width value.

    Text

    wrap?: null | TextWrapMode

    (default="none") Text wrapping options.

    Text

    Settings

    Member Visibility

    On This Page

    Properties