SDK JS
    Preparing search index...

    Interface TextLabelStyle

    How makeTextLabelAtlas rasterises each label cell. Every field is optional and falls back to a default, so {} is a valid style. font (any CSS font shorthand) sets the size and weight, and the halo pair is what keeps a label legible over imagery — haloWidth: 0 turns the outline off.

    interface TextLabelStyle {
        color?: string;
        font?: string;
        halo?: string;
        haloWidth?: number;
        maxWidth?: number;
        padding?: number;
    }
    Index

    Properties

    color? font? halo? haloWidth? maxWidth? padding?

    Properties

    color?: string

    Text fill (default white).

    font?: string

    CSS font (default 600 14px ui-sans-serif, system-ui, sans-serif).

    halo?: string

    Halo/outline colour for legibility over imagery (default translucent black).

    haloWidth?: number

    Halo width in px (default 3; 0 disables).

    maxWidth?: number

    Max atlas width before wrapping to a new shelf row (default 1024).

    padding?: number

    Padding around the glyphs in px (default 4).

    Settings

    Member Visibility

    On This Page

    Properties