Type Alias ElevationProfileControlOptions

ElevationProfileControlOptions: ElevationProfileOptions & {
    container?: string | HTMLDivElement;
    containerClass?: string;
    position?: "top" | "left" | "right" | "bottom";
    showButton?: boolean;
    size?: string;
    visible?: boolean;
}

Elevation profile control options

Type Declaration

  • Optionalcontainer?: string | HTMLDivElement

    DIV element to contain the control. Important: if provided, no styling is added by this control. Default: automatically created inside the map container

  • OptionalcontainerClass?: string

    A CSS class to add to the container. This is especially relevant when the options .container is not provided. Important: if provided, no styling is added by this control and even placement will have to be managed by external CSS.

    Default: ""

  • Optionalposition?: "top" | "left" | "right" | "bottom"

    Position of the elevation profile chart when shown.

    Default: "botton"

  • OptionalshowButton?: boolean

    Show the control button. If can be handy to hide it, especially if the profile is displayed in a custom container and that its visiblity is managed by logic external to this control.

    Default: true

  • Optionalsize?: string

    Size of the profile as a CSS rule. This size will be the width if the .position is "left" or "right", and will be the height if the .position is "top" or "bottom".

    Default: "30%"

  • Optionalvisible?: boolean

    If true, the elevation profile control will be visible as soon as it's ready. If false, a click on the control button (or a programmatic call to .showProfile()) will be neccesary to show the profile.

    Default: false

Was this helpful?

SDK JS
Modules
Reference
types
ElevationProfileControlOptions