MapsSearchClient class

Clientklasse für die Interaktion mit dem Azure Maps-Suchdienst.

Konstruktoren

MapsSearchClient(AzureKeyCredential, MapsSearchClientOptions)

Erstellt eine Instanz von MapsSearchClient aus einem Abonnementschlüssel.

Beispiel

import { MapsSearchClient, AzureKeyCredential } from "@azure/maps-search";

const credential = new AzureKeyCredential("<subscription-key>");
const client = new MapsSearchClient(credential);
MapsSearchClient(TokenCredential, string, MapsSearchClientOptions)

Erstellt eine Instanz von MapsSearchClient aus einer Azure-Identität TokenCredential.

Beispiel

import { MapsSearchClient } from "@azure/maps-search";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = new MapsSearchClient(credential, "<maps-account-client-id>");

Methoden

beginFuzzySearchBatch(FuzzySearchRequest[], FuzzySearchBatchOptions)

Sendet Batches von Fuzzy-Suchanfragen. Die Methode gibt einen Poller zurück, um das Ergebnis später abzurufen.

beginReverseSearchAddressBatch(ReverseSearchAddressRequest[], ReverseSearchAddressBatchOptions)

Sendet Batches von Reverse-Geocoding-Anforderungen. Die Methode gibt einen Poller zurück, um das Ergebnis später abzurufen.

beginSearchAddressBatch(SearchAddressRequest[], SearchAddressBatchOptions)

Sendet Stapel von Geokodierungsanforderungen. Die Methode gibt einen Poller zurück, um das Ergebnis später abzurufen.

fuzzySearch(SearchQuery, FuzzySearchBaseOptions & OperationOptions)

Führt eine Freiformsuche durch, die die unscharfsten Eingaben verarbeitet und eine beliebige Kombination von Adress- oder POI-Token verarbeitet.

getGeometries(string[], OperationOptions)

Fordert die Geometriedaten an, z. B. einen Stadt- oder Länderumriss für einen Satz von Elementen.

getPointOfInterestCategories(GetPointOfInterestCategoriesOptions)

Fordert eine vollständige Liste der unterstützten Points of Interest (POI)-Kategorien an.

resumeFuzzySearchBatch(string, FuzzySearchBatchOptions)

Setzen Sie die Fuzzy-Suchanforderung mit einem serialisierten Zustand von einem anderen Abfrager fort.

Beispiel

const serializedState = poller.toString()
const rehydratedPoller = resumeFuzzySearchBatch(serializedState)
rehydratedPoller.poll()
resumeReverseSearchAddressBatch(string, ReverseSearchAddressBatchOptions)

Setzen Sie die umgekehrte Adresssuchanforderung mit einem serialisierten Zustand von einem anderen Abfrager fort.

Beispiel

const serializedState = poller.toString()
const rehydratedPoller = resumeReverseSearchAddressBatch(serializedState)
rehydratedPoller.poll()
resumeSearchAddressBatch(string, SearchAddressBatchOptions)

Setzen Sie die Adresssuchanforderung mit einem serialisierten Status aus einem anderen Abfragemodul fort.

Beispiel

const serializedState = poller.toString()
const rehydratedPoller = resumeSearchAddressBatch(serializedState)
rehydratedPoller.poll()
reverseSearchAddress(LatLon, ReverseSearchAddressOptions & OperationOptions)

Übersetzt eine Koordinaten in eine für Menschen verständliche Adresse.

reverseSearchCrossStreetAddress(LatLon, ReverseSearchCrossStreetAddressOptions)

Übersetzt eine Koordinaten in eine für Menschen verständliche Kreuzung.

searchAddress(string, SearchAddressOptions & OperationOptions)

Geokodiert eine Adresse.

searchAlongRoute(string, number, GeoJsonLineString, SearchAlongRouteOptions)

Führt eine unscharfe Suche nach POIs entlang einer angegebenen Route durch.

searchInsideGeometry(string, SearchGeometry, SearchInsideGeometryOptions)

Führt eine Freiformsuche innerhalb einer einzelnen Geometrie oder mehrerer Geometrien durch.

searchNearbyPointOfInterest(LatLon, SearchNearbyPointOfInterestOptions)

Fragt POI-Ergebnisse (Points of Interest) zu einem bestimmten Standort an.

searchPointOfInterest(SearchQuery, SearchPointOfInterestOptions)

Fragt POI-Ergebnisse (Points of Interest) nach Namen an

searchPointOfInterestCategory(SearchQuery, SearchPointOfInterestOptions)

Fordert POI-Ergebnisse (Points of Interest) aus einer bestimmten Kategorie an.

searchStructuredAddress(StructuredAddress, SearchStructuredAddressOptions)

Geokodiert eine strukturierte Adresse.

Details zum Konstruktor

MapsSearchClient(AzureKeyCredential, MapsSearchClientOptions)

Erstellt eine Instanz von MapsSearchClient aus einem Abonnementschlüssel.

Beispiel

import { MapsSearchClient, AzureKeyCredential } from "@azure/maps-search";

const credential = new AzureKeyCredential("<subscription-key>");
const client = new MapsSearchClient(credential);
new MapsSearchClient(credential: AzureKeyCredential, options?: MapsSearchClientOptions)

Parameter

credential
AzureKeyCredential

Eine AzureKeyCredential-Instanz, die zum Authentifizieren von Anforderungen an den Dienst verwendet wird

options
MapsSearchClientOptions

Optionen zum Konfigurieren des Suchclients

MapsSearchClient(TokenCredential, string, MapsSearchClientOptions)

Erstellt eine Instanz von MapsSearchClient aus einer Azure-Identität TokenCredential.

Beispiel

import { MapsSearchClient } from "@azure/maps-search";
import { DefaultAzureCredential } from "@azure/identity";

const credential = new DefaultAzureCredential();
const client = new MapsSearchClient(credential, "<maps-account-client-id>");
new MapsSearchClient(credential: TokenCredential, mapsAccountClientId: string, options?: MapsSearchClientOptions)

Parameter

credential
TokenCredential

Eine TokenCredential-Instanz, die zum Authentifizieren von Anforderungen an den Dienst verwendet wird

mapsAccountClientId

string

Die Azure Maps-Client-ID einer bestimmten Kartenressource

options
MapsSearchClientOptions

Optionen zum Konfigurieren des Suchclients

Details zur Methode

beginFuzzySearchBatch(FuzzySearchRequest[], FuzzySearchBatchOptions)

Sendet Batches von Fuzzy-Suchanfragen. Die Methode gibt einen Poller zurück, um das Ergebnis später abzurufen.

function beginFuzzySearchBatch(requests: FuzzySearchRequest[], options?: FuzzySearchBatchOptions): Promise<FuzzySearchBatchPoller>

Parameter

requests

FuzzySearchRequest[]

Das Array der zu verarbeitenden Suchanforderungen. Das Array kann maximal 10.000 Anforderungen enthalten und muss mindestens 1 Anforderung enthalten.

options
FuzzySearchBatchOptions

Optionale Parameter für den Vorgang

Gibt zurück

beginReverseSearchAddressBatch(ReverseSearchAddressRequest[], ReverseSearchAddressBatchOptions)

Sendet Batches von Reverse-Geocoding-Anforderungen. Die Methode gibt einen Poller zurück, um das Ergebnis später abzurufen.

function beginReverseSearchAddressBatch(requests: ReverseSearchAddressRequest[], options?: ReverseSearchAddressBatchOptions): Promise<ReverseSearchAddressBatchPoller>

Parameter

requests

ReverseSearchAddressRequest[]

Das Array der zu verarbeitenden Suchanforderungen. Das Array kann maximal 10.000 Anforderungen enthalten und muss mindestens 1 Anforderung enthalten.

options
ReverseSearchAddressBatchOptions

Optionale Parameter für den Vorgang

Gibt zurück

beginSearchAddressBatch(SearchAddressRequest[], SearchAddressBatchOptions)

Sendet Stapel von Geokodierungsanforderungen. Die Methode gibt einen Poller zurück, um das Ergebnis später abzurufen.

function beginSearchAddressBatch(requests: SearchAddressRequest[], options?: SearchAddressBatchOptions): Promise<FuzzySearchBatchPoller>

Parameter

requests

SearchAddressRequest[]

Das Array der zu verarbeitenden Suchanforderungen. Das Array kann maximal 10.000 Anforderungen enthalten und muss mindestens 1 Anforderung enthalten.

options
SearchAddressBatchOptions

Optionale Parameter für den Vorgang

Gibt zurück

fuzzySearch(SearchQuery, FuzzySearchBaseOptions & OperationOptions)

Führt eine Freiformsuche durch, die die unscharfsten Eingaben verarbeitet und eine beliebige Kombination von Adress- oder POI-Token verarbeitet.

function fuzzySearch(searchQuery: SearchQuery, options?: FuzzySearchBaseOptions & OperationOptions): Promise<SearchAddressResult>

Parameter

searchQuery
SearchQuery

Textabfrage und zu durchsuchende Standortinformationen

options

FuzzySearchBaseOptions & OperationOptions

Optionen für die Fuzzy-Suche

Gibt zurück

getGeometries(string[], OperationOptions)

Fordert die Geometriedaten an, z. B. einen Stadt- oder Länderumriss für einen Satz von Elementen.

function getGeometries(geometryIds: string[], options?: OperationOptions): Promise<EntityGeometry[]>

Parameter

geometryIds

string[]

Kommagetrennte Liste von Geometrie-UUIDs, die zuvor aus einer Online-Suchanfrage abgerufen wurden.

options
OperationOptions

Optionale Parameter für den Vorgang

Gibt zurück

Promise<EntityGeometry[]>

getPointOfInterestCategories(GetPointOfInterestCategoriesOptions)

Fordert eine vollständige Liste der unterstützten Points of Interest (POI)-Kategorien an.

function getPointOfInterestCategories(options?: GetPointOfInterestCategoriesOptions): Promise<PointOfInterestCategory[]>

Parameter

options
GetPointOfInterestCategoriesOptions

Optionale Parameter für den Vorgang

Gibt zurück

resumeFuzzySearchBatch(string, FuzzySearchBatchOptions)

Setzen Sie die Fuzzy-Suchanforderung mit einem serialisierten Zustand von einem anderen Abfrager fort.

Beispiel

const serializedState = poller.toString()
const rehydratedPoller = resumeFuzzySearchBatch(serializedState)
rehydratedPoller.poll()
function resumeFuzzySearchBatch(restoreFrom: string, options?: FuzzySearchBatchOptions): Promise<FuzzySearchBatchPoller>

Parameter

restoreFrom

string

Der serialisierte Zustand des vorherigen Abfragers.

options
FuzzySearchBatchOptions

Optionale Parameter für den Vorgang.

Gibt zurück

resumeReverseSearchAddressBatch(string, ReverseSearchAddressBatchOptions)

Setzen Sie die umgekehrte Adresssuchanforderung mit einem serialisierten Zustand von einem anderen Abfrager fort.

Beispiel

const serializedState = poller.toString()
const rehydratedPoller = resumeReverseSearchAddressBatch(serializedState)
rehydratedPoller.poll()
function resumeReverseSearchAddressBatch(restoreFrom: string, options?: ReverseSearchAddressBatchOptions): Promise<ReverseSearchAddressBatchPoller>

Parameter

restoreFrom

string

Der serialisierte Zustand des vorherigen Abfragers.

options
ReverseSearchAddressBatchOptions

Optionale Parameter für den Vorgang.

Gibt zurück

resumeSearchAddressBatch(string, SearchAddressBatchOptions)

Setzen Sie die Adresssuchanforderung mit einem serialisierten Status aus einem anderen Abfragemodul fort.

Beispiel

const serializedState = poller.toString()
const rehydratedPoller = resumeSearchAddressBatch(serializedState)
rehydratedPoller.poll()
function resumeSearchAddressBatch(restoreFrom: string, options?: SearchAddressBatchOptions): Promise<FuzzySearchBatchPoller>

Parameter

restoreFrom

string

Der serialisierte Zustand des vorherigen Abfragers.

options
SearchAddressBatchOptions

Optionale Parameter für den Vorgang.

Gibt zurück

reverseSearchAddress(LatLon, ReverseSearchAddressOptions & OperationOptions)

Übersetzt eine Koordinaten in eine für Menschen verständliche Adresse.

function reverseSearchAddress(coordinates: LatLon, options?: ReverseSearchAddressOptions & OperationOptions): Promise<ReverseSearchAddressResult>

Parameter

coordinates
LatLon

Die Koordinaten für die Rückwärtssuchanfrage

options

ReverseSearchAddressOptions & OperationOptions

Optionale Parameter für den Vorgang

Gibt zurück

reverseSearchCrossStreetAddress(LatLon, ReverseSearchCrossStreetAddressOptions)

Übersetzt eine Koordinaten in eine für Menschen verständliche Kreuzung.

function reverseSearchCrossStreetAddress(coordinates: LatLon, options?: ReverseSearchCrossStreetAddressOptions): Promise<ReverseSearchCrossStreetAddressResult>

Parameter

coordinates
LatLon

Die Koordinaten für die Rückwärtssuchanfrage

options
ReverseSearchCrossStreetAddressOptions

Optionale Parameter für den Vorgang

Gibt zurück

searchAddress(string, SearchAddressOptions & OperationOptions)

Geokodiert eine Adresse.

function searchAddress(query: string, options?: SearchAddressOptions & OperationOptions): Promise<SearchAddressResult>

Parameter

query

string

Die Adresse, nach der gesucht werden soll (z. B. "1 Microsoft way, Redmond, WA")

options

SearchAddressOptions & OperationOptions

Optionale Parameter für den Vorgang

Gibt zurück

searchAlongRoute(string, number, GeoJsonLineString, SearchAlongRouteOptions)

Führt eine unscharfe Suche nach POIs entlang einer angegebenen Route durch.

function searchAlongRoute(query: string, maxDetourTimeInSeconds: number, route: GeoJsonLineString, options?: SearchAlongRouteOptions): Promise<SearchAddressResult>

Parameter

query

string

Der POI-Name, nach dem gesucht werden soll (z. B. "Freiheitsstatue", "coffee", "pizza").

maxDetourTimeInSeconds

number

Maximale Umleitungszeit des Sehenswürdigkeitspunkts in Sekunden. Der Maximale Wert beträgt 3600 Sekunden.

route
GeoJsonLineString

Dies stellt die Route dar, entlang der gesucht werden soll, und sollte ein gültiger GeoJSON LineString Typ sein.

options
SearchAlongRouteOptions

Optionale Parameter für den Vorgang

Gibt zurück

searchInsideGeometry(string, SearchGeometry, SearchInsideGeometryOptions)

Führt eine Freiformsuche innerhalb einer einzelnen Geometrie oder mehrerer Geometrien durch.

function searchInsideGeometry(query: string, geometry: SearchGeometry, options?: SearchInsideGeometryOptions): Promise<SearchAddressResult>

Parameter

query

string

Der POI-Name, nach dem gesucht werden soll (z. B. "Freiheitsstatue", "coffee", "pizza").

geometry
SearchGeometry

Dies stellt die Geometrie für ein oder mehrere geographische Features (Parks, Staatsgrenzen usw.) dar, in denen gesucht werden soll, und sollte ein GeoJSON-kompatibler Typ sein. Weitere Informationen finden Sie unter RFC 7946-.

options
SearchInsideGeometryOptions

Optionale Parameter für den Vorgang

Gibt zurück

searchNearbyPointOfInterest(LatLon, SearchNearbyPointOfInterestOptions)

Fragt POI-Ergebnisse (Points of Interest) zu einem bestimmten Standort an.

function searchNearbyPointOfInterest(coordinates: LatLon, options?: SearchNearbyPointOfInterestOptions): Promise<SearchAddressResult>

Parameter

coordinates
LatLon

Die Koordinaten für die POI-Suche in der Nähe

options
SearchNearbyPointOfInterestOptions

Optionale Parameter für den Vorgang

Gibt zurück

searchPointOfInterest(SearchQuery, SearchPointOfInterestOptions)

Fragt POI-Ergebnisse (Points of Interest) nach Namen an

function searchPointOfInterest(searchQuery: SearchQuery, options?: SearchPointOfInterestOptions): Promise<SearchAddressResult>

Parameter

searchQuery
SearchQuery

Textabfrage und zu durchsuchende Standortinformationen

options
SearchPointOfInterestOptions

Optionen für die Suche nach POI

Gibt zurück

searchPointOfInterestCategory(SearchQuery, SearchPointOfInterestOptions)

Fordert POI-Ergebnisse (Points of Interest) aus einer bestimmten Kategorie an.

function searchPointOfInterestCategory(searchQuery: SearchQuery, options?: SearchPointOfInterestOptions): Promise<SearchAddressResult>

Parameter

searchQuery
SearchQuery

Textabfrage und zu durchsuchende Standortinformationen

options
SearchPointOfInterestOptions

Optionen für die Suche nach POI-Kategorie

Gibt zurück

searchStructuredAddress(StructuredAddress, SearchStructuredAddressOptions)

Geokodiert eine strukturierte Adresse.

function searchStructuredAddress(structuredAddress: StructuredAddress, options?: SearchStructuredAddressOptions): Promise<SearchAddressResult>

Parameter

structuredAddress
StructuredAddress

Strukturierte Adresse, die für die Geokodierung verwendet wird

options
SearchStructuredAddressOptions

Optionale Parameter für den Vorgang

Gibt zurück