Skip to content

Function: setEntityData()

ts
function setEntityData(entities): Promise<void>;

Replace the set of per-entity data overrides (styling / content) in bulk.

This has replace semantics: the supplied array becomes the complete set of overrides read back by getEntityData, superseding any prior setEntityData array and entities supplied via init({ entityData }). For single-entity upserts use setEntityDataById.

Parameters

ParameterTypeDescription
entitiesMapEntity[]The full array of MapEntity overrides. Required; must be an array (may be empty to clear all overrides).

Returns

Promise<void>

a promise that resolves once the entity data is sent.

Throws

MAPSTED-1013 when entities is not an array.

Throws

MAPSTED-1090 when the API is not READY.