Interface SearchOptions

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.

An optional array of map action IDs. The associated map actions are triggered 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 action IDs "highlight", "zoomto" and "openpopup" defined by the map-actions bundle.

Optional context parameter that is passed through the search-api. This value can be used to indicate the origin of the search (e.g. a UI widget or bundle).

See also QueryEvent.context and SelectedEvent.context.

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.

Whether to request the number of total results from the queries stores.

This is true by default for backwards compatibility reasons. Set this to false to skip requesting the total result count.

See also ResultSet.total.

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.

IDs of stores to search. If not provided, all available stores are searched.