@geogirafe/lib-geoportal
    Preparing search index...

    Class GmfSearchClient

    A search provider for the GeoMapFish backend. Extends the AbstractSearchClient and provides methods tailored to processing GMF-specific search results.

    Configuration:

    • providerName: The name of the search provider, or geomapfish.
    • url: The URL of the GMF search service.
    • resultSrid: The spatial reference system (SRID) of the search results. Default same as map SRID.

    Hierarchy (View Summary)

    Index
    constructor
    context geoJsonFormatter providerName resultSrid searchFilterQueryParameter searchLangPlaceholder searchLangQueryParameter searchTermPlaceholder searchTermQueryParameter type url
    mapProjection
    buildRequestUrl getI18nKeyForCategory getSearchCategories getZoomToBbox groupedResults initializeSingleton isNullOrUndefinedOrBlank parseResponse requestSearch
    context: IGirafeContext
    geoJsonFormatter: GeoJSON<Feature<Geometry, { [x: string]: any }>> = ...
    providerName: string
    resultSrid: string
    searchFilterQueryParameter: string = 'categories'
    searchLangPlaceholder: "###SEARCHLANG###" = '###SEARCHLANG###'
    searchLangQueryParameter: string | undefined
    searchTermPlaceholder: "###SEARCHTERM###" = '###SEARCHTERM###'
    searchTermQueryParameter: string | undefined
    type: string
    url: URL

    • If the search request should filter results by layer tree elements, the URL needs to include an additional parameter null_category to include layer results.

      Parameters

      • term: string
      • filter: string[]

      Returns URL

    • Groups the results by the default group, which equivalates to no grouping. Should be overridden by the client class to group results by a custom criteria like search category.

      Parameters

      • results: Feature<Geometry, { [x: string]: any }>[]

      Returns Record<string, Feature[]>

    • Parses the response from the server and returns an array of features. Features must have the following properties to be used correctly with the search component:

      • provider
      • label
      • label_html: optional, for styled entries in the search results list
      • actions: optional, a list of SearchResultsActions

      Parameters

      • response: Response

      Returns Promise<Feature<Geometry, { [x: string]: any }>[]>

    • Executes a search request with the provided search term.

      Parameters

      • term: string
      • filter: string[]
      • abortController: AbortController

      Returns Promise<Feature<Geometry, { [x: string]: any }>[]>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods