PlaceElementRead
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
Default
name
name:
null|string
The element's name. For elements that can show a label or text on the 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 when the element is selected by clicking on it.
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.
imageUrl
imageUrl:
null|string
The URL of an image that has been added to the element.
type
type:
"Place"
symbol
symbol:
string
The symbol that is rendered for the Place.
This can be an emoji by using colon-enclosed characters (e.g. ":smiley:")
or one of the symbols available in Felt's symbol library.
You can see the available symbols in the Felt UI when editing a Place
by hovering a symbol and converting the tooltip to kebab-case. For example,
the "Oil barrel" symbol is oil-barrel.
frame
frame:
null|"frame-circle"|"frame-square"
The frame that is rendered around the Place's symbol. This is only available for non-emoji symbols.
hideLabel
hideLabel:
boolean
Whether the element's label is hidden on the map. This allows you to add a name to the element and can show in popups, but not have it visible on the map.
This will also hide the faint placeholder label that is shown when an editable Place is selected.
Default
coordinates
interaction?
optionalinteraction:"default"|"locked"
Whether the element is interactive.
The default 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 is locked, 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 updated
Was this helpful?