Skip to content

Type Alias: CoordsData

ts
type CoordsData = {
  floor: number;
  html?: string;
  lat: number;
  lng?: number;
  long?: number;
  marker?: string;
  name?: string;
};

Options for adding element at coordinates

Properties

PropertyTypeDescription
floornumber-
html?stringOptional html string rendered in the entity popup. The iframe inspects the rendered children for data-mapsted-trigger / data-mapsted-event / data-mapsted-payload attributes — these are an internal escape-hatch inside the Mapsted Maps web iframe, NOT part of the public JS API surface and may change or be removed without a major-version bump. See the /guide/how-to/customize-popups guide ("Current public-API scope note") for the supported patterns for reacting to popup content.
latnumberLatitude of the coordinates.
lng?numberLongitude of the coordinates — conventional GIS / OpenLayers / Leaflet field name. Alias for long; normalised to long before wire transmission. See long for precedence + event-payload notes.
long?numberLongitude of the coordinates — legacy field name. Either long or lng must be provided; setCoordsData normalises lng to long before transmission to the iframe wire protocol. long takes precedence when both are supplied. coordsSelect event payloads populate long (the wire-format field name).
marker?stringCan either be html or an image url. If the string doesn't start with "<" it is assumed to be an image url.
name?stringOptional string to show on the top of the popup in a formatted fashion.