1.6.0

Minor Changes

• 160ca6d: Implement getFeatures method on LayersController

• 6a1e536: Widen allowed boundary types

• 56077be: Add setLayerBoundary, getLayerBoundaries, onLayerBoundaryChange

1.5.1

Patch Changes

• ac68984: Update getLayerSchema example

1.5.0

Minor Changes

• d327b46: Add afterCreation option in pin tool settings to control what happens after creating a Place

• 6a66d40: Add updateLayer and expand createLayersFromGeoJson options

• 6504fea: Change documentation for getElementGeoemtry to document Highlighter and Marker functionality, and allow holes in Highlighter geometry

• cf6711e: Make programmatic element CRUD types more accurate

• 4c83c60: Add programmatic element creation, editing and deletion

• 46e8ddc: Add onElementChange and onElementDelete

• 3e87812: Adds APIs to use Felt's drawing tools on read-only maps

• d877a83: Add getFeature for getting a single feature as GeoJSON with full detail geometry

• 7f1d6aa: Add "interaction" to element schema

• cf1dd7c: Improve Text and Note types and docs

• 1f6a386: Add getViewportConstraints and setViewportConstraints methods definition

• b059b70: Add onLayerFiltersChange to allow listening to changes to layer filters, be it ephemeral, style or widget filters that changed.

• 19b41ce: Improve createLayer API

• c20e605: Add setLayerLegendVisibility and setLayerGroupLegendVisibility methods definition

• cbfd3fd: Reject promises when method handlers are invalid

• 0915f48: Add showLayerDataTable and hideLayerDataTable methods

• 9620df9: Change Circle.coordinates for Circle.center

• 63c3042: Add getLayerSchema method

• 69cc0a9: Fix spelling mistake in types

• 87304d8: Fix geometry filter type

• 1f22654: Add screen point to pointer events

• b0e4149: Improves type readability and docs

• 65bf269: Add createLayer and deleteLayer

• 4bd0ae9: Add getMapDetails method definition

• 5f903fb: Update Layer type and createLayerFromGeoJson to separate out Source concept

• 597a8d6: Return coordinates on Circle and Place elements as they are only a single point.

• f2f4289: Add layer stats methods

Patch Changes

• 993fd44: Allow workers to be SDK clients

• 417b8f4: Fixes incorrect value in documentation and updates links to other methods

• 9620df9: Improve element docs

• f0892c4: Improve documentation

• bb79037: Fix per-geometry styling for created layers

1.4.0

Minor Changes

• 555a25a: Add clearSelection method

• 1f5d950: Add option to pass auth token when embedding

1.3.0

Minor Changes

• 4bbde62: Allow setting a note to show with layer filters

1.2.0

Minor Changes

• 7badd4b: Add onMapIdle event

• 41efd53: Add selectFeature method to select feature by layer and feature ID

• 208c492: Add areaQuery param to getRenderedFeatures

1.1.0

Minor Changes

• 5f607ec: Return style with layers, and allow updating layer styles via setLayerStyle

Patch Changes

• 3a8bec8: Fix API reference link in README

1.0.2

Major Changes

• Release v1 of Felt JS SDK

The constraints to apply when getting elements.

Properties

ids?

optional ids: string[]

The ids of the elements to get.

The constraints to apply when getting element groups.

Properties

ids?

optional ids: string[]

The ids of the element groups to get.

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

"#C93535"

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.

type

type: "Highlighter"

renderHoles

renderHoles: boolean

Whether to render the holes of the highlighted area.

Default

false

opacity

opacity: number

The opacity of the highlighter, between 0 and 1.

Default

0.5

interaction?

optional interaction: "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

"default"

Properties

id

id: string

The unique identifier for the element.

type

type: "Image"

groupId?

optional 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.

name?

optional 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?

optional 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?

optional 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.

interaction?

optional interaction: "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

"default"

coordinates?

optional coordinates: [number, number][][] = MultiLineStringGeometrySchema.shape.coordinates

imageUrl?

optional imageUrl: string

The URL of the image that is rendered in this element

opacity?

optional opacity: number

The opacity of the image, between 0 and 1.

Default

1

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.

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.

type

type: "Image"

imageUrl

imageUrl: string

The URL of the image that is rendered in this element

opacity

opacity: number

The opacity of the image, between 0 and 1.

Default

1

interaction?

optional interaction: "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

"default"

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

"#C93535"

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.

type

type: "Link"

url

url: string

The URL of the link that is rendered in this element.

interaction?

optional interaction: "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

"default"

Properties

type

type: "Image"

coordinates

coordinates: [number, number][][] = MultiLineStringGeometrySchema.shape.coordinates

imageUrl

imageUrl: string

The URL of the image that is rendered in this element

groupId?

optional 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.

name?

optional 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?

optional 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?

optional 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.

interaction?

optional interaction: "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

"default"

opacity?

optional opacity: number

The opacity of the image, between 0 and 1.

Default

1

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

"#C93535"

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.

type

type: "Marker"

opacity

opacity: number

The opacity of the marker, between 0 and 1.

Default

1

size

size: number

The size of the marker, used in conjunction with the zoom to determine the actual size of the marker.

Default

10

zoom

zoom: number

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

When creating a marker, if you don't supply this value it defaults to the current zoom of the map when you call createElement.

interaction?

optional interaction: "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

"default"

To get started:

import { Felt } from "@feltmaps/js-sdk";

const felt = await Felt.embed(
  document.querySelector("#container"),
  "FELT_MAP_ID",
  {
    uiControls: {
      cooperativeGestures: false,
      fullScreenButton: false,
      showLegend: false,
    },
  }
);
const layers = await map.getLayers();

Documents

Modules

Properties

id

id: string

The unique identifier for the element.

type

type: "Circle"

groupId?

optional 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?

optional color: string

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

Example

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

Default

"#C93535"

name?

optional 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?

optional 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?

optional 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.

interaction?

optional interaction: "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

"default"

imageUrl?

optional imageUrl: null | string

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

strokeOpacity?

optional strokeOpacity: number

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

Default

1

strokeWidth?

optional strokeWidth: number

The width of the element's stroke in pixels.

Default

2

strokeStyle?

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

The style of the element's stroke.

Default

"solid"

radius?

optional radius: number

The radius of the circle in meters.

radiusMarker?

optional radiusMarker: boolean

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

Default

false

radiusDisplayAngle?

optional radiusDisplayAngle: 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.

Default

90

radiusDisplayUnit?

optional radiusDisplayUnit: 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.

Default

null

fillOpacity?

optional fillOpacity: number

The opacity of the circle's fill.

Default

0.25

center?

The center of the circle.

Properties

type

type: "Circle"

radius

radius: number

The radius of the circle in meters.

center

The center of the circle.

groupId?

optional 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?

optional color: string

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

Example

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

Default

"#C93535"

name?

optional 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?

optional 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?

optional 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.

interaction?

optional interaction: "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

"default"

imageUrl?

optional imageUrl: null | string

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

strokeOpacity?

optional strokeOpacity: number

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

Default

1

strokeWidth?

optional strokeWidth: number

The width of the element's stroke in pixels.

Default

2

strokeStyle?

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

The style of the element's stroke.

Default

"solid"

radiusMarker?

optional radiusMarker: boolean

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

Default

false

radiusDisplayAngle?

optional radiusDisplayAngle: 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.

Default

90

radiusDisplayUnit?

optional radiusDisplayUnit: 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.

Default

null

fillOpacity?

optional fillOpacity: number

The opacity of the circle's fill.

Default

0.25

Properties

element

The new data for the element or null if the element was removed.

isBeingCreated

isBeingCreated: boolean

Whether or not this element is still being created by a drawing tool.

For example, if the user begins drawing a polygon, they need to place multiple points until they've ultimately completed the polygon. All the time they are still placing points, this will be true.

For elements that require text entry (such as Places, Text and Notes) this will be true all the time the user is typing text until the point at which the user finishes, by pressing Escape for example.

If the user is editing an existing element, this will be false.

For elements that are created programatically, this will be false.

Properties

elementGroup

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

"#C93535"

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.

strokeOpacity

strokeOpacity: number

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

Default

1

strokeWidth

strokeWidth: number

The width of the element's stroke in pixels.

Default

2

strokeStyle

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

The style of the element's stroke.

Default

"solid"

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

false

radiusDisplayAngle

radiusDisplayAngle: 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.

Default

90

radiusDisplayUnit

radiusDisplayUnit: 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.

Default

null

fillOpacity

fillOpacity: number

The opacity of the circle's fill.

Default

0.25

center

The center of the circle.

interaction?

optional interaction: "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

"default"

Properties

id

id: string

A string identifying the element group.

name

name: string

The name of the element group. This is shown in the legend.

caption

caption: null | string

The caption of the element group. This is shown in the legend.

elementIds

elementIds: string[]

The ids of the elements in the element group.

Remarks

visible

visible: boolean

Whether the element group is visible or not.

shownInLegend

shownInLegend: boolean

Whether the element group is shown in the legend or not.

The Elements controller allows you to get information about the elements on the map, and make changes to their visibility.

Extended by

Methods

getElement()

Get a single element from the map by its id.

Parameters

Returns

The requested element.

Example

const element = await felt.getElement("element-1");

getElementGeometry()

Get the geometry of an element in GeoJSON geometry format.

For most element types, the geometry returned is based on the coordinates property of the element, with some differences:

• For Circle elements, the geometry is a Polygon drawn from the center andradius properties.

• Path elements become MultiLineString geometries.

• Marker elements return a MultiLineString of the path traced by the user as they drew the marker. Note that this is not the polygon formed by filled-in "pen" stroke, which doesn't exactly follow the path traced by the user as it is smoothed and interpolated to create a continuous line.

• Text, Note and Image elements do not return geometry, so will return null.

Parameters

Returns

Example

const geometry = await felt.getElementGeometry("element-1");
console.log(geometry?.type, geometry?.coordinates);

getElements()

Gets elements from the map, according to the constraints supplied. If no constraints are supplied, all elements will be returned.

Parameters

Returns

All elements on the map.

Remarks

The elements in the map, ordered by the order specified in Felt. This is not necessarily the order that they are drawn in, as Felt draws points above lines and lines above polygons, for instance.

Example

const elements = await felt.getElements();

getElementGroup()

Get an element group from the map by its id.

Parameters

Returns

The requested element group.

Example

const elementGroup = await felt.getElementGroup("element-group-1");

getElementGroups()

Gets element groups from the map, according to the filters supplied. If no constraints are supplied, all element groups will be returned in rendering order.

Parameters

Returns

The requested element groups.

Example

const elementGroups = await felt.getElementGroups({ ids: ["element-group-1", "element-group-2"] });

setElementGroupVisibility()

Hide or show element groups with the given ids.

Parameters

Returns

Promise<void>

Example

felt.setElementGroupVisibility({ show: ["element-group-1", "element-group-2"], hide: ["element-group-3"] });

createElement()

Create a new element on the map.

Parameters

Returns

Example

const element = await felt.createElement({ type: "Place", coordinates: [10, 10] });

updateElement()

Update an element on the map.

Parameters

Returns

Example

// Update a place element's coordinates
await felt.updateElement({
  id: "element-1",
  coordinates: [10, 20]
});

// Update a polygon's style
await felt.updateElement({
  id: "element-2",
  color: "#ABC123",
  fillOpacity: 0.5
});

deleteElement()

deleteElement(id: string): Promise<void>

Delete an element from the map.

Parameters

Returns

Promise<void>

Example

await felt.deleteElement("element-1");

Events

onElementCreate()

Adds a listener for when an element is created.

Parameters

Returns

VoidFunction

A function to unsubscribe from the listener

Example

const unsubscribe = felt.onElementCreate({
  handler: (element) => console.log(element.id),
});

// later on...
unsubscribe();

onElementCreateEnd()

Listens for when a new element is finished being created by a drawing tool.

For example, when creating a polygon, the user places a series of points then finishes by pressing Enter or Escape. Or when creating a Place element, they add the marker, type a label, then finally deselect the element.

Parameters

Returns

VoidFunction

A function to unsubscribe from the listener

Example

const unsubscribe = felt.onToolCreatedElement({
  handler: (params) => console.log(params),
});

// later on...
unsubscribe();

onElementChange()

Adds a listener for when an element changes.

This will fire when an element is being edited, either on the map by the user or programatically.

Parameters

Returns

VoidFunction

A function to unsubscribe from the listener

Example

const unsubscribe = felt.onElementChange({
  options: { id: "element-1" },
  handler: ({element}) => console.log(element.id),
});

// later on...
unsubscribe();

onElementDelete()

onElementDelete(args: { options: { id: string; }; handler: () => void; }): VoidFunction

Adds a listener for when an element is deleted.

Parameters

Returns

VoidFunction

A function to unsubscribe from the listener

Example

const unsubscribe = felt.onElementDelete({
  options: { id: "element-1" },
  handler: () => console.log("element-1 deleted"),
});

// later on...
unsubscribe();

onElementGroupChange()

Adds a listener for when an element group changes.

Parameters

Returns

VoidFunction

A function to unsubscribe from the listener

Example

const unsubscribe = felt.onElementGroupChange({
  options: { id: "element-group-1" },
  handler: elementGroup => console.log(elementGroup.id),
});

// later on...
unsubscribe();

Properties

type

type: "Highlighter"

coordinates

A multipolygon describing the area that is highlighted.

If renderHoles is set to false, only the outer ring of each polygon will be rendered, filling in the area inside the highlighted region.

groupId?

optional 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?

optional color: string

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

Example

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

Default

"#C93535"

name?

optional 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?

optional 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?

optional 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.

interaction?

optional interaction: "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

"default"

renderHoles?

optional renderHoles: boolean

Whether to render the holes of the highlighted area.

Default

false

opacity?

optional opacity: number

The opacity of the highlighter, between 0 and 1.

Default

0.5

Properties

id

id: string

The unique identifier for the element.

type

type: "Highlighter"

groupId?

optional 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?

optional color: string

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

Example

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

Default

"#C93535"

name?

optional 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?

optional 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?

optional 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.

interaction?

optional interaction: "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

"default"

renderHoles?

optional renderHoles: boolean

Whether to render the holes of the highlighted area.

Default

false

opacity?

optional opacity: number

The opacity of the highlighter, between 0 and 1.

Default

0.5

coordinates?

A multipolygon describing the area that is highlighted.

If renderHoles is set to false, only the outer ring of each polygon will be rendered, filling in the area inside the highlighted region.

Properties

type

type: "Marker"

coordinates

groupId?

optional 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?

optional color: string

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

Example

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

Default

"#C93535"

name?

optional 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?

optional 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?

optional 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.

interaction?

optional interaction: "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

"default"

opacity?

optional opacity: number

The opacity of the marker, between 0 and 1.

Default

1

size?

optional size: number

The size of the marker, used in conjunction with the zoom to determine the actual size of the marker.

Default

10

zoom?

optional zoom: number

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

When creating a marker, if you don't supply this value it defaults to the current zoom of the map when you call createElement.

Properties

id

id: string

The unique identifier for the element.

type

type: "Marker"

groupId?

optional 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?

optional color: string

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

Example

Default

name?

optional 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?

optional 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?

optional 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.

interaction?

optional interaction: "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

opacity?

optional opacity: number

The opacity of the marker, between 0 and 1.

Default

size?

optional size: number

The size of the marker, used in conjunction with the zoom to determine the actual size of the marker.

Default

zoom?

optional zoom: number

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

When creating a marker, if you don't supply this value it defaults to the current zoom of the map when you call createElement.

coordinates?

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

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 the zoom 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 the scale 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 call createElement.

text

text: string

The text in the element.

align

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

The alignment of the text, either left, center or right.

Default

style

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

The style of the text, either italic, light, regular or caps.

Default

name

name: string

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

Remarks

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

type

type: "Note"

widthScale

widthScale: number

position

The geographical position of the center of the note element.

interaction?

optional interaction: "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

Properties

type

type: "Note"

text

text: string

groupId?

optional 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?

optional color: string

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

Example

Default

description?

optional 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?

optional 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.

interaction?

optional interaction: "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

rotation?

optional rotation: number

The rotation of the element in degrees.

Default

scale?

optional scale: number

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

Default

zoom?

optional zoom: number

The zoom level at which the element was created. This is combined with the scale 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 call createElement.

align?

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

The alignment of the text, either left, center or right.

Default

style?

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

The style of the text, either italic, light, regular or caps.

Default

widthScale?

optional widthScale: number

position?

The geographical position of the center of the note element.

If this is omitted, the note will be placed at the center of the current viewport.

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.

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: "Path"

distanceMarker

distanceMarker: boolean

Whether a distance marker is shown at the midpoint of the path.

Default

routingMode

routingMode: null | "driving" | "cycling" | "walking" | "flying"

Whether this represents a route, and if so, what mode of transport is used.

If this is null, the path is not considered to be a route, so while it can have a distanceMarker, it will does not have a start or end cap.

Default

endCaps

endCaps: boolean

Whether or not to show Start and End caps on the path. This is only available if the routingMode is set.

Default

interaction?

optional interaction: "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

Properties

id

id: string

The unique identifier for the element.

type

type: "Place"

groupId?

optional 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?

optional color: string

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

Example

Default

name?

optional 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?

optional 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?

optional 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.

interaction?

optional interaction: "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

imageUrl?

optional imageUrl: null | string

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

symbol?

optional 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?

optional 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?

optional 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?

Properties

id

id: string

The unique identifier for the element.

type

type: "Note"

groupId?

optional 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?

optional color: string

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

Example

Default

description?

optional 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?

optional 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.

interaction?

optional interaction: "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

rotation?

optional rotation: number

The rotation of the element in degrees.

Default

scale?

optional scale: number

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

Default

zoom?

optional zoom: number

The zoom level at which the element was created. This is combined with the scale 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 call createElement.

text?

optional text: string

The text in the element.

align?

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

The alignment of the text, either left, center or right.

Default

style?

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

The style of the text, either italic, light, regular or caps.

Default

widthScale?

optional widthScale: number

position?

The geographical position of the center of the note element.

Properties

id

id: string

The unique identifier for the element.

type

type: "Path"

groupId?

optional 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?

optional color: string

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

Example

Default

name?

optional 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?

optional 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?

optional 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.

interaction?

optional interaction: "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

imageUrl?

optional imageUrl: null | string

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

strokeOpacity?

optional strokeOpacity: number

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

Default

strokeWidth?

optional strokeWidth: number

The width of the element's stroke in pixels.

Default

strokeStyle?

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

The style of the element's stroke.

Default

distanceMarker?

optional distanceMarker: boolean

Whether a distance marker is shown at the midpoint of the path.

Default

routingMode?

optional routingMode: null | "driving" | "cycling" | "walking" | "flying"

Whether this represents a route, and if so, what mode of transport is used.

If this is null, the path is not considered to be a route, so while it can have a distanceMarker, it will does not have a start or end cap.

Default

endCaps?

optional endCaps: boolean

Whether or not to show Start and End caps on the path. This is only available if the routingMode is set.

Default

coordinates?

Properties

type

type: "Path"

coordinates

groupId?

optional 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?

optional color: string

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

Example

Default

name?

optional 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?

optional 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?

optional 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.

interaction?

optional interaction: "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

imageUrl?

optional imageUrl: null | string

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

strokeOpacity?

optional strokeOpacity: number

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

Default

strokeWidth?

optional strokeWidth: number

The width of the element's stroke in pixels.

Default

strokeStyle?

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

The style of the element's stroke.

Default

distanceMarker?

optional distanceMarker: boolean

Whether a distance marker is shown at the midpoint of the path.

Default

routingMode?

optional routingMode: null | "driving" | "cycling" | "walking" | "flying"

Whether this represents a route, and if so, what mode of transport is used.

If this is null, the path is not considered to be a route, so while it can have a distanceMarker, it will does not have a start or end cap.

Default

endCaps?

optional endCaps: boolean

Whether or not to show Start and End caps on the path. This is only available if the routingMode is set.

Default

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?

optional interaction: "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

Properties

type

type: "Polygon"

coordinates

groupId?

optional 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?

optional color: string

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

Example

Default

name?

optional 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?

optional 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?

optional 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.

interaction?

optional interaction: "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

imageUrl?

optional imageUrl: null | string

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

strokeOpacity?

optional strokeOpacity: number

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

Default

strokeWidth?

optional strokeWidth: number

The width of the element's stroke in pixels.

Default

strokeStyle?

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

The style of the element's stroke.

Default

fillOpacity?

optional fillOpacity: number

The opacity of the polygon's fill, between 0 and 1.

Default

areaMarker?

optional areaMarker: boolean

Whether to show an area marker on the polygon.

Default

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