Class ValhallaRouting

Valhalla routing API class

Index

Constructors

constructor

Methods

calcRoute clearFeatures getTripData getTripSummary

Constructors

constructor

new ValhallaRouting(url: string): ValhallaRouting
Constructor
Parameters
- url: string
  URL for terrain RGB raster tilesets
Returns ValhallaRouting
- Defined in src/lib/helpers/valhallaRouting.ts:139

Methods

calcRoute

calcRoute(
    tripData: LngLat[],
    costingModel: "auto" | "pedestrian" | "bicycle",
    distanceUnit: "miles" | "kilometers",
): Promise<
    | undefined
    | {
        feature: GeoJSONFeature;
        pointFeatures: { features: GeoJSONFeature[]; type: string };
    },
>
Calculate the route using Valhalla routing API.
Parameters
- tripData: LngLat[]
  array of LngLat coordinates for the trip
- costingModel: "auto" | "pedestrian" | "bicycle"
  means of transport for Valhalla routing API.
- distanceUnit: "miles" | "kilometers"
  distance unit for Valhalla routing API.
Returns Promise<
    | undefined
    | {
        feature: GeoJSONFeature;
        pointFeatures: { features: GeoJSONFeature[]; type: string };
    },
>
returns a feature with LineString geometry and point features for the trip data

Throws
Error if the trip data is invalid or if the Valhalla API returns
- Defined in src/lib/helpers/valhallaRouting.ts:159

clearFeatures

clearFeatures(): void
Clear the trip data and summary.

Returns void
- Defined in src/lib/helpers/valhallaRouting.ts:146

getTripData

getTripData(): LngLat[]
get the raw trip data from the valhalla routing API.

Returns LngLat[]
tripData
- Defined in src/lib/helpers/valhallaRouting.ts:113

getTripSummary

getTripSummary(): undefined | ValhallaTripSummary
Get the trip summary from the routing API.

Returns undefined | ValhallaTripSummary
tripSummary
- Defined in src/lib/helpers/valhallaRouting.ts:131

Class ValhallaRouting

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ValhallaRouting

Methods

calcRoute

Parameters

Returns Promise<
    | undefined
    | {
        feature: GeoJSONFeature;
        pointFeatures: { features: GeoJSONFeature[]; type: string };
    },
>

Throws

clearFeatures

Returns void

getTripData

Returns LngLat[]

getTripSummary

Returns undefined | ValhallaTripSummary

Settings

On This Page

Class ValhallaRouting

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ValhallaRouting

Methods

calcRoute

Parameters

Returns Promise< | undefined | { feature: GeoJSONFeature; pointFeatures: { features: GeoJSONFeature[]; type: string }; },>

Throws

clearFeatures

Returns void

getTripData

Returns LngLat[]

getTripSummary

Returns undefined | ValhallaTripSummary

Settings

On This Page

Returns Promise<
| undefined
| {
feature: GeoJSONFeature;
pointFeatures: { features: GeoJSONFeature[]; type: string };
},
>