References an element group.

Properties

type

type: "elementGroup"

entity

entity: ElementGroup

References a feature on the map.

Properties

type

type: "feature"

entity

entity: LayerFeature

The options for selecting a feature in a layer.

Properties

id

id: string | number

The id of the feature to select.

layerId

layerId: string

The id of the layer that the feature belongs to.

showPopup?

optional showPopup: boolean

Whether to show the feature's popup, if it is configured in the layer's style.

Default

fitViewport?

optional fitViewport: boolean | { maxZoom: number; }

Whether to center the view on the feature after selecting it.

When true, the viewport will be centered on the feature and zoomed to fit the feature in the viewport. If you need to control the zoom level to prevent it zooming in too far, you can pass an object with a maxZoom property.

This is useful for avoiding zooming in too far on point features, or if you want to maintain the current zoom level.

Default

References a layer group on the map.

Properties

type

type: "layerGroup"

entity

entity: LayerGroup

Controller

• SelectionController

Interfaces

• FeatureSelection

Entity Node

• EntityNode

Entity Nodes

• ElementNode

• ElementGroupNode

• LayerNode

• LayerGroupNode

The Selection controller allows you to listen for changes to the selection on the map.

Extended by

• FeltController

Methods

getSelection()

getSelection(): Promise<EntityNode[]>

Gets the current selection as a list of entity identifiers.

Use this method to retrieve the current selection state, which can include features, elements, or both types of entities.

Returns

Promise<EntityNode[]>

A promise that resolves to an array of selected entity nodes.

Example

const selection = await felt.getSelection();

selectFeature()

selectFeature(params: FeatureSelection): Promise<void>

Selects a feature on a layer. This will show the feature's popup, modal or sidebar (if configured) and highlight the feature.

Use this method to programmatically select features, which can be useful for highlighting specific data points or triggering feature-specific UI.

Parameters

Returns

Promise<void>

A promise that resolves when the feature is selected.

Example

felt.selectFeature({
  id: 123,
  layerId: "my-layer",
  showPopup: true,
  fitViewport: { maxZoom: 15 },
});

clearSelection()

clearSelection(params?: { features: boolean; elements: boolean; }): Promise<void>

Clears the current selection (elements, features or both).

Use this method to programmatically clear the current selection, which can be useful for resetting the map state or preparing for new selections.

Parameters

Returns

Promise<void>

A promise that resolves when the selection is cleared.

Example

// Removes all features and elements from the selection
felt.clearSelection();

// Removes only features from the selection
felt.clearSelection({ features: true });

// Removes only elements from the selection
felt.clearSelection({ elements: true });

Default

{ features: true, elements: true }

Events

onSelectionChange()

onSelectionChange(params: { handler: (change: { selection: EntityNode[]; }) => void; }): VoidFunction

Adds a listener for when the selection changes.

Use this to react to selection changes, such as updating your UI to reflect what is currently selected on the map.

Parameters

Returns

VoidFunction

A function to unsubscribe from the listener.

Example

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

// later on...
unsubscribe();

EntityNode: ElementNode | ElementGroupNode | LayerNode | LayerGroupNode | FeatureNode

A reference to any kind of entity in the map.

Remarks

EntityNodes are used when you have some collection of entities and you need to

References a layer on the map.

Properties

type

type: "layer"

entity

entity:

References an element on the map.

Properties

type

type: "element"

entity

entity: