Interface ResultItem

A single result item, for example describing a feature.

interface ResultItem {
    id: string | number;
    label: string;
    select(): ResultSelectionHandle;
}

Index

Properties

Methods

Properties

`Readonly` id

id: string | number

Unique id of this item within its group.

`Readonly` label

label: string

Item label for display purposes.

Methods

select

select(): ResultSelectionHandle
Invoke actions associated with the item. For example, zooming to a feature or opening a popup.

This function returns a handle object with a remove() function that will clear side effects made by the selection, if applicable (e.g. highlights).

Note that selections may also be removed automatically (e.g. when a new selection is made).

Returns ResultSelectionHandle
- Defined in api.ts:143

Generated using TypeDoc