map.apps Bundle APIs 4.20.0
    Preparing search index...

    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;
    }
    Index

    Properties

    description? id layerId modifiers? store storeProperties title

    Methods

    query

    Properties

    description?: string

    An optional description of the source.

    id: string

    The ID of the source.

    layerId: string

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

    modifiers?: SpatialQueryModifier

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

    store: Store

    The underlying store.

    storeProperties: undefined | ServiceProperties

    The store properties.

    title: string

    The title of the source.

    Methods

    Settings

    Member Visibility

    On This Page

    Properties
    Methods