Class: TraceRouteRequest

bemap.TraceRouteRequest(optionsopt)

new TraceRouteRequest(optionsopt)

BeNomad BeMap JavaScript API - TraceRouteRequest Typed request for `bemap.TraceRoute.compute(request)` and `bemap.TraceRoute.computeRnc(request)`. Map-matches a GPS trace onto the road network; the response is the same shape as `RoutingV2.calculate()`: a `bemap.RoutingResponse`. Wire shape mirrors the BeMap server contract (cross-checked against `bemap-flutter-api/lib/service/trace_route/model/request/trace_route_request.dart`). Endpoint: `POST service/routing/1.0/traceroute`. Required wire fields: `destinations` (min. 2 points), `routingVehicleProfile`.
Parameters:
Name Type Attributes Description
options Object <optional>
Properties
Name Type Attributes Description
destinations Array.<(bemap.TraceRouteDestination|bemap.CoordinateSat|bemap.Coordinate|Object)> <optional>
 Trace samples in chronological order. Mixed-input types are auto-promoted.
routingVehicleProfile bemap.RoutingVehicleProfile <optional>
 Required by the server. Defaults to a generic CAR profile when omitted.
routingCriterias Array.<String> <optional>
 Subset of `bemap.RoutingCriteria.*` (e.g. AVOID_TOLLS). Supported server-side for traceroute.
options Array.<String> <optional>
 Subset of `bemap.TraceRouteOptions.*`.
departureTime Date | Number | String <optional>
 Epoch ms / Date / ISO local datetime.
adjustEta Boolean <optional>
 Adjust ETA from GPS timestamps.
allowOffRoad Boolean <optional>
 Default true server-side.
corridorRadius Number <optional>
fenceShapes Array.<Object> <optional>
language String <optional>
 ISO 639-1.
customData Array.<Object> <optional>
preferredRoads Array.<Object> <optional>
routingRoadBlocks Array.<Object> <optional>
geoserver String <optional>
switchIndex Number <optional>
requestId String <optional>
Since:
  • 1.5.0
Source: