Interface SearchSource

Represents a source for the spatial search. The default implementation wraps the store api to match "normal" promises. A SearchSource is created internally by the SearchSourceModel implementation.

interface SearchSource {
    description?: string;
    id: string;
    layerId: string;
    modifiers?: SpatialQueryModifier;
    query(
        geometry: Geometry,
        opts?: RetrievalOptions & SortOptions & PaginationOptions & QueryInterpretationOptions & AbortOptions & Readonly<
            Record<string, any>,
        > & { returnIds?: boolean },
    ): CancelablePromise<
        readonly Readonly<Record<string, any>>[] & { total: number },
    >;
    store: Store;
    storeProperties: undefined | ServiceProperties;
    title: string;
}

Properties

description? id layerId modifiers? store storeProperties title

Methods

query

Properties

Optionaldescription

description?: string

An optional description of the source.

id

id: string

The ID of the source.

layerId

layerId: string

The layer ID of the layer if this store is backed by a map layer.

Optionalmodifiers

modifiers?: SpatialQueryModifier

Optional search query modifiers. Currently only the "operator" = "$intersects" can be changed.

store

store: Store

The underlying store.

storeProperties

storeProperties: undefined | ServiceProperties

The store properties.

title

title: string

The title of the source.

Methods

query

Settings

Member Visibility

On This Page

Properties
Methods