Class GeoAdminChSearchClient

Search provider for the Swiss search service of geo.admin.ch. See documentation at https://docs.geo.admin.ch/access-data/search.html

The GeoAdmin search provider allows 3 different types of searches:

locations: POIs like addresses, swissnames, boundaries, parcels
layers: layers of the GeoAdmin portal
features: features inside one or multiple layers of the GeoAdmin portal

This client currently only supports location search. The API returns max 50 items per request.

Configuration:

providerName: The name of the search provider, or geoadminch.
resultSrid: The spatial reference system (SRID) of the search results, always EPSG:2056.
bbox: Comma-separated list of bounding box coordinates in EPSG:2056 (e.g. "2580000,1150000,2600000,1200000") If no bbox is set, the max extent of the map is used.
locationOrigins: Array of categories that are searched. Default: All categories. Available categories and data origin: - zipcode (ch.swisstopo-vd.ortschaftenverzeichnis_plz) - gg25 (ch.swisstopo.swissboundaries3d-gemeinde-flaeche.fill) - district (ch.swisstopo.swissboundaries3d-bezirk-flaeche.fill) - kantone (ch.swisstopo.swissboundaries3d-kanton-flaeche.fill) - gazetteer (ch.swisstopo.swissnames3d, ch.bav.haltestellen-oev) - address (ch.swisstopo.amtliches-gebaeudeadressverzeichnis, including EGID) - parcel

Hierarchy (View Summary)

AbstractSearchClient
- GeoAdminChSearchClient

Constructors

constructor

new GeoAdminChSearchClient(
context: IGirafeContext,
config: GeoAdminChSearchClientConfig,
): GeoAdminChSearchClient
Parameters
- context: IGirafeContext
- config: GeoAdminChSearchClientConfig
Returns GeoAdminChSearchClient
Overrides AbstractSearchClient.constructor
- Defined in tools/search/geoadminchsearchclient.ts:53

Properties

`Protected` `Readonly`context

context: IGirafeContext

`Protected` `Readonly`geoJsonFormatter

geoJsonFormatter: GeoJSON<Feature<Geometry, { [x: string]: any }>> = ...

`Readonly`providerName

providerName: string

`Protected` `Readonly`resultSrid

resultSrid: string

`Protected`searchFilterQueryParameter

searchFilterQueryParameter: string = 'origins'

`Protected` `Readonly`searchLangPlaceholder

searchLangPlaceholder: "###SEARCHLANG###" = '###SEARCHLANG###'

`Protected`searchLangQueryParameter

searchLangQueryParameter: string = 'lang'

`Protected` `Readonly`searchTermPlaceholder

searchTermPlaceholder: "###SEARCHTERM###" = '###SEARCHTERM###'

`Protected`searchTermQueryParameter

searchTermQueryParameter: string = 'searchText'

`Readonly`type

type: string

`Protected`url

url: URL

Accessors

`Protected`mapProjection

get mapProjection(): Projection
Returns Projection
Inherited from AbstractSearchClient.mapProjection
- Defined in tools/search/abstractsearchclient.ts:47

Methods

`Protected`buildRequestUrl

buildRequestUrl(term: string, filter: string[]): URL
Parameters
- term: string
- filter: string[]
Returns URL
Overrides AbstractSearchClient.buildRequestUrl
- Defined in tools/search/geoadminchsearchclient.ts:93

getI18nKeyForCategory

getI18nKeyForCategory(category: string): string
Retrieves the translation key for a given category. Default: use category string directly.
Parameters
- category: string
Returns string
Overrides AbstractSearchClient.getI18nKeyForCategory
- Defined in tools/search/geoadminchsearchclient.ts:182

getSearchCategories

getSearchCategories(): Promise<string[]>
Returns a list of categories that can be searched by.

Returns Promise<string[]>
Overrides AbstractSearchClient.getSearchCategories
- Defined in tools/search/geoadminchsearchclient.ts:89

getZoomToBbox

getZoomToBbox(feature: Feature): Extent | undefined
Returns a bbox around the geometry that is 50% larger than the geometry.
Parameters
- feature: Feature
Returns Extent | undefined
Overrides AbstractSearchClient.getZoomToBbox
- Defined in tools/search/geoadminchsearchclient.ts:165

groupedResults

groupedResults(
results: Feature<Geometry, { [x: string]: any }>[],
): Record<string, Feature[]>
The property origin contains the result category.
Parameters
- results: Feature<Geometry, { [x: string]: any }>[]
Returns Record<string, Feature[]>
Overrides AbstractSearchClient.groupedResults
- Defined in tools/search/geoadminchsearchclient.ts:155

initializeSingleton

initializeSingleton(): void
Returns void
Inherited from AbstractSearchClient.initializeSingleton
- Defined in tools/search/abstractsearchclient.ts:43

`Protected`isNullOrUndefinedOrBlank

isNullOrUndefinedOrBlank(val: unknown): val is "" | null | undefined
Parameters
- val: unknown
Returns val is "" | null | undefined
Inherited from AbstractSearchClient.isNullOrUndefinedOrBlank
- Defined in base/GirafeSingleton.ts:19

`Protected`parseResponse

parseResponse(
response: Response,
): Promise<Feature<Geometry, { [x: string]: any }>[]>
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 }>[]>
Overrides AbstractSearchClient.parseResponse
- Defined in tools/search/geoadminchsearchclient.ts:101

requestSearch

requestSearch(
    term: string,
    filter: string[],
    abortController: AbortController,
): 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 }>[]>
Inherited from AbstractSearchClient.requestSearch
- Defined in tools/search/abstractsearchclient.ts:107

Class GeoAdminChSearchClient

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GeoAdminChSearchClient

Properties

Protected Readonlycontext

Protected ReadonlygeoJsonFormatter

ReadonlyproviderName

Protected ReadonlyresultSrid

ProtectedsearchFilterQueryParameter

Protected ReadonlysearchLangPlaceholder

ProtectedsearchLangQueryParameter

Protected ReadonlysearchTermPlaceholder

ProtectedsearchTermQueryParameter

Readonlytype

Protectedurl

Accessors

ProtectedmapProjection

Returns Projection

Methods

ProtectedbuildRequestUrl

Parameters

Returns URL

getI18nKeyForCategory

Parameters

Returns string

getSearchCategories

Returns Promise<string[]>

getZoomToBbox

Parameters

Returns Extent | undefined

groupedResults

Parameters

Returns Record<string, Feature[]>

initializeSingleton

Returns void

ProtectedisNullOrUndefinedOrBlank

Parameters

Returns val is "" | null | undefined

ProtectedparseResponse

Parameters

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

requestSearch

Parameters

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

Settings

On This Page

`Protected` `Readonly`context

`Protected` `Readonly`geoJsonFormatter

`Readonly`providerName

`Protected` `Readonly`resultSrid

`Protected`searchFilterQueryParameter

`Protected` `Readonly`searchLangPlaceholder

`Protected`searchLangQueryParameter

`Protected` `Readonly`searchTermPlaceholder

`Protected`searchTermQueryParameter

`Readonly`type

`Protected`url

`Protected`mapProjection

`Protected`buildRequestUrl

`Protected`isNullOrUndefinedOrBlank

`Protected`parseResponse