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

    Interface SelectedEvent

    An event emitted via the Event Service using the topic name search-api/SELECTED.

    interface SelectedEvent {
        context: undefined | string;
        item?: Record<string, unknown>;
        items?: Record<string, unknown>[];
        query: string;
        source: ItemSource;
    }
    Index

    Properties

    context item? items? query source

    Properties

    context: undefined | string

    Context parameter that was specified when the search was started.

    May indicate the UI widget or bundle where the search was originally triggered.

    See also SearchOptions.context.

    item?: Record<string, unknown>

    The selected item (for single selection).

    Mutually exclusive with items.

    items?: Record<string, unknown>[]

    The selected items (for multi selection).

    Mutually exclusive with item.

    query: string

    The original search query entered by the user.

    source: ItemSource

    The source of the selected item. Currently all sources are stores, but different source types may be added in the future. Use the type field for disambiguation.

    Settings

    Member Visibility

    On This Page

    Properties