Interface SearchItem

interface SearchItem {
    _id?: string | number;
    extent?: LngLatBoundsArray;
    geom?: GeoJsonObject;
    provider?: BaseProvider<BaseProviderOptions>;
    query: string;
    result?: (() => Promise<ResultItem>);
    text: string;
    [prop: string]: any;
}

Indexable

  • [prop: string]: any

    A dynamic property bucket for the SearchItem.

Properties

_id? extent? geom? provider? query result? text

Properties

Optional_id

_id?: string | number

An optional unique identifier for the search result.

Optionalextent

extent?: LngLatBoundsArray

An optional bounding box of the search result in [west, south, east, north] format.

Optionalgeom

geom?: GeoJsonObject

Optional GeoJSON geometry associated with this search result.

Optionalprovider

provider?: BaseProvider<BaseProviderOptions>

The provider that sourced this search result.

query

query: string

The original query string that resulted in this search result.

Optionalresult

result?: (() => Promise<ResultItem>)

An optional function that can be called to retrieve detailed result for this search item.

text

text: string

Display text of the search result.

Settings

Member Visibility

On This Page

Properties