SelectionController

---

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

Parameter	Type
params	FeatureSelection

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

Parameter	Type	Description
params?	{ features: boolean; elements: boolean; }	The parameters to clear the selection. If this is not provided, both features and elements will be cleared.
params.features?	boolean	Whether to clear the features from the selection.
params.elements?	boolean	Whether to clear the elements from the selection.

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

Parameter	Type
params	{ handler: (change: { selection: EntityNode[]; }) => void; }
params.handler	(change: { selection: EntityNode[]; }) => void

Returns

VoidFunction

A function to unsubscribe from the listener.

Example

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

// later on...
unsubscribe();