Type Alias OBJ_FormattedText

OBJ_FormattedText: {
    text?: (string | OBJ_TextLineDefinition)[] | string;
    modifiers?: OBJ_TextModifiersDefinition | { eqn?: TypeEquationPhrase };
    elements?: EQN_EquationElements;
    font?: OBJ_Font;
    defaultTextTouchBorder?: TypeParsableBuffer;
    justify?: "left" | "center" | "right";
    lineSpace?: number;
    baselineSpace?: number;
    xAlign?: "left" | "right" | "center";
    yAlign?: "bottom" | "baseline" | "middle" | "top";
    border?:
        | TypeParsableBuffer
        | TypeParsableBorder
        | "children"
        | "rect"
        | number;
    touchBorder?: | TypeParsableBuffer
    | TypeParsableBorder
    | "border"
    | "children"
    | "rect"
    | number;
    accent?: OBJ_Font;
} & OBJ_Collection

FormattedText options object that extends OBJ_Collection options object (without parent).

Formatted text allows:

Use of more than one font
Multi-line text
Embedded equations
Interactivity on select strings

If text is defined as an array of strings of line definition objects, then each element of the array will be a new line of text.

All text will be laid out with the default font (or default line font if a line definition object is used).

To modify the font of portions of text within a line, surround the text to modify with '|' characters. The string surrounded by the '|' characters will then be a unique identifier that can be referenced in the modifiers property which will then allow for replacing that text with some other text, changing the font of the text, changing the touchability of the text and/or replacing the text with an embedded equation.

If a string is surrounded by '|' characters but not defined in modifiers then that string will have the formmating of the accent property applied to it.

Type Alias OBJ_FormattedText

Settings