Interface SearchOptions

Describes the supported options in a call to SearchService.search(...).

interface SearchOptions {
    actionOptions?: Record<string, any>;
    actions?: string[];
    count?: number;
    signal?: AbortSignal;
}

Properties

actionOptions?: Record<string, any>

An optional object with action options to use when an item is selected (see ResultItem.select). This option corresponds to the options parameter of the map-actions.ActionService.trigger() method.

actions?: string[]

An optional array of map-actions to trigger when an item is selected (see ResultItem.select). This option corresponds to the actionIds parameter of the map-actions.ActionService.trigger() method.

Defaults to the actions "highlight", "zoomto" and "openpopup" defined by the map-actions bundle.

count?: number

An optional number of items requested from each store. Note that the implementation may return fewer results if the stores do not provide that many items in a single query.

By default, only a single query is made to every store.

The default value is 15.

signal?: AbortSignal

Optional signal to cancel the search. When the signal's abort event fires, all individual search operations are cancelled and promises returned by a search will reject with an AbortError.

See https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal.

Generated using TypeDoc