Open Pioneer Trails Packages
    Preparing search index...

    Interface SearchProps

    Properties supported by the Search component.

    interface SearchProps {
        map?: MapModel;
        mapId?: string;
        maxResultsPerGroup?: number;
        onClear?: () => void;
        onSelect?: (event: SearchSelectEvent) => void;
        placeholder?: string;
        searchTypingDelay?: number;
        sources: SearchSource[];
    }

    Hierarchy (View Summary)

    Index

    Properties

    map? mapId? maxResultsPerGroup? onClear? onSelect? placeholder? searchTypingDelay? sources

    Properties

    map?: MapModel

    The map model to use.

    mapId?: string

    The id of the map. The map will be looked up in the MapRegistry service.

    Use the map property instead.

    DefaultMapProvider

    maxResultsPerGroup?: number

    The maximum number of results shown per group. Defaults to 5.

    onClear?: () => void

    This event handler will be called when the user clears the search input.

    onSelect?: (event: SearchSelectEvent) => void

    This event handler will be called when the user selects a search result.

    placeholder?: string

    The placeholder text shown in the search input field when it is empty. Defaults to a generic (and localized) hint.

    searchTypingDelay?: number

    Typing delay (in milliseconds) before the async search query starts after the user types in the search term. Defaults to 200.

    sources: SearchSource[]

    Data sources to be searched on.

    Settings

    Member Visibility

    On This Page

    Properties