Class: RoutingDestination

bemap.RoutingDestination(optionsopt)

new RoutingDestination(optionsopt)

BeNomad BeMap JavaScript API - RoutingDestination One point in a routing request (origin, intermediate via, or final destination). The order in `RoutingRequest.destinations` is significant: the first is the start, the last is the end, anything between is a via. Wire shape mirrors the BeMap server contract (cross-checked against `bemap-flutter-api/lib/service/routing/model/request/routing_destination.dart`): { coordinateSat, radius?, ignorePoint?, ignoreTrafficDirections?, ignoreRoadBlocks?, ignoreRestrictions?, avoidUTurn?, useStartAngle?, useStopRoadSide?, keptByMinimalWp?, customData? } The constructor is tolerant: pass a `bemap.Coordinate`, a `bemap.CoordinateSat`, or a plain `{lon, lat, ...}` object — it is auto-promoted to `bemap.CoordinateSat`.
Parameters:
Name Type Attributes Description
options Object <optional>
Properties
Name Type Attributes Description
coordinateSat bemap.CoordinateSat | bemap.Coordinate | Object <optional>
radius Number <optional>
Maximum snap radius in metres.
ignorePoint Boolean <optional>
Skip this waypoint in the calculation.
ignoreTrafficDirections Boolean <optional>
Ignore one-way / turn restrictions before next waypoint.
ignoreRoadBlocks Boolean <optional>
Ignore road blocks before next waypoint.
ignoreRestrictions Boolean <optional>
Ignore forbidden manoeuvres before next waypoint.
avoidUTurn Object | String <optional>
RoutingDestinationStatus passthrough.
useStartAngle Object | String <optional>
RoutingDestinationStatus passthrough.
useStopRoadSide Object | String <optional>
RoutingDestinationStatus passthrough.
keptByMinimalWp Boolean <optional>
Keep waypoint in response when NO_MINIMAL_WAYPOINTS is not set. (Backend field `mandatory`; both accepted via alias.)
stopDuration Number <optional>
Dwell/stop time at this waypoint, in seconds.
customData Array.<Object> <optional>
Custom key/value pairs.
Since:
  • 1.5.0
Source: