Class: RoutingRequest

bemap.RoutingRequest(optionsopt)

new RoutingRequest(optionsopt)

BeNomad BeMap JavaScript API - RoutingRequest Typed request for `bemap.RoutingV2.calculate(request)`. Wire shape mirrors the BeMap server contract (cross-checked against `bemap-flutter-api/lib/service/routing/model/request/routing_request.dart`). Endpoint: `POST service/routing/1.0`. Required wire fields: `destinations`, `routingCriterias`, `options`, `outputLanguage`.
Parameters:
Name Type Attributes Description
options Object <optional>
Properties
Name Type Attributes Default Description
destinations Array.<(bemap.RoutingDestination|bemap.Coordinate|bemap.CoordinateSat|Object)> <optional>
Single flat list. First = origin, last = destination, anything between = via. Bare coordinates auto-promoted to `RoutingDestination` at serialisation time.
routingCriterias Array.<String> <optional>
Subset of `bemap.RoutingCriteria.*`. Defaults to ['FASTEST'].
options Array.<String> <optional>
Subset of `bemap.RoutingOptions.*`. Defaults to ['POLYLINE'].
outputLanguage String <optional>
'en' ISO 639-1 language code for instructions.
routingMode String <optional>
One of `bemap.RoutingMode.*`. Server default is MODE_VIAS.
routingVehicleProfile bemap.RoutingVehicleProfile <optional>
preferredRoads Array.<Object> <optional>
routingRoadBlocks Array.<Object> <optional>
avoidCountryCodes Array.<String> <optional>
ISO-3166 Alpha-3 codes.
xyRadius Number <optional>
Maximum snap radius around input points.
departureTime Date | Number | String <optional>
Epoch ms / Date / ISO local datetime.
arrivalTime Date | Number | String <optional>
Arrive-by time (epoch ms / Date / ISO). Alternative to departureTime.
isoChroneLimit Number <optional>
Required for MODE_ISOCHRONE.
corridorRadius Number <optional>
fenceShapes Array.<Object> <optional>
maxAlternativeRoutes Number <optional>
0 .. 2
routingChargeFeature Object <optional>
matrixStartCount Number <optional>
customData Array.<Object> <optional>
geoserver String <optional>
Override Context geoserver.
switchIndex Number <optional>
requestId String <optional>
Client-side id (used by .cancel()).
Since:
  • 1.5.0
Source: