The Basemaps module allows you to control the map's basemap layer, such as getting the current basemap, listing available basemaps, changing the basemap, and being notified when the basemap changes.

Controller

• BasemapsController

Interfaces

• FeltBasemap

• ColorBasemap

Properties

id

id: string

A unique identifier for the basemap.

Remarks

Do not rely on the stability of this ID for Felt basemaps, as they are subject to change.

name

name: string

The name of the basemap.

uiColorScheme

uiColorScheme: "light" | "dark"

The color scheme of the UI that goes with the basemap. It is best to set this to "light" if your basemap is broadly light, and "dark" if your basemap is broadly dark.

type: "color"

color: string

optional attribution: string

The attribution of the basemap, which is shown in the map's UI.

CustomTileBasemapInput: Omit<, "id">

ColorBasemapInput: Omit<, "id">

id: string

A unique identifier for the basemap.

Do not rely on the stability of this ID for Felt basemaps, as they are subject to change.

name: string

The name of the basemap.

uiColorScheme

id: string

A unique identifier for the basemap.

Do not rely on the stability of this ID for Felt basemaps, as they are subject to change.

name: string

The name of the basemap.

uiColorScheme

Basemap: | |

The parameters for the `onLayerGroupChange` listener.

Properties

layerGroup

layerGroup: null | LayerGroup

1.11.0

Minor Changes

• 08e2b1c: Add rotation and contextMenu UI control options, for disabling map rotation and the right-click menu via Felt.embed and updateUiControls

• dfe94af: Add raster statistics methods: getRasterAggregates, getRasterHistogramData and getRasterCategoryData, each summarizing one band of a raster layer over the whole raster, a bounding box, or a polygon, and getRasterProfile, which samples a band along a line. Raster bands now also carry an id to pass to those methods and a displayName.

• 6ae7b35: Rename the band parameter to bandId across the raster statistics methods. getRasterAggregates, getRasterHistogramData and getRasterCategoryData no longer accept a line as their boundary, and the RasterGeometryFilter type is no longer exported.

• b57ceb5: Make RasterLayerSource.encodedTileTemplateUrl nullable (string | null). TileService layers (WMS, WMTS, ArcGIS) serve pre-rendered image tiles and have no encoded tile URL.

• c3b650b: Update layer visible docs

• 6c0d014: Fix Felt.connect intermittently failing in Safari with DataCloneError by creating a fresh MessageChannel for each handshake attempt instead of re-transferring the same port

• 03be185: Add basemaps API

• 34b9ed3: Add feature actions

• f7a1b4b: Add pageSize and select to getFeatures

• 3d9527b: Add duplicateLayer method

• 6e233c6: Fix feature action types and documentation

• 7e4034f: Add support for legendDisplay on the layer

• 336538b: Improve controller method documentation

• 7b04db4: Update filter docs

• f40a75c: Update getPrecomputedAggregates types

• 4c4ebfd: Add UIIframeElement to custom ui panel

• b87393f: Better docs, types and method consistency for Custom Panels API

• aff926a: Return UIPanel on custom panel API methods

• 58bd6dd: Add isDeterministicId to LayerFeature

• 07b27c6: Export bundled controller types file for consumption as single file

• 41e1612: Update getAggregates examples to be correct

• 475c98e: Update getAggregates + MultiAggregationConfig docs

• 160ca6d: Implement getFeatures method on LayersController

• 6a1e536: Widen allowed boundary types

• 56077be: Add setLayerBoundary, getLayerBoundaries, onLayerBoundaryChange

• ac68984: Update getLayerSchema example

• 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

• 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

• 555a25a: Add clearSelection method

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

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

• 7badd4b: Add onMapIdle event

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

• 208c492: Add areaQuery param to getRenderedFeatures

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

• 3a8bec8: Fix API reference link in README

• Release v1 of Felt JS SDK

The event object passed to the interaction listeners.

Properties

coordinate

coordinate: LatLng

The cursor position in world coordinates.

point

point: { x: number; y: number; }

The pixel coordinates of the mouse cursor, relative to the map and measured from the top left corner.

features: []

The vector features that are under the cursor.

rasterValues: []

The raster pixel values that are under the cursor.

The Felt SDK lets you read, create and update elements on the map.

Elements that are created via the SDK are only available to the current session - they are not persisted to the map and not available to other users of the map.

If you want to let your users create elements (as opposed to using the SDK to create them programmatically), you can use the to select and configure the drawing tools in Felt.

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.

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: 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: 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: null | string

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

strokeOpacity: number

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

strokeWidth: number

The width of the element's stroke in pixels.

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

The style of the element's stroke.

type: "Circle"

radius: number

The radius of the circle in meters.

radiusMarker: boolean

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

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.

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.

fillOpacity: number

The opacity of the circle's fill.

center:

The center of the circle.

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.

Properties

type

type: "Circle"

radius

radius: number

The radius of the circle in meters.

center

center: LngLatTuple

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.

optional color: string

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

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.

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.

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.

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.

optional imageUrl: null | string

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

optional strokeOpacity: number

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

optional strokeWidth: number

The width of the element's stroke in pixels.

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

The style of the element's stroke.

optional radiusMarker: boolean

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

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.

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.

optional fillOpacity: number

The opacity of the circle's fill.

The constraints to apply when getting element groups.

optional ids: string[]

The ids of the element groups to get.

The constraints to apply when getting elements.

optional ids: string[]

The ids of the elements to get.

ElementCreate: | | | | | | | |

Element: PlaceElementRead | PathElementRead | PolygonElementRead | CircleElementRead | MarkerElementRead | HighlighterElementRead | TextElementRead | NoteElementRead | ImageElementRead | LinkElementRead

ElementUpdate: PlaceElementUpdate | PathElementUpdate | PolygonElementUpdate | CircleElementUpdate | MarkerElementUpdate | HighlighterElementUpdate | TextElementUpdate | NoteElementUpdate | ImageElementUpdate

AggregationMethod: "min" | "max" | "avg" | "sum" | "median"

The method to use for the aggregation.

FilterLogicGate: "and" | "or"

GeometryFilter: FeltBoundary | PolygonGeometry | MultiPolygonGeometry | LngLatTuple[]

The common type for filtering data by a spatial boundary.

This can be either:

• FeltBoundary: a [w, s, e, n] bounding box

• PolygonGeometry: a GeoJSON Polygon geometry

• MultiPolygonGeometry: a GeoJSON MultiPolygon geometry

• LngLatTuple[]: a list of coordinates describing a single ring of a polygon

FilterExpression: [null | string, "in" | "ni", null | (null | string | number | boolean)[]] | [null | string, "lt" | "gt" | "le" | "ge" | "eq" | "ne" | "cn" | "nc" | "is" | "isnt", null | string | number | boolean]

The response from the LayersController.getRasterProfile method.

Properties

samples

samples: RasterProfileSample[]

The samples, ordered from the line's start.

GridType: "h3"

The type of grid to use for precomputed aggregate values.

The basemaps controller allows you to manage the map's basemap layer.

You can get the current basemap, list available basemaps, change the basemap, and be notified when the basemap changes.

Extended by

• FeltController

Methods

getCurrentBasemap()

getCurrentBasemap(): Promise<Basemap>

Gets the currently active basemap.

Use this method to retrieve information about the current basemap, including its type (Felt, color, or custom tile), name, color scheme, and attribution.

Returns

Promise<>

A promise that resolves to the current basemap configuration.

getBasemaps(): Promise<[]>

Gets all basemaps available on the map.

Use this method to retrieve a list of all available basemaps that can be applied to the map.

Promise<[]>

A promise that resolves to all basemaps available on the map.

chooseBasemap(id: string): void

Chooses the basemap to use for the map.

Use this method to change the current basemap. The basemap ID can be obtained from getBasemaps().

void

A promise that resolves when the basemap has been set.

addCustomBasemap(args: { basemap: | ; select: boolean; }): Promise<>

Adds a custom basemap to the map. This can be either a solid color or a basemap from a custom tile URL.

Promise<>

A promise for the added basemap.

removeBasemap(id: string): Promise<void>

Removes a basemap from the list of available basemaps.

Promise<void>

A promise that resolves when the basemap has been removed.

onBasemapChange(args: { handler: (basemap: ) => void; }): VoidFunction

Adds a listener for when the basemap changes.

Use this to react to basemap changes, such as updating your UI or adjusting other map elements to match the new basemap's color scheme.

VoidFunction

A function to unsubscribe from the listener.

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

imageUrl: string

The URL of the image that is rendered in this element

opacity: number

The opacity of the image, between 0 and 1.

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.

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

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.

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.

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.

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.

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.

optional opacity: number

The opacity of the image, between 0 and 1.

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.

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.

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.

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.

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.

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

optional imageUrl: string

The URL of the image that is rendered in this element

optional opacity: number

The opacity of the image, between 0 and 1.

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: string[]

The ids of the elements in the element group.

You can use these ids to get the full element objects via the method.

visible: boolean

Whether the element group is visible or not.

shownInLegend: boolean

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

The grid configuration for an aggregated precomputed aggregate value. This requires an attribute property, because the numeric aggregation requires it.

If you just want to count the features in each grid cell, use the CountGridConfig instead, where you are not required to specify an attribute.

Used inside GetLayerPrecomputedCalculationParams.

Properties

resolution

resolution: number

The resolution of the grid to use for the precomputed calculation.

attribute

attribute: string

The attribute to use for the precomputed calculation.

This must be a numeric attribute;

type: "h3"

The type of grid to use for the precomputed calculation.

method: "min" | "max" | "avg" | "sum"

The method to use for the precomputed calculation.

The parameters for requesting a histogram of a raster band's values, passed to the method.

layerId: string

bandId: string

The ID of the band to bin, read from the bands on a raster layer's source.

The parameters for the and the listeners.

element: null |

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

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.

The Interactions module allows you to be notified when the user interacts with the map.

Interactions include clicking and hovering on points and features.

LayerProcessingStatus: "processing" | "completed" | "failed" | "incomplete"

This describes the processing status of a layer.

The various values are:

• processing

One bin from the response from the method.

min: number

The left edge of the bin.

max: number

The right edge of the bin.

value

Defines how to aggregate a value across features in a layer.

attribute: string

The attribute to use for the aggregation. This must be a numeric attribute.

method: "min" | "max" | "avg" | "sum" |

A GeoJSON data source is a layer that is populated from GeoJSON data, such as from a local file, or programmatically-created data.

type: "geoJsonData"

Identifies this as a GeoJSON data source.

data: object

The GeoJSON data for the layer.

This must be a GeoJSON FeatureCollection.

A single category from the response from the method.

key: string | number | boolean

The category for which the value was calculated.

value: null | number

The constraints to apply when getting layers.

optional ids: string[]

The ids of the layers to get.

The parameters for sampling a raster band along a line, passed to the method.

layerId: string

bandId: string

The ID of the band to sample, read from the bands on a raster layer's source.

FeltTiledVectorSource: { type: "felt"; tileTemplateUrl: string; }

A tiled vector source is a layer that is populated from data the has been uploaded to Felt, and processed into vector tiles.

type: "felt"

Identifies this as a tiled vector source. Typically, these tiles will have been uploaded to and processed by Felt.

GridConfig: |

Describes the type of grid to use for precomputed aggregate values.

The grid configuration for a count-based precomputed aggregate value. Compared to the , the attribute property is not required, because the count is the same regardless of the attribute.

Used inside .

resolution: number

The resolution of the grid to use for the precomputed calculation.

type: "h3"

The parameters for calculating a single aggregate value for a layer, passed to the method.

layerId: string

The ID of the layer to calculate an aggregate value for.

gridConfig:

The grid configuration to use for the precomputed calculation.

optional

A GeoJSON URL source is a layer that is populated from a GeoJSON file at a remote URL.

These sources are ones that have not been uploaded to and processed by Felt, and as such their capabilities are limited.

For instance, they cannot be filtered, nor can statistics be fetched for them.

type: "geoJsonUrl"

Identifies this as a GeoJSON URL source.

url: string

All the different sources for boundaries for a layer, including their combined result.

spatialFilters: null |

Boundaries set by drawing spatial filters on the map.

When there are multiple spatial filters, they are combined into a multi-polygon.

ephemeral: null |

Boundaries that are set ephemerally by viewers in their own session.

A GeoJSON file source is a layer that is populated from a GeoJSON file on your local machine.

This is an input-only type. It is converted to a when passed to .

type: "geoJsonFile"

Identifies this as a GeoJSON file source.

file: File

The GeoJSON file for the layer.

The constraints to apply when getting layer groups.

optional ids: string[]

The ids of the layer groups to get.

Layer: | |

The response from the method.

bins: []

The bins, in ascending order of value.

Constraints for the method. This can include layer constriants, spatial constraints, or both. If no constraints are provided, all rendered features will be returned.

optional areaQuery: { coordinates: ; } | { boundary: [number, number, number, number]; }

The response from the method.

categories: []

The categories, most frequent first.

total: number

How many distinct values the band holds within the scope, which is larger than the number of categories returned when limit drops some.

The parameters for counting the distinct values of a raster band, passed to the method.

layerId: string

bandId: string

The ID of the band to count values for, read from the bands on a raster layer's source.

The schema that describes the structure of the features in a layer.

This can be useful to build generic UIs that need to know the structure of the data in a layer, such as a dropdown to choose an attribute.

featureCount: number

The total number of features in the layer.

attributes: []

Array of attribute schemas describing the properties available on features in this layer.

The common schema for all attributes.

id: string

The unique identifier for this attribute.

This can be used to fetch statistics, categories, histograms etc. for this attribute via the , , and methods.

displayName: string

The human-readable name of this attribute.

LayerSchemaAttribute: | | | |

A single attribute from the layer schema.

Each feature in a layer has a set of attributes, and these types describe the structure of a single attribute, including things like id, display name, type, and sample values.

The parameters for the listener.

layer: null |

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

FilterTernary: [FilterTernary | FilterExpression | null | boolean, FilterLogicGate, FilterTernary | FilterExpression | null | boolean]

A FilterTernary is a tree structure for combining expressions with logical operators.

When combining three or more conditions, you must use proper nesting rather than a flat list.

Example

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.

optional color: string

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

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.

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.

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.

optional rotation: number

The rotation of the element in degrees.

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.

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.

optional text: string

The text in the element.

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

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

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

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

optional widthScale: number

optional position:

The geographical position of the center of the note element.

The response from the LayersController.getRasterAggregates method.

Type Parameters

Properties

stats

stats: Record<T, null | number>

The value calculated for each requested statistic.

null is returned when the boundary and filters selected no pixels, as opposed to zero, so as not to confuse an empty selection with a real zero.

optional percentiles: []

The requested percentiles, in the order they were requested. Present only when percentile ranks were requested.

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.

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

url: string

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

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.

The parameters for getting categories from a layer, passed to the LayersController.getCategoryData method.

Properties

layerId

layerId: string

The ID of the layer to get categories from.

attribute

attribute: string

The attribute to use for categorization.

limit?

optional limit: number

The maximum number of categories to return.

optional filters:

Attribute filters for the features to include when calculating the categories.

optional boundary:

The spatial boundary for the features to include when calculating the categories.

optional values:

Configuration for filtering and aggregating values while preserving the full set of categories in the results.

This is particularly useful when you want to compare different subsets of data while maintaining consistent categories. For example:

• Show all building types in a city, but only count recent buildings in each type

• Keep all neighborhood categories but only sum up residential square footage

Unlike top-level filters which affect both what categories appear AND their values, filters in this configuration only affect the values while keeping all possible categories in the results.

The parameters for calculating statistics for a raster band, passed to the LayersController.getRasterAggregates method.

Type Parameters

Properties

layerId

layerId: string

bandId

bandId: string

The ID of the band to calculate statistics for, read from the bands on a raster layer's source.

aggregation: { methods: T[]; percentiles: number[]; }

Which statistics to calculate for the band.

optional boundary:

The spatial boundary for the pixels to include. Omit this to cover the whole raster.

optional filters:

Filters on band values for the pixels to include, such as ["band:1", "gt", 100].

The parameters for calculating a single aggregate value for a layer, passed to the LayersController.getAggregates method.

Type Parameters

Properties

layerId

layerId: string

The ID of the layer to calculate an aggregate value for.

aggregation: <T>

Specifies how to aggregate values within each category or bin. When omitted, features are counted. When specified, the chosen calculation (avg, sum, etc.) is performed on the specified attribute.

optional filters:

Attribute filters for the features to include when calculating the aggregate value.

optional boundary:

The spatial boundary for the features to include when calculating the aggregate value.

The schema for a boolean attribute on a layer.

Properties

id

id: string

The unique identifier for this attribute.

This can be used to fetch statistics, categories, histograms etc. for this attribute via the LayersController.getCategoryData, LayersController.getHistogramData, and LayersController.getAggregates methods.

displayName

displayName: string

The human-readable name of this attribute.

detailedType: string

The specific data type of this attribute, providing more detail than the basic type.

For instance, a numeric attribute might be "INTEGER", "FLOAT, etc.

distinctCount: number

The number of distinct values present for this attribute across all features.

type: "boolean"

Indicates this is a boolean attribute.

sampleValues: { value: boolean; count: number; }[]

A representative sample of boolean values for this attribute and their frequency.

The schema for a date attribute on a layer.

Properties

id

id: string

The unique identifier for this attribute.

This can be used to fetch statistics, categories, histograms etc. for this attribute via the LayersController.getCategoryData, LayersController.getHistogramData, and LayersController.getAggregates methods.

displayName

displayName: string

The human-readable name of this attribute.

detailedType: string

The specific data type of this attribute, providing more detail than the basic type.

For instance, a numeric attribute might be "INTEGER", "FLOAT, etc.

distinctCount: number

The number of distinct values present for this attribute across all features.

type: "date"

Indicates this is a date attribute.

min: string

The earliest date present for this attribute in truncated ISO8601 format (YYYY-MM-DD).

max: string

The latest date present for this attribute in truncated ISO8601 format (YYYY-MM-DD).

sampleValues: { value: string; count: number; }[]

A representative sample of date values for this attribute and their frequency.

The filters that are currently set on a layer.

A layer's filters are the combination of various different places in which filters can be applied.

Properties

style

style: Filters

Filters that are set in the layer's style. These are the lowest level of filters, and can only be set by editing the map.

components

components: Filters

Filters that are set in the layer's components, which are interactive elements in the legend. These can be set by viewers for their own session, but their default value can be set by the map creator.

ephemeral

ephemeral:

Filters that are set ephemerally by viewers in their own session.

These are the filters that are set when the method is called. There is no way to set these in the Felt UI - they can only be set using the SDK.

combined:

The combined result of all the filters set on the layer.

id: string

The unique identifier for the element.

type: "Circle"

optional groupId: null |

id: string

The unique identifier for the element.

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.

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.

optional

type: "Marker"

coordinates: [][]

optional groupId: null | string

id: string

The unique identifier for the element.

type: "Highlighter"

optional groupId: null |

id: string

The unique identifier for the element.

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.

id: string

The unique identifier for the element.

type: "Marker"

optional groupId: null |

id: string

The unique identifier for the element.

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.

id: string

The unique identifier for the element.

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.

The parameters for the method.

name: string

The name of the layer to create.

source: | |

The source of the GeoJSON data.

optional

A data-only layer doesn't have any geometry, but can be used to join with other layers

id: string

A string identifying the layer

groupId: null | string

The ID of the layer group that the layer belongs to.

Layers that appear at the root level in Felt will not have a group ID.