@watergis/maplibre-gl-terradraw
    Preparing search index...

    Interface ValhallaOptions

    interface ValhallaOptions {
        isochroneOptions?: {
            contours?: Contour[];
            contourType?: "distance" | "time";
            costingModel?: "auto" | "pedestrian" | "bicycle";
        };
        routingOptions?: {
            costingModel?: "auto"
            | "pedestrian"
            | "bicycle";
            distanceUnit?: "miles" | "kilometers";
        };
        url?: string;
    }
    Index

    Properties

    isochroneOptions? routingOptions? url?

    Properties

    isochroneOptions?: {
        contours?: Contour[];
        contourType?: "distance" | "time";
        costingModel?: "auto" | "pedestrian" | "bicycle";
    }

    Type declaration

    • Optionalcontours?: Contour[]

      List of contours for isochrone API. Each contour has time, distance and color properties.

    • OptionalcontourType?: "distance" | "time"

      The type of contour to compute isochrone either 'time' or 'distance'

    • OptionalcostingModel?: "auto" | "pedestrian" | "bicycle"

      Means of transport for Valhalla isochrone API. 'auto', 'bicycle', 'pedestrian' models are available in the plugin. https://valhalla.github.io/valhalla/api/isochrone/api-reference/#costing-parameters

    routingOptions?: {
        costingModel?: "auto" | "pedestrian" | "bicycle";
        distanceUnit?: "miles" | "kilometers";
    }

    Type declaration

    url?: string

    URL of Valhalla API. Default is empty string, which means you need to set the URL before using the control. If you want to use the demo Valhalla API, set the URL to 'https://valhalla.water-gis.com'. However, this demo api is only available for Rwanda, Uganda and Kenya.

    If the URL is not set, the control constructor will throw an error.

    Please read more about how to set up your own Valhalla API at https://valhalla.github.io/valhalla/

    Settings

    Member Visibility

    On This Page

    Properties