The styling and camera options for a route rendered by MPDirectionsRenderer.

Applied with setOptions, which restyles an already rendered route in place.

Every property is optional and resolves on its own, in this order: the value set here, then the solution level default configured in the CMS, then the SDK's built-in default. An omitted property is therefore inherited rather than reset, so only the properties to override need to be given. Applying a fresh set of options clears all previous overrides.

Export

Hierarchy

  • MPDirectionsRendererOptions

Constructors

  • Private

    Creates an instance of MPDirectionsRendererOptions.

    Parameters

    • Optional strokeColor: string
    • Optional strokeOpacity: number
    • Optional strokeWeight: number
    • Optional strokeStyle: MPStrokeStyle
    • Optional backgroundColorEnabled: boolean
    • Optional backgroundColor: string
    • Optional backgroundColorOpacity: number
    • Optional backgroundColorWeight: number
    • Optional animationType: MPRouteAnimationType
    • Optional animationSpeed: number
    • Optional animationMinDuration: number
    • Optional animationRepeating: boolean
    • Optional forceAnimation: boolean
    • Optional animatedOverlayColor: string
    • Optional animatedOverlayOpacity: number
    • Optional animatedOverlayWeight: number
    • Optional stampType: MPRouteStampType
    • Optional stampImageUrl: string
    • Optional stampSpacing: number
    • Optional stampScale: number
    • Optional arrowStyle: MPRouteArrowStyle
    • Optional stampColor: string
    • Optional startDisplayRule: MPRouteMarkerDisplayRule
    • Optional endDisplayRule: MPRouteMarkerDisplayRule
    • Optional legBoundaryIcons: MPLegBoundaryIcons
    • Optional elevated: boolean
    • Optional elevationHeight: number
    • Optional fitBoundsMaxZoom: number

    Returns MPDirectionsRendererOptions

Properties

animatedOverlayColor?: string
animatedOverlayOpacity?: number
animatedOverlayWeight?: number
animationMinDuration?: number
animationRepeating?: boolean
animationSpeed?: number
animationType?: MPRouteAnimationType
arrowStyle?: MPRouteArrowStyle
backgroundColor?: string
backgroundColorEnabled?: boolean
backgroundColorOpacity?: number
backgroundColorWeight?: number
elevated?: boolean
elevationHeight?: number
endDisplayRule?: MPRouteMarkerDisplayRule
fitBoundsMaxZoom?: number
forceAnimation?: boolean
legBoundaryIcons?: MPLegBoundaryIcons
stampColor?: string
stampImageUrl?: string
stampScale?: number
stampSpacing?: number
stampType?: MPRouteStampType
startDisplayRule?: MPRouteMarkerDisplayRule
strokeColor?: string
strokeOpacity?: number
strokeStyle?: MPStrokeStyle
strokeWeight?: number

Methods

Generated using TypeDoc