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

description

description:null |string

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

Note that some elements are not selectable on the map, such as Notes, Text and 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 not part of the element's core data, such as a Place's address or some other data.

rotation

rotation:number

The rotation of the element in degrees.

Default

scale

scale:number

The relative scale of the element from the default size. This is combined with thezoom to determine the actual size of the element.

Default

zoom

zoom:number

The zoom level at which the element was created. This is combined with thescale to determine the actual size of the element.

When creating an element, if you don't supply this value it defaults to the current zoom of the map when you callcreateElement.

text

text:string

The text in the element.

align

align:"center" |"left" |"right"

The alignment of the text, eitherleft,center orright.

Default

style

style:"light" |"italic" |"regular" |"caps"

The style of the text, eitheritalic,light,regular orcaps.

Default

name

name:string

The text shown in the element, which is identical to thetext property.

Remarks

This is added for consistency with other elements that have aname property.

type

type:"Note"

widthScale

widthScale:number

position

position:LngLatTuple

The geographical position of the center of the note element.

interaction?

optionalinteraction:"default" |"locked"

Whether the element is interactive.

Thedefault interaction mode means that the element can be selected and edited by the 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 by accident.

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

Default

Last updated2 months ago