Optional animatedThe color of the animated overlay. Defaults to strokeColor.
Optional animatedThe opacity of the animated overlay, in the range 0.0 - 1.0.
Optional animatedThe width of the animated overlay, in pixels.
Optional animationThe lower bound for the animation duration, in seconds, which keeps short routes from animating too fast.
Optional animationWhether the animation repeats.
Optional animationThe animation speed, in meters per second.
Optional animationThe animation applied to the overlay travelling along the route line.
Optional arrowOptional backgroundThe color of the background halo drawn beneath the route line.
Optional backgroundWhether the background halo is drawn beneath the route line.
Optional backgroundThe opacity of the background halo, in the range 0.0 - 1.0.
Optional backgroundThe halo padding on each side of the route line, in pixels.
Optional elevatedWhether the whole route is lifted off the base map for a 3D effect. The lift is only visible when the camera is tilted.
Mapbox only, the Google Maps SDKs keep the route flat.
Optional elevationHow far the route is lifted above the ground, in meters, when elevated is true.
Mapbox only, the Google Maps SDKs keep the route flat.
Optional endThe styling of the route's destination marker.
Optional fitThe upper bound for the zoom level used when fitting the camera to the route.
Optional forceWhether the animation plays even when the system's reduce motion setting is enabled.
Optional legThe icons drawn where the route crosses a connector, by connector type.
Optional stampThe tint of the built-in arrow stamp. Ignored by a custom stampImageUrl.
Optional stampOptional stampThe scale multiplier applied to the stamp icon, where 1.0 is the intrinsic size.
Optional stampThe distance between repeated stamps, in pixels.
Optional stampThe repeating stamp drawn along the route line.
Optional startThe styling of the route's origin marker.
Optional strokeThe color of the route line.
Optional strokeThe opacity of the route line, in the range 0.0 - 1.0.
Optional strokeHow the route line is drawn.
Optional strokeThe width of the route line, in pixels.
Generated using TypeDoc
Parameter interface for MPDirectionsRendererOptions.
All colors are given as hex strings in the form "#RRGGBB" (e.g. "#3071D9"). Transparency is set with the matching opacity property rather than in the color itself.
Export
MPDirectionsRendererOptionsParams