1 of 21

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.

Index

Feature

A feature is a single geographical item in a layer. The unique ID for a feature is a compound key made up of the layer ID and the feature ID.

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: "Point" | "Polygon" | "MultiPolygon" | "LineString" | string & {}

The type of geometry of the feature.

properties

properties: Record<string, unknown>

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

FilterExpression

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]

FilterLogicGate

FilterLogicGate: "and" | "or"

FilterTernary

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

Filters

Filters: FilterTernary | FilterExpression | null | boolean

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

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

// a simple filter
felt.setLayerFilters({
  layerId: "layer-1",
  filters: ["AREA", "gt", 30_000],
});

// compound filters can be constructed using boolean logic:
felt.setLayerFilters({
  layerId: "layer-1",
  filters: [["AREA", "gt", 30_000], "and", ["COLOR", "eq", "red"]]
})

GetLayerGroupsConstraint

The constraints to apply when getting layer groups.

Properties

ids?

optional ids: string[]

The ids of the layer groups to get.

GetLayersConstraint

The constraints to apply when getting layers.

Properties

ids?

optional ids: string[]

The ids of the layers to get.

GetRenderedFeaturesConstraint

Constraints for the getRenderedFeatures method. If no constraints are provided, all rendered features will be returned.

Properties

layerIds?

optional layerIds: string[]

The ids of the layers to get rendered features for.

Layer

Properties

id

id: string

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

status

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

The current processing status of the layer.

geometryType

geometryType: null | string

The geometry type of the layer.

Remarks

This will generally be one of:

"Point"
"Line"
"Polygon"
"Raster"
null

When the layer is processing, or it is a data-only layer, it will be null. You should expect this to be able to be any string, however, as more geometry types can be added in the future.

bounds

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

The bounding box of the layer. If the layer is processing, or the bounds have otherwise not been calculated or are not available, this will be null.

LayerChangeCallbackParams

The parameters for the onLayerChange listener.

Properties

layer

layer: null | Layer

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

LayerFilters

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

LayerGroup

Properties

id

id: string

A string identifying the layer group.

name

name: string

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

caption

caption: null | string

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

layerIds

layerIds: string[]

The ids of the layers in the layer group.

Remarks

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

visible

visible: boolean

Whether the layer group is visible or not.

shownInLegend

shownInLegend: boolean

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

bounds

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

The bounding box of the layer group.

LayerGroupChangeCallbackParams

The parameters for the onLayerGroupChange listener.

Properties

layerGroup

layerGroup: null |

LayerProcessingStatus

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.

LayersController

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

Layers can be organised into groups, and their groups can also have their visibility toggled.

Extended by

Methods

getLayer()

getLayer(id: string): Promise<null | >

Get a single layer from the map by its id.

Parameters

Parameter

Type

Description

Returns

Promise<null | >

The requested layer.

Example

getLayers()

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

Parameters

Returns

All layers on the map.

Remarks

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

Example

setLayerVisibility()

Hide or show layers with the given ids.

Parameters

Returns

Promise<void>

Example

getLayerGroup()

Get a layer group from the map by its id.

Parameters

Returns

The requested layer group.

Example

getLayerGroups()

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

Parameters

Returns

The requested layer groups.

Example

setLayerGroupVisibility()

Hide or show layer groups with the given ids.

Parameters

Returns

Promise<void>

Example

getLegendItem()

Allows you to get the state of a single legend item.

Parameters

Returns

Example

getLegendItems()

Allows you to obtain the state of several legend items, by passing in constraints describing which legend items you want.

If you do not pass any constraints, you will receive all legend items.

Parameters

Returns

Example

setLegendItemVisibility()

Hide or show legend items with the given identifiers.

Parameters

Returns

Promise<void>

Example

getLayerFilters()

Get the filters for a layer.

Parameters

Returns

Remarks

The return type gives you the filters split up into the various sources that make up the overall filters for a layer.

Example

setLayerFilters()

Sets the ephemeral filters for a layer.

Parameters

Returns

Promise<void>

Example

getRenderedFeatures()

Get the features that are currently rendered on the map in the viewport.

Note that this is explicitly about the features that are rendered, which isn't necessarily a complete list of all the features in the viewport. This is because of the way features are tiled: at low zoom levels or high feature densities, many features are omitted from what is rendered on the screen.

Parameters

Returns

Example

Events

onLayerChange()

Adds a listener for when a layer changes.

Parameters

Returns

VoidFunction

A function to unsubscribe from the listener

Example

onLayerGroupChange()

Adds a listener for when a layer group changes.

Parameters

Returns

VoidFunction

A function to unsubscribe from the listener

Example

onLegendItemChange()

Adds a listener for when a legend item changes.

Parameters

Returns

VoidFunction

A function to unsubscribe from the listener

Example

LegendItem

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.

LegendItemChangeCallbackParams

The parameters for the onLegendItemChange listener.

Properties

legendItem

legendItem: null | LegendItem

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

LegendItemIdentifier

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.

LegendItemsConstraint

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.

RasterValue

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.

LayersController

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

Layers can be organised into groups, and their groups can also have their visibility toggled.

Extended by

Methods

getLayer()

getLayer(id: string): Promise<null | >

Get a single layer from the map by its id.

Parameters

Parameter

Type

Description

Returns

Promise<null | >

The requested layer.

Example

getLayers()

getLayers(constraint?: ): Promise<(null | )[]>

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

Parameters

Parameter

Type

Description

Returns

Promise<(null | )[]>

All layers on the map.

Remarks

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

Example

const layers = await felt.getLayers();

setLayerVisibility()

setLayerVisibility(visibility: ): Promise<void>

Hide or show layers with the given ids.

Parameters

Parameter

Type

Returns

Promise<void>

Example

felt.setLayerVisibility({ show: ["layer-1", "layer-2"], hide: ["layer-3"] });

getLayerGroup()

getLayerGroup(id: string): Promise<null | >

Get a layer group from the map by its id.

Parameters

Parameter

Type

Returns

Promise<null | >

The requested layer group.

Example

felt.getLayerGroup("layer-group-1");

getLayerGroups()

getLayerGroups(constraint?: ): Promise<(null | )[]>

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

Parameters

Parameter

Type

Description

Returns

Promise<(null | )[]>

The requested layer groups.

Example

const layerGroups = await felt.getLayerGroups({ ids: ["layer-group-1", "layer-group-2"] });

setLayerGroupVisibility()

setLayerGroupVisibility(visibility: ): Promise<void>

Hide or show layer groups with the given ids.

Parameters

Parameter

Type

Returns

Promise<void>

Example

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

getLegendItem()

getLegendItem(id: ): Promise<null | >

Allows you to get the state of a single legend item.

Parameters

Parameter

Type

Returns

Promise<null | >

Example

const legendItem = await felt.getLegendItem({
  id: "legend-item-1",
  layerId: "layer-1",
})

getLegendItems()

getLegendItems(constraint?: ): Promise<(null | )[]>

Allows you to obtain the state of several legend items, by passing in constraints describing which legend items you want.

If you do not pass any constraints, you will receive all legend items.

Parameters

Parameter

Type

Returns

Promise<(null | )[]>

Example

const legendItems = await felt.getLegendItems({layerId: "layer-1"});

setLegendItemVisibility()

setLegendItemVisibility(visibility: {show: [];hide: []; }): Promise<void>

Hide or show legend items with the given identifiers.

Parameters

Parameter

Type

Returns

Promise<void>

Example

felt.setLegendItemVisibility({
  show: [{layerId: "layer-group-1", id: "item-1-0"}],
  hide: [{layerId: "layer-group-2", id: "item-2-0"}],
})

getLayerFilters()

getLayerFilters(layerId: string): Promise<null | >

Get the filters for a layer.

Parameters

Parameter

Type

Returns

Promise<null | >

Remarks

The return type gives you the filters split up into the various sources that make up the overall filters for a layer.

Example

const filters = await felt.getLayerFilters("layer-1");
console.log(filters.combined, filters.style, filters.ephemeral, filters.components);

setLayerFilters()

setLayerFilters(params: {layerId: string;filters: ; }): Promise<void>

Sets the ephemeral filters for a layer.

Parameters

Parameter

Type

Description

Returns

Promise<void>

Example

felt.setLayerFilters({
  layerId: "layer-1",
  filters: ["AREA", "gt", 30_000],
});

getRenderedFeatures()

getRenderedFeatures(params?: ): Promise<[]>

Get the features that are currently rendered on the map in the viewport.

Parameters

Parameter

Type

Description

Returns

Promise<[]>

Example

const features = await felt.getRenderedFeatures();

Events

onLayerChange()

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

Adds a listener for when a layer changes.

Parameters

Parameter

Type

Description

Returns

VoidFunction

A function to unsubscribe from the listener

Example

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

// later on...
unsubscribe();

onLayerGroupChange()

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

Adds a listener for when a layer group changes.

Parameters

Parameter

Type

Returns

VoidFunction

A function to unsubscribe from the listener

Example

const unsubscribe = felt.onLayerGroupChange({
  options: { id: "layer-group-1" },
  handler: ({layerGroup}) => console.log(layerGroup.id),
});

// later on...
unsubscribe();

onLegendItemChange()

onLegendItemChange(args: {options: ;handler: (change: ) => void; }): VoidFunction

Adds a listener for when a legend item changes.

Parameters

Parameter

Type

Returns

VoidFunction

A function to unsubscribe from the listener

Example

const unsubscribe = felt.onLegendItemChange({
  options: { layerId: "layer-1", id: "item-1-0" },
  handler: ({legendItem}) => console.log(legendItem.visible),
});

// later on...
unsubscribe();

Layers

Index

Interfaces

Controller

Filters

Layer Groups

Layers

Legend Items

Feature

Properties

id

layerId

geometryType

properties

FilterExpression

FilterLogicGate

FilterTernary

Filters

Remarks

Example

GetLayerGroupsConstraint

Properties

ids?

GetLayersConstraint

Properties

ids?

GetRenderedFeaturesConstraint

Properties

layerIds?

Layer

Properties

id

groupId

name

caption

description

visible

shownInLegend

status

geometryType

bounds

LayerChangeCallbackParams

Properties

layer

LayerFilters

Properties

style

components

ephemeral

combined

LayerGroup

Properties

id

name

caption

layerIds

visible

shownInLegend

bounds

LayerGroupChangeCallbackParams

Properties

layerGroup

LayerProcessingStatus

LayersController

Extended by

Methods

getLayer()

getLayers()

setLayerVisibility()

getLayerGroup()

getLayerGroups()

setLayerGroupVisibility()

getLegendItem()

getLegendItems()

setLegendItemVisibility()

getLayerFilters()

setLayerFilters()

getRenderedFeatures()

Events

onLayerChange()