MapsIndoorsSDK/com.mapsindoors.core/MPDirectionsRendererConfig

MPDirectionsRendererConfig

Solution-level directions renderer route styling. A sparse, optional section on MPSolutionConfig, mirroring the backend contract services-shared/MapsIndoors.Core/DirectionsRendererConfig.cs.

Every value is nullable: a null field means "inherit the built-in / today's look". The backend serves a fully-populated block (defaults merged) only at data-format v >= 8; older/absent configs arrive as null and the renderer keeps its current appearance.

Read from the loaded solution config via MPSolutionConfig.getDirectionsRendererConfig, or supplied at runtime via MPDirectionsRenderer.setConfig (runtime wins).

Both map engines honour this styling. Elevation is the only Mapbox-only block (the Google Maps engine ignores it and keeps the route flat).

Constructors

MPDirectionsRendererConfig

Types

Animation

data class Animation(var type: MPRouteAnimationType? = null, var speed: Double? = null, var minAnimationTime: Double? = null, var forceAnimation: Boolean? = null, var overlay: MPDirectionsRendererConfig.Overlay? = null)

Animated overlay travelling along the route, and the styling of its streak.

Camera

data class Camera(var fitBoundsMaxZoom: Double? = null)

Camera behaviour when the map fits the rendered route.

Elevation

data class Elevation(var elevated: Boolean? = null, var heightMeters: Double? = null)

3D elevation of the route line (Mapbox v11 only). The Google Maps engine ignores it.

Halo

data class Halo(var enabled: Boolean? = null, var color: String? = null, var opacity: Double? = null, var weight: Double? = null)

Casing/outline drawn beneath the route line to improve contrast.

IconSize

data class IconSize(var width: Double? = null, var height: Double? = null)

Explicit icon dimensions in pixels.

LegBoundaryIcons

data class LegBoundaryIcons(var defaultIcon: String? = null, var elevator: String? = null, var escalator: String? = null, var stairs: String? = null, var ramp: String? = null, var wheelchairramp: String? = null, var wheelchairlift: String? = null, var ladder: String? = null, var entry: String? = null, var scale: Double? = null)

Per-connector-type leg-boundary marker icons. Keys are route step highway connector types, plus default for any other connector. Each value is an icon URL or null = inherit (type -> default -> built-in marker).

Line

data class Line(var strokeColor: String? = null, var strokeOpacity: Double? = null, var strokeWeight: Double? = null, var strokeStyle: MPStrokeStyle? = null)

Route line styling: colour, opacity, width and dash pattern.

Overlay

data class Overlay(var strokeColor: String? = null, var strokeOpacity: Double? = null, var strokeWeight: Double? = null)

Styling of the animated streak drawn over the route line.

Stamp

data class Stamp(var preset: MPRouteStampType? = null, var iconUrl: String? = null, var spacingPx: Double? = null, var scale: Double? = null, var arrowStyle: MPRouteArrowStyle? = null, var color: String? = null)

Repeated direction markers placed along the route line.

StopIcons

data class StopIcons(var numbered: Boolean? = null, var color: String? = null, var iconUrl: String? = null, var scale: Double? = null)

Styling for intermediate stop markers on a multi-stop route.

TerminiDisplayRule

data class TerminiDisplayRule(var icon: String? = null, var iconSize: MPDirectionsRendererConfig.IconSize? = null, var iconVisible: Boolean? = null, var label: String? = null, var labelVisible: Boolean? = null, var labelStyle: MPDirectionsRendererConfig.TerminiLabelStyle? = null, var zoomFrom: Double? = null, var zoomTo: Double? = null)

Slim termini display rule (D10) — only the fields meaningful at a route start/end point. Applied by MPDirectionsRenderer which builds origin/destination markers from the route's leg endpoints.

TerminiLabelStyle

data class TerminiLabelStyle(var textSize: Double? = null, var textColor: String? = null, var haloColor: String? = null, var haloWidth: Double? = null)

Text styling for a terminus marker label.