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

Hierarchy

  • MPDirectionsRendererOptionsParams

Properties

animatedOverlayColor?: string

The color of the animated overlay. Defaults to strokeColor.

animatedOverlayOpacity?: number

The opacity of the animated overlay, in the range 0.0 - 1.0.

animatedOverlayWeight?: number

The width of the animated overlay, in pixels.

animationMinDuration?: number

The lower bound for the animation duration, in seconds, which keeps short routes from animating too fast.

animationRepeating?: boolean

Whether the animation repeats.

animationSpeed?: number

The animation speed, in meters per second.

animationType?: MPRouteAnimationType

The animation applied to the overlay travelling along the route line.

arrowStyle?: MPRouteArrowStyle

The arrow shape drawn when stampType is arrow.

backgroundColor?: string

The color of the background halo drawn beneath the route line.

backgroundColorEnabled?: boolean

Whether the background halo is drawn beneath the route line.

backgroundColorOpacity?: number

The opacity of the background halo, in the range 0.0 - 1.0.

backgroundColorWeight?: number

The halo padding on each side of the route line, in pixels.

elevated?: boolean

Whether 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.

elevationHeight?: number

How far the route is lifted above the ground, in meters, when elevated is true.

Mapbox only, the Google Maps SDKs keep the route flat.

endDisplayRule?: MPRouteMarkerDisplayRule

The styling of the route's destination marker.

fitBoundsMaxZoom?: number

The upper bound for the zoom level used when fitting the camera to the route.

forceAnimation?: boolean

Whether the animation plays even when the system's reduce motion setting is enabled.

legBoundaryIcons?: MPLegBoundaryIcons

The icons drawn where the route crosses a connector, by connector type.

stampColor?: string

The tint of the built-in arrow stamp. Ignored by a custom stampImageUrl.

stampImageUrl?: string

The URL of the icon repeated along the route line when stampType is custom.

stampScale?: number

The scale multiplier applied to the stamp icon, where 1.0 is the intrinsic size.

stampSpacing?: number

The distance between repeated stamps, in pixels.

stampType?: MPRouteStampType

The repeating stamp drawn along the route line.

startDisplayRule?: MPRouteMarkerDisplayRule

The styling of the route's origin marker.

strokeColor?: string

The color of the route line.

strokeOpacity?: number

The opacity of the route line, in the range 0.0 - 1.0.

strokeStyle?: MPStrokeStyle

How the route line is drawn.

strokeWeight?: number

The width of the route line, in pixels.

Generated using TypeDoc