SDK JS
    Preparing search index...

    Interface VectorDrapeOptions

    Configuration for enableVectorDrape. All fields optional.

    interface VectorDrapeOptions {
        atlasSize?: number;
        excludeLayers?: readonly (string | RegExp)[];
        extentCap?: number;
        followIntervalMs?: number;
        hideSourceLayers?: boolean;
        layers?: readonly DrapeReceiver[];
        maplibregl?: { Map: MapLibreMapCtor };
        opacity?: number;
        transformRequest?: RequestTransformFunction;
    }
    Index

    Properties

    atlasSize? excludeLayers? extentCap? followIntervalMs? hideSourceLayers? layers? maplibregl? opacity? transformRequest?

    Properties

    atlasSize?: number

    Atlas edge in px (default 2048; floored at 256).

    excludeLayers?: readonly (string | RegExp)[]

    Layer ids (or patterns) to EXEMPT from draping and from hideSourceLayers — for the app's own UI/tool overlays. SDK tool layers (measurement / elevation-profile / slice overlays, attribution carriers) are always exempt automatically.

    extentCap?: number

    Capture extent ≤ cap × the viewport's mercator span (horizon clamp at high pitch; default 3).

    followIntervalMs?: number

    Follow-capture throttle during camera movement, ms (default 200).

    hideSourceLayers?: boolean

    Hide the draped layers on the MAIN map while draping (they otherwise ALSO render flat above the 3D data — fine over discrete buildings, doubled over full-surface meshes). Visibility is snapshotted and restored on dispose/disable. Default false.

    layers?: readonly DrapeReceiver[]

    The 3D layers that receive the drape (each implements DrapeReceiver — every SDK 3D layer does). Add/remove later via the controller.

    maplibregl?: { Map: MapLibreMapCtor }

    Injected maplibre namespace for the hidden capture map (default: the main map's constructor).

    opacity?: number

    Global drape opacity multiplier 0–1 (default 1) — on top of the layers' own paint opacity.

    transformRequest?: RequestTransformFunction

    Forwarded to the hidden capture map (authenticated tile sources).

    Settings

    Member Visibility

    On This Page

    Properties