figureone
    Preparing search index...

    Type Alias OBJ_Text

    OBJ_Text: {
        text?: string | string[];
        location?: TypeParsablePoint | TypeParsablePoint[];
        font?: OBJ_Font;
        xAlign?: "left" | "center" | "right";
        yAlign?: "top" | "bottom" | "middle" | "alphabetic" | "baseline";
        adjustments?: OBJ_TextAdjustments;
        border?:
            | TypeParsableBuffer
            | TypeParsableBorder
            | "buffer"
            | "draw"
            | "rect";
        touchBorder?: | TypeParsableBuffer
        | TypeParsableBorder
        | "rect"
        | "border"
        | "buffer"
        | "draw";
    } & OBJ_FigurePrimitive

    Text options object that extends OBJ_FigurePrimitive.

    A text element can either be defined as a single string, or an array of strings combined with an array of locations.

    The adjustments property allows customization of the borders around the text. This may be needed when the browser or FigureOne does not accurately calculate the size of the text (usually for non-standard fonts, and sometimes italized fonts).

    Atlernately border and touchBorder can also be used for complete customization.

    All text in this element will use the same font, x and y alignment, and adjustments.

    Note - Text can be rendered to either the WebGL canvas or the 2D canvas using the render property in font. For more information, see OBJ_Font.

    To test examples, append them to the boilerplate

    // Simple text
    figure.add({
      make: 'text',
      text: 'Hello World',
    });

    // Custom Font
    figure.add({
      make: 'text',
      text: 'Hello World',
      font: { family: 'Times New Roman', style: 'italic', underline: true },
    });

    // Aligned text
    figure.add({
      make: 'text',
      text: 'Aligned Text',
      xAlign: 'center',
      yAlign: 'top',
      color: [0, 0, 1, 1],
    });

    // Multi Text
    figure.add({
      make: 'text',
      text: ['0', '1', '2'],
      location: [[-0.5, -0.5], [0, 0.5], [0.5, -0.5]],
    });

    // Change Text
    t = figure.add({
      make: 'text',
      text: 'Hello World',
    });
    t.setText('Changed Text')

    // Change text and options
    t = figure.add({
      make: 'text',
      text: 'Hello World',
    });
    t.setText({
      text: 'Changed Text',
      xAlign: 'center',
      font: { family: 'Times New Roman' },
    });

    Settings

    Member Visibility