Function: applyBoost()

function applyBoost(boost): Promise<void>;

Apply a boost to the map. Validates boost type and required fields.

Boosts drive the map into a specific state: ROUTING renders a wayfinding itinerary, SELECT programmatically selects an entity (equivalent to user tap). Use createBoostRouting and createBoostSelect factory helpers to build the correct shape.

Parameters

Parameter	Type
boost	Boost

Returns

Promise<void>

Throws

MAPSTED-1012 when boost is null or undefined.

Throws

MAPSTED-1071 when the boost shape is invalid (wrong type, missing routing string for ROUTING boost, or non-numeric entity for SELECT boost).

Throws

MAPSTED-1090 when the API is not READY.