Skip to content

Type Alias: MapOverlayMarker

ts
type MapOverlayMarker = {
  html?: string;
  id: string;
  lat?: number;
  lng?: number;
  marker?: string;
  name?: string;
};

Properties

PropertyTypeDescription
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.
idstringId of map overlay on which marker will be placed, this id can be obtained in manage-cms.
lat?numberOptional WGS84 latitude of the marker anchor. When both lat and lng are provided, the marker is placed at {lat, lng}; otherwise the iframe falls back to the underlying mapoverlay shape's polygon center.
lng?numberOptional WGS84 longitude of the marker anchor. See MapOverlayMarker.lat.
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.