Skip to main content

RouteOptions

wemap-sdk-js

Interface: RouteOptions

Options for route calculation

Properties​

departureDate?​

optional departureDate?: Date | null

Departure date/time for the route (useful for transit routes)

isWheelchair?​

optional isWheelchair?: boolean

Whether to avoid stairs and escalators (PMR - Person with Reduced Mobility)

itineraryRules?​

optional itineraryRules?: string[]

Itinerary rules to apply to the route

optimizeWaypoints?​

optional optimizeWaypoints?: boolean

Reorder waypoints for the shortest overall route instead of visiting them in the given order. Leave unset/false for imposed-access routing where the order matters (e.g. force a path through a specific door).

waypoints?​

optional waypoints?: LatLngLike[]

Intermediate stops the route must pass through, in order, between origin and destination. Enables imposed-access routing (e.g. force a path through a specific door).