CircleElementCreate
Last updated
Was this helpful?
JS SDK API Reference
Last updated
Was this helpful?
type:
"Circle"
radius:
number
The radius of the circle in meters.
center:
The center of the circle.
optionalgroupId: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.
optionalcolor:string
The color of the element in some CSS-like format.
optionalname: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.
optionaldescription: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.
optionalattributes: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.
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.
optionalimageUrl:null|string
The URL of an image that has been added to the element.
optionalstrokeOpacity:number
A value between 0 and 1 that describes the opacity of the element's stroke.
optionalstrokeWidth:number
The width of the element's stroke in pixels.
optionalstrokeStyle:"solid"|"dashed"|"dotted"
The style of the element's stroke.
optionalradiusMarker:boolean
Whether to show a marker on the circle that indicates the radius
optionalradiusDisplayAngle:number
The angle at which the control point for setting the radius is displayed,
in degrees. When the radiusMarker is true, there is a dotted line rendered
from the center of the circle to the control point, and the marker is shown
at the midpoint of this line.
optionalradiusDisplayUnit:null|"meter"|"kilometer"|"foot"|"mile"
The unit of the radius used when the radiusMarker is true.
A value of null means that the unit matches the user's locale.
optionalfillOpacity:number
The opacity of the circle's fill.