NextGIS Frontend
    Preparing search index...

    Class NgwProvider

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

    Hierarchy (View Summary)

    Index
    constructor
    label? searchResources searchUrl? limit
    abort result reverse search
    label?: string

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

    searchResources: SearchResource[] = []
    searchUrl?: string

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

    limit: number = 300

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

      Parameters

      • item: NgwSearchItem

        The search item to get detailed result for.

      Returns Promise<ResultItem>

      A promise that resolves to the detailed result.

    • Search method to retrieve geocoding results.

      Parameters

      • query: string

        The search string to geocode.

      Returns AsyncGenerator<NgwSearchItem, void, unknown>

      An async generator that yields search results.

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods