SDK JS
    Preparing search index...

    Interface ElevationProfileWidgetOptions

    Configuration for ElevationProfileWidget. All fields optional.

    interface ElevationProfileWidgetOptions {
        defaultCollapsed?: boolean;
        samples?: number;
        surfaceLayers?: readonly SurfaceSampleable[];
        units?: UnitSystem;
    }
    Index

    Properties

    defaultCollapsed? samples? surfaceLayers? units?

    Properties

    defaultCollapsed?: boolean

    Start collapsed to a round 📈 button (expand on click; the header's ▢ re-collapses). Every other widget in the SDK has this; these two did not, so a corner shared with them could not be tidied. Default false.

    samples?: number

    Station count sampled along the drawn line (default 256, clamped [16, 2048]).

    surfaceLayers?: readonly SurfaceSampleable[]

    3D layers whose surfaces (buildings, integrated mesh) are sampled along the line and drawn as a SECOND, feature-colored chart line above the ground line (any layer exposing sampleSurfaceHeights, e.g. the mesh layers). Omitted → terrain-only profile.

    units?: UnitSystem

    Unit system for the chart labels + stats (default 'metric').

    Settings

    Member Visibility

    On This Page

    Properties