Properties

id

id:string

The unique identifier for the element.

groupId

groupId:null |string

The ID of the element group that the element belongs to.For elements that are not part of a group, this will be null.

color

color:string

The color of the element in some CSS-like format.

Example

"#ABC123";"rgb(255, 0, 0)";"hsl(200, 100%, 50%)";

Default

name

name:null |string

The element's name. For elements that can show a label or text onthe map (e.g. a Place or Text element) this is the text that will be shown.

For elements such as Polygons or Paths, the name is what is shown whenthe element is selected by clicking on it.

description

description:null |string

Text describing the element, which is shown in an element's popup when itis selected.

Note that some elements are not selectable on the map, such as Notes, Textand Markers, so their description will not be shown.

attributes

attributes:Record<string,unknown>

A set of key-value pairs that can be used to store arbitrary data about the element.

This is most useful for associating additional data with an element that is notpart of the element's core data, such as a Place's address or some otherdata.

imageUrl

imageUrl:null |string

The URL of an image that has been added to the element.

strokeOpacity

strokeOpacity:number

A value between 0 and 1 that describes the opacity of the element's stroke.

Default

strokeWidth

strokeWidth:number

The width of the element's stroke in pixels.

Default

strokeStyle

strokeStyle:"solid" |"dashed" |"dotted"

The style of the element's stroke.

Default

type

type:"Circle"

radius

radius:number

The radius of the circle in meters.

radiusMarker

radiusMarker:boolean

Whether to show a marker on the circle that indicates the radius

Default

radiusDisplayAngle

radiusDisplayAngle:number

The angle at which the control point for setting the radius is displayed,in degrees. When theradiusMarker istrue, there is a dotted line renderedfrom the center of the circle to the control point, and the marker is shownat the midpoint of this line.

Default

radiusDisplayUnit

radiusDisplayUnit:null |"meter" |"kilometer" |"foot" |"mile"

The unit of the radius used when theradiusMarker istrue.

A value ofnull means that the unit matches the user's locale.

Default

fillOpacity

fillOpacity:number

The opacity of the circle's fill.

Default

center

center:LngLatTuple

The center of the circle.

interaction?

optionalinteraction:"default" |"locked"

Whether the element is interactive.

Thedefault interaction mode means that the element can be selected and edited bythe user, if it was created by the SDK or by the user using a tool.

If the interaction mode islocked, the element will not be editable by the user,which is often used for elements that you don't want the user to edit or move byaccident.

Elements that were created by the map author (i.e. not during an SDK "session") arenot editable and have special behaviour depending on their name, description andattributes.

Default

Last updated8 months ago