SDK JS
    Preparing search index...

    Interface BillboardInstancesLayerOptions

    Options for BillboardInstancesLayer. id, atlas and a non-empty instances are required; everything else defaults. The atlas is the shared sprite sheet every instance indexes through its symbolId, and sizeScale is the one knob most callers reach for — a global multiplier on the on-screen size each atlas symbol declares.

    interface BillboardInstancesLayerOptions {
        alphaCutoff?: number;
        atlas: BillboardSpriteAtlas;
        grid?: number;
        id: string;
        instances: readonly BillboardInstance[];
        onError?: (error: unknown) => void;
        onLoaded?: () => void;
        opacity?: number;
        sizeScale?: number;
        visible?: boolean;
    }
    Index

    Properties

    alphaCutoff? atlas grid? id instances onError? onLoaded? opacity? sizeScale? visible?

    Properties

    alphaCutoff?: number

    Alpha-test cutoff (default 0.5) — fragments below this alpha are discarded.

    atlas: BillboardSpriteAtlas

    The shared sprite atlas (image + width/height + the symbols UV table). Each instance's symbolId indexes its symbols.

    grid?: number

    Requantization grid (m) for the i32 position buffer (default 0.001 = 1 mm).

    id: string

    MapLibre layer id (must be unique within the map).

    instances: readonly BillboardInstance[]

    Where to place the billboards — each a BillboardInstance (position, symbolId, optional heading).

    onError?: (error: unknown) => void

    Fired if setup fails (e.g. empty instances).

    onLoaded?: () => void

    Fired once the billboards are uploaded and rendering.

    opacity?: number

    Initial opacity 0–1 (default 1).

    sizeScale?: number

    Global on-screen size multiplier (default 1).

    visible?: boolean

    Initial visibility (default true).

    Settings

    Member Visibility

    On This Page

    Properties