Styling the Route
Applying and overriding wayfinding route styling with MPDirectionsRenderer in the MapsIndoors Android SDK.
The Android SDK applies the same three-layer route styling as the Web and iOS SDKs, on both map providers (Google Maps and Mapbox). It is available from SDK 4.19.0, and the styling types on this page live in the com.mapsindoors.core package. Route styling resolves in three layers, and the more specific layer wins:
Solution styling (CMS)
What a solution admin configures under Solution Settings → Directions Renderer in the CMS becomes the default for the entire solution. Every app built on the solution picks it up with no code changes.
Solutions on data format v8 or later are served a complete config, with defaults that give the standard MapsIndoors look: an opaque #3071D9 line, a subtle halo and a continuous flow animation. Solutions on older data formats are served no config, and the renderer keeps its built-in look. You can read the served config with MapsIndoors.getSolution()?.config?.directionsRendererConfig.
You create the renderer from your MapControl. It reads the solution styling once, when it is created, and applies it automatically.
Setting up
Create the renderer, then request a route and hand it to the renderer. The solution styling is applied automatically:
val directionsRenderer = MPDirectionsRenderer(mapControl)
val directionsService = MPDirectionsService()
directionsService.setTravelMode(MPTravelMode.WALKING)
directionsService.setRouteResultListener { route, error ->
if (route != null) {
directionsRenderer.setRoute(route) // draws with the solution's styling applied
}
}
directionsService.query(origin, destination) // origin and destination are MPPointsetRoute() also frames the first leg with the camera and resets the selected leg and step indices to 0.

Two ways to style at runtime
Android has two runtime entry points. They cover different ground, so it helps to pick the right one up front.
setOptions(MPDirectionsRendererOptions)
setConfig(MPDirectionsRendererConfig?)
Covers
Line colour, opacity and weight; animation speed, minimum duration and repeat flag; the animated overlay
Everything in the CMS Directions Renderer settings: line, halo, animation (type and overlay), direction stamps, stop icons, connector icons, start and end markers, camera and 3D elevation
Precedence
Below the solution styling. A solution's line and animation values win over these
Above the solution styling
Shape
Immutable data class. Every property has a concrete default
Sparse. Every field is nullable, and null means inherit
Colours
@ColorInt Int, with opacity as a separate Float
Hex String (for example "#3071D9"), with opacity as a separate Double
Revert
No clear method. Apply a new options object
setConfig(null) falls back to the solution styling
Read back
getOptions() returns what you last applied, or null
getConfig() returns the effective config (runtime over solution), or null when neither is set
Use setConfig() for runtime styling. setOptions() replaces the deprecated setPolylineColors() and setAnimatedPolyline() setters, and its values only show where neither the solution nor your runtime config sets the same thing.
Overriding, reverting, and turning off
setConfig() takes an MPDirectionsRendererConfig. Every field in it is nullable:
A value overrides.
nullinherits, giving the solution value or the built-in default.An explicit value that means "off" is a real value. For example,
Halo(enabled = false)turns the halo off,Animation(type = MPRouteAnimationType.NONE)stops the animation, andStamp(preset = MPRouteStampType.NONE)removes the direction stamps.setConfig(null)removes the runtime config and falls back to the solution styling.
setConfig() takes the whole runtime config. Put every override you want in a single MPDirectionsRendererConfig and pass it in one call.
Which sections merge
line, halo and legBoundaryIcons merge field by field with the solution styling, so a one-field tweak is legal:
Every other section (animation, stamp, stopIcons, startDisplayRule, endDisplayRule, camera and elevation) is applied as a whole block. Supplying one replaces the solution's block entirely, so build the complete block you want.
Reading the effective styling
getConfig() returns the effective config: your runtime config merged over the solution-served config, or null when neither is set. In Kotlin, call it as an explicit getter:
Using MPDirectionsRendererOptions
MPDirectionsRendererOptions is an immutable data class. Every property has a concrete default, so you only name the ones you want to change:
strokeColor
@ColorInt Int
#3071D9, the MapsIndoors blue
strokeOpacity
Float, 0.0 to 1.0
1.0
strokeWeight
Float, dp
4.0
Google Maps only
strokeStyle
MPStrokeStyle (SOLID, DASHED, DOTTED)
SOLID
No effect. Use Line(strokeStyle) with setConfig()
animationSpeed
Double, metres per second
300.0
Ignored when the effective config has an animation block
animationMinDuration
Double, seconds
1.2
Ignored when the effective config has an animation block
animationRepeating
Boolean
true
animatedOverlayColor
@ColorInt Int?
null, which reuses strokeColor
Google Maps only
animatedOverlayOpacity
Float, 0.0 to 1.0
1.0
Google Maps only
animatedOverlayWeight
Float, dp
2.0
Google Maps only
fitBoundsMaxZoom
Double?
null
No effect. Use Camera(fitBoundsMaxZoom) with setConfig()
forceAnimation
Boolean
false
No effect. Use Animation(forceAnimation) with setConfig()
Options have no animation type, so to switch the animation off, or to change it to PULSE or COMET, use setConfig().
Because the object is immutable, change a value by building a new one. In Kotlin, copy() is handy:
getOptions() returns the options you most recently applied through setOptions(), or null if you have only used the deprecated setters. It is not a view of the effective styling. Use getConfig() for that. There is no clearOptions() on MPDirectionsRenderer, so to undo options, apply a new options object (or use setConfig(null) for config-based styling).
From Java, the generated overloaded constructors accept a leading subset of the same parameters, so to set strokeWeight you also pass strokeColor and strokeOpacity. new MPDirectionsRendererOptions() gives the defaults:
Common tasks
Restyle the line for a mode, then restore it
Style the halo
A contrasting outline drawn beneath the line so it stays readable over busy floor plans. The halo weight is added to each side of the line:
Change or style the animation
The available types are FLOW, PULSE, COMET and NONE. speed is in screen pixels per second, so the animation reads the same at every zoom level. Note that this differs from animationSpeed in MPDirectionsRendererOptions, which is in metres per second.
Route animation respects the system "remove animations" (reduce motion) accessibility setting. To keep it running regardless, for example on kiosks and signage, set forceAnimation:
Note that animation is a whole block, so repeat the type when you set forceAnimation.
Add direction stamps along the line
A small marker repeated along the route. Use either a built-in arrow preset or a custom icon:
The arrow styles are CHEVRON (also the fallback), CHEVRON_DOUBLE, TRIANGLE, ARROW and DART.
Put markers on the route's origin and destination
Start and end display rules are whole-block, so build the complete rule for each:
Size an icon with iconSize = MPDirectionsRendererConfig.IconSize(width = 32.0, height = 32.0), which is in density-independent pixels (dp). Use iconVisible and labelVisible to hide either part. Label styling is a nested labelStyle object:
Set icons for floor changes
An icon at each point where the route changes floor, chosen by connector type:
The connector types are elevator, escalator, stairs, ramp, wheelchairramp, wheelchairlift, ladder and, from SDK 4.23.0, entry, plus defaultIcon for any other. Note that on Android the wheelchair property names are all lowercase. Lookup order per connector: the type's own icon, then defaultIcon, then the built-in marker.
legBoundaryIcons merges field by field, so the example above keeps any solution icons for escalator, ramp and the other types it does not name.
Cap how far the route-fit zooms in
A short route should not zoom in disorientingly close:
Control the camera
The camera framing is controlled with methods on the renderer itself, not through the styling objects:
setRoute(), selectLegIndex(), nextLeg() and previousLeg() each frame the selected leg with the camera. From SDK 4.23.0, each takes an optional onCameraEvent listener that is called once, on the main thread, with MPCameraEvent.FINISHED or MPCameraEvent.CANCELLED (MPCameraEvent is in the com.mapsindoors.core.models package).
Elevate the route in 3D (Mapbox v11)
Only visible with a tilted camera and a meaningful height. The 0.3 m default reads as flat, so raise it toward the CMS maximum of 10 m to see the effect clearly. Mapbox v11 only; Google Maps ignores it.

Show or hide the whole route
The renderer has no visibility toggle. clear() removes the route from the map, and calling setRoute() again draws it, with the selected leg and step reset to 0.
Custom stop icons on multi-stop routes
Request a multi-stop route with directionsService.query(from, to, stops, optimize). The built-in pin is MPRouteStopIconConfig, which you create with its builder. It supports numbering, a colour and a label under the pin:
setColor() accepts either a @ColorInt Int or a colour String, and setLabel() adds a label under the pin. The stop-icon block of MPDirectionsRendererConfig (StopIcons) covers numbering, colour, a custom iconUrl and a scale.
When each option takes effect
Immediately, in place
Anything applied with setOptions() or setConfig() re-styles a route that is already displayed. If no route is displayed yet, apply the styling before setRoute() so the first render uses it.
When the camera frames a leg
The fitBoundsMaxZoom cap applies when setRoute(), selectLegIndex(), nextLeg() or previousLeg() frames the selected leg.
On the renderer, not the styling objects
setCameraViewFitMode(), setCameraViewTilt(), setCameraAnimationDuration(), setDefaultRouteStopIconConfig() and the icons argument of setRoute().
Engine differences
Both map engines render the same styling, with these exceptions:
3D elevation needs Mapbox v11. On Google Maps the
elevationblock is ignored and the route stays flat.Dashed lines render solid on Google Maps. Google Maps has no native dashed polyline, so
DASHEDfalls back toSOLID.DOTTEDrenders on both engines.The halo default differs. On Mapbox, a halo is drawn unless
enabledis explicitlyfalse; without acolor, it is a faint (0.3 opacity) version of the line colour. On Google Maps, a halo is only drawn whenenabledistrue. Setenabledexplicitly to get the same result on both.Custom stamp icons work on both engines. Unlike the Web SDK, a custom stamp
iconUrlis not dropped on Google Maps.Some
MPDirectionsRendererOptionsvalues are Google Maps only. Mapbox does not readstrokeWeightor theanimatedOverlay*values. UseLine(strokeWeight)andAnimation(overlay)withsetConfig()instead.
Value formats
setConfig()colours are hex strings such as"#3071D9".setOptions()colours are@ColorIntvalues such asColor.RED. In both, opacity is its own 0.0 to 1.0 field.Numeric types differ between the two APIs, and Kotlin does not convert between them.
MPDirectionsRendererOptionsusesFloatfor weights and opacities (6f), while every number inMPDirectionsRendererConfigis aDouble(8.0).Line, halo and overlay weights, and
IconSizewidth and height, are density-independent pixels (dp).Icon URLs are strings. Use absolute
httpsURLs.Zoom levels, such as
zoomFrom,zoomToandfitBoundsMaxZoom, areDouble.
Migrating from the deprecated setters
setPolylineColors() and setAnimatedPolyline() are deprecated in favour of setOptions(). They remain functional.
setPolylineColors(foreground, background):backgroundis the static route line and maps toMPDirectionsRendererOptions.strokeColor.foregroundis the animated line drawn on top and maps toanimatedOverlayColor. Halo (casing) styling is available throughMPDirectionsRendererConfig.Halo.setAnimatedPolyline()took a fixed duration per leg. Animation timing is now speed-based, with a constant speed and a minimum duration, so there is no direct equivalent of a fixed duration. UseanimationSpeedandanimationMinDurationfor timing,animationRepeatingfor the repeat flag, andMPRouteAnimationType.NONEthroughsetConfig()to switch the animation off.
Last updated
Was this helpful?
