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();

View FeltController for a complete list of available functions. FeltEmbedOptions enumerates initialization options.

Documents

• CHANGELOG

Modules

• Elements

• Interactions

• Layers

• Main

• Misc

• Selection

• Shared

• Tools

• UI

• Viewport

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 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 ToolsController to select and configure the drawing tools in Felt.

Controller

• ElementsController

Interfaces

• PlaceElementCreate

• PathElementCreate

• PolygonElementCreate

• CircleElementCreate

• MarkerElementCreate

• HighlighterElementCreate

• TextElementCreate

• NoteElementCreate

• ImageElementCreate

• PlaceElementRead

• PathElementRead

• PolygonElementRead

• CircleElementRead

• MarkerElementRead

• HighlighterElementRead

• TextElementRead

• NoteElementRead

• ImageElementRead

• LinkElementRead

• PlaceElementUpdate

• PathElementUpdate

• PolygonElementUpdate

• CircleElementUpdate

• MarkerElementUpdate

• HighlighterElementUpdate

• TextElementUpdate

• NoteElementUpdate

• ImageElementUpdate

Type Aliases

• ElementCreate

• ElementUpdate

Element Groups

• ElementGroup

• GetElementGroupsConstraint

• ElementGroupChangeCallbackParams

Elements

• GetElementsConstraint

• ElementChangeCallbackParams

• Element

The constraints to apply when getting elements.

Properties

ids?

optional ids: string[]

The ids of the elements to get.

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

Properties

attribute

attribute: string

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

method

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

The method to use for the aggregation.

The constraints to apply when getting element groups.

Properties

ids?

optional ids: string[]

The ids of the element groups to get.

FilterLogicGate: "and" | "or"

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]

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

This describes the processing status of a layer.

The various values are:

• processing: The layer has been uploaded or updated and is still processing.

• completed: The layer has been processed and can be viewed on the map.

• failed: The layer failed to process and cannot be viewed on the map.

• incomplete: The layer has not been processed.

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

Properties

type

type: "geoJsonData"

Identifies this as a GeoJSON data source.

data

data: object

The GeoJSON data for the layer.

This must be a GeoJSON FeatureCollection.

The identifier for a legend item. It is a compound key of the layer to which the legend item belongs and the legend item's own id.

Properties

id

id: string

The id of the legend item.

layerId

layerId: string

The id of the layer the legend item belongs to.

A raster pixel value for a specific layer.

Properties

value

value: number

The value of the pixel.

layerId

layerId: string

The ID of the layer that the pixel belongs to.

categoryName

categoryName: null | string

The name of the category that the pixel belongs to.

color

color: null | { r: number; g: number; b: number; a: number; }

The color of the pixel. Each value is between 0 and 255.

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

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

One bin from the response from the method.

Properties

min

min: number

The left edge of the bin.

max

max: number

The right edge of the bin.

value

value: number

The number of features in the bin.

The parameters for the and the listeners.

Properties

element

element: null |

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.

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

Interactions include clicking and hovering on points and features.

Controller

Interfaces

A single category from the response from the method.

Properties

key

key: string | number | boolean

The category for which the value was calculated.

value

value: null | number

The value calculated for the category, whether a count, sum, average, etc.

null is returned if there are no features in the category as opposed to zero, so as not to confuse with a real zero value from some aggregation.

The parameters for the listener.

Properties

layer

layer: null |

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

The parameters for the listener.

Properties

legendItem

legendItem: null |

The new data for the legend item or null if the legend item was removed.

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

Remarks

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.

Properties

featureCount

featureCount: number

The total number of features in the layer.

attributes

attributes: []

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

The parameters for the listener.

Properties

layerGroup

layerGroup: null |

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

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

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

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.

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

// A simple filter with a single condition
const filter = [
  ["AREA", "gt", 30_000],
  "and",
  ["COLOR", "eq", "red"]
]

// A complex filter with multiple conditions
const filter = [
  ["AREA", "gt", 30_000],
  "and",
  [
    ["COLOR", "eq", "red"],
    "or",
    ["TYPE", "eq", "residential"]
  ]
]

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 declaration

type

type: "felt"

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

tileTemplateUrl

tileTemplateUrl: string

The template URL used for fetching tiles.

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.

filters?

optional filters: Filters

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

boundary?

optional boundary: GeometryFilter

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

values?

optional values: ValueConfiguration

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.

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

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

Layer: RasterLayer | VectorLayer | DataOnlyLayer

The misc module for hard-to-categorize functionality.

Controller

• MiscController

Types

• MapDetails

A legend item, which often represents a sub-class of features in a layer in the case of categorical or classed layers.

Properties

title

title: string | string[]

The title of the legend item.

titleDependsOnZoom

titleDependsOnZoom: boolean

Whether the title depends on the zoom level or not. If it does, you need to call `getLegendItem` when the zoom level changes.

Note that as the zoom level changes, the `onLegendItemChange` handler will not be called, so you need to call `getLegendItem` yourself.

visible

visible: boolean

Whether the legend item is visible or not.

id

id: string

The id of the legend item.

layerId

layerId: string

The id of the layer the legend item belongs to.

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

Properties

spatialFilters

spatialFilters: null | MultiPolygonGeometry

Boundaries set by drawing spatial filters on the map.

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

ephemeral

ephemeral: null | GeometryFilter

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

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

combined

combined: null | MultiPolygonGeometry

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

Each different source of boundary is intersected to produce the combined result.

Properties

uiControls?

optional uiControls: UiControlsOptions

initialViewport?

optional initialViewport: ViewportCenterZoom

token?

optional token: string

A short-lived (15 minutes) authentication token to use for showing embeds that are configured to be private.

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.

type

type: "Highlighter"

renderHoles

renderHoles: boolean

Whether to render the holes of the highlighted area.

Default

opacity

opacity: number

The opacity of the highlighter, between 0 and 1.

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

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

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

Type Parameters

Properties

layerId

layerId: string

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

aggregation

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.

filters?

optional filters:

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

boundary?

optional boundary:

The spatial boundary for the features to include when calculating the aggregate 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.

Properties

areaQuery?

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

The area to query for rendered features. This can be specific coordinates or a . If omitted, the entire viewport will be queried.

layerIds?

optional layerIds: string[]

The ids of the layers to get rendered features for.

The common properties for all layers.

Properties

id

id: string

A string identifying the layer

groupId

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.

name

name: string

The name of the layer can be displayed in the Legend, depending on how the layer's legend is configured in its style.

caption

caption: null | string

The layer's caption is shown in the legend.

description

description: null | string

The layer description forms part of the layer's metadata. This is visible to users via the layer info button in the legend.

visible

visible: boolean

Whether the layer is visible or not.

shownInLegend

shownInLegend: boolean

Whether the layer is shown in the legend or not.

style

style: object

The FSL style for the layer.

See the for details on how to read and write styles.

As the types of the styles are very complex, we return object here and advise that you program defensively while reading the styles.

status

status: "processing" | "completed" | "failed" | "incomplete"

The current processing status of the layer.

bounds

bounds: null | [number, number, number, number]

The bounding box of the layer in [west, south, east, north] order

There are cases where the bounds are not available, such as for layers added to the map from URL sources, as these are not (depending on their type) processed and analyzed by Felt.

A LayerFeature is a single geographical item in a layer.

It is intended to be a lightweight object that contains the properties of a feature, but not the geometry. It is returned by methods like and , and as part of the methods in the

The geometry can be obtained via the method, which returns a object.

Properties

id

id: string | number

The identifier of the feature, unique within the layer.

layerId

layerId: string

The identifier of the layer that the feature belongs to.

geometryType

geometryType: "Polygon" | "MultiPolygon" | "LineString" | "MultiLineString" | "Point" | "MultiPoint" | string & {}

The type of geometry of the feature.

Remarks

Because LayerFeatures can be read from tiled features, it's possible that this geometryType won't match the geometry.type of the returned by .

For example, this may return LineString but the full feature is a MultiLineString, or, similarly Polygon here may be a MultiPolygon in the full feature.

As a result, you should treat this property as being indicative only.

bbox

bbox: undefined | [number, number, number, number]

The bounding box of the feature.

Remarks

Because LayerFeatures can be read from tiled features and considering that feature geometry can go through multiple tiles, it's possible that this is not the complete bounding box of the feature.

properties

properties:

The properties of the feature, as a bag of attributes.

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

combined:

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

LayerSchemaAttribute: | | | |

A single attribute from the layer schema.

Remarks

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.

Use the object to embed a new iframe, or connect to an existing embedded iframe.

Once you have connected to a Felt map (either by embedding or connecting to an existing iframe), you can use the object to control the map.

To see what you can do with the map, see the documentation for the interface and its constituent controllers.

Example

Controller

Instantiation

The parameters for the LayersController.createLayersFromGeoJson method.

Properties

name

name: string

The name of the layer to create.

source

source: GeoJsonUrlVectorSource | GeoJsonDataVectorSource | GeoJsonFileVectorSource

The source of the GeoJSON data.

bounds?

optional bounds: [number, number, number, number]

Sets the bounds of the layer.

caption?

optional caption: string

Sets the caption of the layer.

description?

optional description: string

Sets the description of the layer.

geometryStyles?

optional geometryStyles: { Point: object; Line: object; Polygon: object; }

The styles to apply to each geometry on the layer.

Each style should be a valid FSL style, as described in Layer.style.

These are optional, and if missing will use a default style determined by Felt, which you can consider to be undefined behaviour.

Example

const layer = await layersController.createLayersFromGeoJson({
  name: "My Layer",
  geometryStyles: {
    Point: {
      paint: { color: "red", size: 8 },
    },
    Line: {
      paint: { color: "blue", size: 4 },
      config: { labelAttribute: ["name"] },
      label: { minZoom: 0 },
    },
    Polygon: {
      paint: { color: "green", strokeColor: "darkgreen" },
    },
  },
});

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"

Properties

type

type: "Marker"

coordinates

coordinates: LngLatTuple[][]

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.

The schema for a numeric 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

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

distinctCount: number

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

type

type: "numeric"

Indicates this is a numeric attribute.

sampleValues

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

A small sample of values for this attribute and their frequency.

min

min: number

The minimum value present for this attribute across all features.

max

max: number

The maximum value present for this attribute across all features.

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.

Properties

type

type: "geoJsonUrl"

Identifies this as a GeoJSON URL source.

url

url: string

The remote URL of the GeoJSON file used to populate the layer.

refreshInterval?

optional refreshInterval: null | number

The interval in milliseconds between automatic refreshes of the GeoJSON.

The value must be in the range of 250ms - 5 minutes (300,000ms).

If the value is null, the GeoJSON will not be refreshed automatically.

const Felt: { embed: Promise<FeltController>; connect: Promise<FeltController>; }

The Felt SDK is a library for embedding Felt maps into your website, allowing you to control and inspect the map programmatically.

Type declaration

embed()

Embeds a Felt map into the provided container, returning a promise that resolves to a FeltController object that you can use to control the map.

Parameters

Returns

Promise<FeltController>

A promise for a FeltController.

connect()

Binds to an existing Felt map iframe.

Parameters

Returns

Promise<FeltController>

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

fillOpacity

fillOpacity: number

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

Default

areaMarker

areaMarker: boolean

Whether to show an area marker on the polygon.

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.

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

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

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?

optional coordinates: [][]

Filters: | | null | boolean

Filters can be used to change which features in a layer are rendered. Filters can be applied to a layer by the method on the Felt controller.

Filters use a tree structure for combining expressions with logical operators, called a. When combining three or more conditions, you must use proper nesting rather than a flat list.

See the examples below for the correct structure to use when building complex filters.

Remarks

The possible operators are:

• lt: Less than

• gt: Greater than

• le: Less than or equal to

• ge: Greater than or equal to

• eq: Equal to

• ne: Not equal to

• cn: Contains

• nc: Does not contain

The allowed boolean operators are:

• and: Logical AND

• or: Logical OR

Example

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?

optional coordinates:

Properties

type

type: "Polygon"

coordinates

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

A raster layer is a layer that contains raster data that can be rendered on the map

Properties

id

id: string

A string identifying the layer

groupId

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.

name

name: string

The name of the layer can be displayed in the Legend, depending on how the layer's legend is configured in its style.

caption

caption: null | string

The layer's caption is shown in the legend.

description

description: null | string

The layer description forms part of the layer's metadata. This is visible to users via the layer info button in the legend.

visible

visible: boolean

Whether the layer is visible or not.

shownInLegend

shownInLegend: boolean

Whether the layer is shown in the legend or not.

style

style: object

The FSL style for the layer.

See the for details on how to read and write styles.

As the types of the styles are very complex, we return object here and advise that you program defensively while reading the styles.

status

status: "processing" | "completed" | "failed" | "incomplete"

The current processing status of the layer.

bounds

bounds: null | [number, number, number, number]

The bounding box of the layer in [west, south, east, north] order

There are cases where the bounds are not available, such as for layers added to the map from URL sources, as these are not (depending on their type) processed and analyzed by Felt.

geometryType

geometryType: "Raster"

Identifies the type of geometry in the layer.

source

source:

The source of the raster layer's data.

The schema for a datetime 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 , , and methods.

displayName

displayName: string

The human-readable name of this attribute.

detailedType

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

distinctCount: number

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

type

type: "datetime"

Indicates this is a datetime attribute.

min

min: string

The earliest datetime present for this attribute in ISO8601 format.

max

max: string

The latest datetime present for this attribute in ISO8601 format.

sampleValues

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

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

The parameters for the listener.

Properties

elementGroup

elementGroup: null |

ElementCreate: | | | | | | | |

Properties

id

id: string

The unique identifier for the element.

type

type: "Text"

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"

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"

rotation?

optional rotation: number

The rotation of the element in degrees.

Default

0

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

1

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

"center"

style?

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

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

Default

"regular"

position?

optional position: LngLatTuple

The geographical position of the center of the text element.

A vector layer is a layer that contains vector data that can be rendered on the map

Properties

id

id: string

A string identifying the layer

groupId

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.

name

name: string

The name of the layer can be displayed in the Legend, depending on how the layer's legend is configured in its style.

caption

caption: null | string

The layer's caption is shown in the legend.

description

description: null | string

The layer description forms part of the layer's metadata. This is visible to users via the layer info button in the legend.

visible

visible: boolean

Whether the layer is visible or not.

shownInLegend

shownInLegend: boolean

Whether the layer is shown in the legend or not.

style

style: object

The FSL style for the layer.

See the FSL documentation for details on how to read and write styles.

As the types of the styles are very complex, we return object here and advise that you program defensively while reading the styles.

status

status: "processing" | "completed" | "failed" | "incomplete"

The current processing status of the layer.

bounds

bounds: null | [number, number, number, number]

The bounding box of the layer in [west, south, east, north] order

There are cases where the bounds are not available, such as for layers added to the map from URL sources, as these are not (depending on their type) processed and analyzed by Felt.

FeltBoundary

geometryType

geometryType: "Polygon" | "Point" | "Line"

Identifies the type of geometry in the layer.

source

source: GeoJsonUrlVectorSource | FeltTiledVectorSource | Omit<GeoJsonDataVectorSource, "data">

The source of the vector layer's data.

The constraints to apply when getting layer groups.

Properties

ids?

optional ids: string[]

The ids of the layer groups to get.

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

The method to use for the aggregation.

Constraints for legend items. If nothing is passed, all legend items will be returned.

Properties

ids?

optional ids: { id: string; layerId: string; }[]

Array of legend item identifiers to constrain by.

layerIds?

optional layerIds: string[]

Array of layer ids to constrain legend items by.

The params used to request a histogram of values from a layer, passed to the LayersController.getHistogramData method.

Properties

layerId

layerId: string

attribute

attribute: string

steps

steps: number[] | { type: "equal-intervals"; count: number; } | { type: "time-interval"; interval: "hour" | "day" | "week" | "month" | "year"; }

values?

optional values: { boundary: [number, number][] | [number, number, number, number] | { type: "Polygon"; coordinates: [number, number][][]; } | { type: "MultiPolygon"; coordinates: [number, number][][][]; }; filters: null | boolean | [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] | FilterTernary; aggregation: { method: "avg" | "max" | "min" | "sum" | "median"; attribute: string; }; }

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

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

• Use the same height ranges for comparing old vs new buildings

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

filters?

optional filters: Filters

Attribute filters for the features to include when calculating the histogram bins.

boundary?

optional boundary: GeometryFilter

The spatial boundary for the features to include when calculating the histogram bins.

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

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

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

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

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

fillOpacity?

optional fillOpacity: number

The opacity of the circle's fill.

Default

center?

optional center:

The center of the circle.

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

Properties

id

id: string

A string identifying the layer

groupId

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.

name

name: string

The name of the layer can be displayed in the Legend, depending on how the layer's legend is configured in its style.

caption

caption: null | string

The layer's caption is shown in the legend.

description

description: null | string

The layer description forms part of the layer's metadata. This is visible to users via the layer info button in the legend.

visible

visible: boolean

Whether the layer is visible or not.

shownInLegend

shownInLegend: boolean

Whether the layer is shown in the legend or not.

style

style: object

The FSL style for the layer.

See the for details on how to read and write styles.

As the types of the styles are very complex, we return object here and advise that you program defensively while reading the styles.

status

status: "processing" | "completed" | "failed" | "incomplete"

The current processing status of the layer.

geometryType

geometryType: null

Indicates that this layer has no geometry.

bounds

bounds: null

This is always null for data-only layers.

Layers in a Felt map hold geospatial data, but also configure how the data is rendered both on the map and in the legend. The data can be vector data such as Points, Lines, or Polygons, or raster data such as satellite images.

Each Layer can be grouped under a LayerGroup, and has associated LegendItems that represent how the layer is rendered in the legend.

You can control the visibility of layers, layer groups, and legend items using the`setLayerVisibility`, `setLayerGroupVisibility`, and `setLegendItemVisibility` methods.

When a Layer is styled to as categorical data or "classed" numeric data, there will be a LegendItem for each category or class. Each LegendItem can be controlled for visibility independently of the Layer, so you can turn on and off each category or class individually.

Controller

• LayersController

Features

• LayerFeature

• RasterValue

Filters

• LayerFilters

• LayerBoundaries

• FilterLogicGate

• FilterExpression

• FilterTernary

• Filters

• GeometryFilter

Layer Groups

• LayerGroup

• GetLayerGroupsConstraint

• LayerGroupChangeCallbackParams

Layer Schema

• LayerSchema

• LayerSchemaCommonAttribute

• LayerSchemaNumericAttribute

• LayerSchemaTextAttribute

• LayerSchemaBooleanAttribute

• LayerSchemaDateAttribute

• LayerSchemaDateTimeAttribute

• LayerSchemaAttribute

Layer sources

• RasterLayerSource

• RasterBand

• GeoJsonUrlVectorSource

• GeoJsonDataVectorSource

• GeoJsonFileVectorSource

• FeltTiledVectorSource

Layers

• LayerCommon

• RasterLayer

• VectorLayer

• UpdateLayerParams

• DataOnlyLayer

• GetLayersConstraint

• LayerChangeCallbackParams

• GetRenderedFeaturesConstraint

• CreateLayersFromGeoJsonParams

• LayerProcessingStatus

• Layer

Legend Items

• LegendItem

• LegendItemIdentifier

• LegendItemsConstraint

• LegendItemChangeCallbackParams

Stats

• AggregationConfig

• MultiAggregationConfig

• ValueConfiguration

• GetLayerCategoriesParams

• GetLayerCategoriesGroup

• GetLayerHistogramParams

• GetLayerHistogramBin

• GetLayerCalculationParams

• AggregationMethod

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