Taos API Reference
    Preparing search index...

    Interface SymbolLayer

    A label (symbol) layer — point features whose textField property becomes a map label.

    interface SymbolLayer {
        sourceLayer: string;
        textField: string;
        rankProp?: string;
        rank?: number;
        rankBase?: number;
        maxFeatureRank?: number;
        icon?: string;
        iconField?: string;
        iconMap?: Record<string, string>;
        iconDefault?: string;
        placement?: "point" | "line";
        filter?: unknown;
    }
    Index

    Properties

    sourceLayer textField rankProp? rank? rankBase? maxFeatureRank? icon? iconField? iconMap? iconDefault? placement? filter?

    Properties

    sourceLayer: string
    textField: string

    Feature property holding the label text. Default 'name'.

    rankProp?: string

    Feature property holding a numeric priority (lower = more important), if any.

    rank?: number

    Fallback priority when rankProp is absent. Default 10.

    rankBase?: number

    Constant added to each feature's priority — pushes a whole layer below others (e.g. POIs below places/streets). Default 0.

    maxFeatureRank?: number

    Skip features whose rankProp value exceeds this — keeps only the important POIs (the poi layer carries thousands per tile). Default: no cap.

    icon?: string

    A constant marker glyph prepended to every label in this layer (must be in the atlas charset). For per-feature category icons use iconField + iconMap instead.

    iconField?: string

    Feature property to pick a per-feature icon by (e.g. 'class' for POIs).

    iconMap?: Record<string, string>

    iconField value → marker glyph char (e.g. POI_ICON_CHARS).

    iconDefault?: string

    Fallback marker when iconField's value isn't in iconMap.

    placement?: "point" | "line"

    Symbol placement: 'point' (default) or 'line' (street labels).

    filter?: unknown

    Settings

    Member Visibility

    On This Page

    Properties