Skip to content

Function: setCoordsData()

ts
function setCoordsData(coords): Promise<void>;

Supply an array of coordinate-based data points to render on the map.

Each entry is normalised via normalizeCoordsData, which accepts either the conventional lng or the legacy long longitude field and produces the wire-format object.

Parameters

ParameterTypeDescription
coordsCoordsData[]The array of CoordsData entries. Required; must be an array. Each entry must carry a finite lng or long value.

Returns

Promise<void>

a promise that resolves once the normalised coords are sent.

Throws

MAPSTED-1013 when coords is not an array, or when any entry has no finite lng/long value (raised during normalisation).

Throws

MAPSTED-1090 when the API is not READY.