NextGIS Frontend
    Preparing search index...

    Class BaseProvider<O>Abstract

    Abstract base class representing a search provider. It builds upon the BaseGeocoder functionalities with provider-specific properties.

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    label?: string

    Label to represent the provider. Useful for user interfaces to display the source of search results.

    searchUrl?: string

    URL endpoint for the search service. This is where queries will be sent to obtain search results.

    Methods

    • Optional method to abort any ongoing geocoding requests.

      Returns void

    • Method to retrieve detailed result for a specific search item.

      Parameters

      • item: SearchItem

        The search item to get detailed result for.

      Returns Promise<any>

      A promise that resolves to the detailed result.

    • Method for reverse geocoding. Takes coordinates and returns the corresponding address or location information.

      Parameters

      • coordinates: LngLatArray

        The longitude and latitude values.

      Returns AsyncGenerator<SearchItem>

      An async generator that yields reverse geocoding results.

    • Search method to retrieve geocoding results.

      Parameters

      • query: string

        The search string to geocode.

      Returns AsyncGenerator<SearchItem>

      An async generator that yields search results.