Freigeben über

SearchURL class

  • Referenz
Paket:
azure-maps-rest

Eine SearchURL stellt eine URL zu den Azure Maps Suchvorgängen dar.

Extends
MapsURL

Konstruktoren

SearchURL(Pipeline, string)

Erstellt eine instance von SearchURL.

Geerbte Eigenschaften

mapsUrl

Basis-URL-Zeichenfolgenwert.

Methoden

searchAddress(Aborter, string, SearchAddressOptions)

Adressgeocodierung In vielen Fällen kann der vollständige Suchdienst zu viel sein, für instance, wenn Sie nur an der herkömmlichen Geocodierung interessiert sind. auf Search kann auch exklusiv für die Adresssuche zugegriffen werden. Die Geocodierung erfolgt durch Erreichen des Geocodeendpunkts mit nur der betreffenden Adresse oder Teiladresse. Der Geocodierungssuchindex wird nach allen Daten abgefragt, die über den Daten auf Straßenebene liegen. Es werden keine POIs zurückgegeben. Beachten Sie, dass der Geocoder gegenüber Tippfehlern und unvollständigen Adressen sehr tolerant ist. Es wird auch alles von genauen Straßenadressen oder Straßen oder Kreuzungen sowie von geografischen Regionen auf höherer Ebene wie Stadtzentren, Landkreisen, Bundesstaaten usw. behandeln. Verwendet die API zum Abrufen von Search Adressen:https://docs.microsoft.com/rest/api/maps/search/getsearchaddress
searchAddressReverse(Aborter, GeoJSON.Position, SearchAddressReverseOptions)

Umkehren der Geocodierung in eine Adresse Es kann vorkommen, dass Sie eine Koordinate (Beispiel: -122.3862, 37.786505) in eine für Menschen verständliche Adresse übersetzen müssen. Dies wird meistens bei Anwendungen für die Nachverfolgung benötigt, bei denen Sie einen GPS-Feed von dem Gerät oder der Ressource erhalten und wissen möchten, welche Adresse sich an dieser Koordinate befindet. Dieser Endpunkt gibt Adressinformationen für eine bestimmte Koordinate zurück. Verwendet die API zum Abrufen von Search Adressenrückkehr:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse
searchAddressReverseCrossStreet(Aborter, GeoJSON.Position, SearchAddressReverseCrossStreetOptions)

Umgekehrte Geocodierung in eine Cross Street Es kann vorkommen, dass Sie eine Koordinate (Beispiel: -122.3862, 37.786505) in eine menschlich verständliche Kreuzstraße übersetzen müssen. Dies wird meistens bei Anwendungen für die Nachverfolgung benötigt, bei denen Sie einen GPS-Feed von dem Gerät oder der Ressource erhalten und wissen möchten, welche Adresse sich an dieser Koordinate befindet. Dieser Endpunkt gibt straßenübergreifende Informationen für eine bestimmte Koordinate zurück. Verwendet die Get Search Address Reverse Cross Street API:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreversecrossstreet
searchAddressStructured(Aborter, string, SearchAddressStructuredOptions)

Geocodierung strukturierter Adressen Auf die Azure-Adressgeocodierung kann auch exklusiv für die strukturierte Adresssuche zugegriffen werden. Der Geocodierungssuchindex wird nach allen Daten abgefragt, die über den Daten auf Straßenebene liegen. Es werden keine POIs zurückgegeben. Beachten Sie, dass der Geocoder gegenüber Tippfehlern und unvollständigen Adressen sehr tolerant ist. Es wird auch alles von genauen Straßenadressen oder Straßen oder Kreuzungen sowie von geografischen Regionen auf höherer Ebene wie Stadtzentren, Landkreisen, Bundesstaaten usw. behandeln. Verwendet die get Search Address Structured API:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured
searchAlongRoute(Aborter, string, number, SearchAlongRouteRequestBody, SearchAlongRouteOptions)

Mit dem endpunkt Search Entlang der Route können Sie eine Fuzzysuche nach POIs entlang einer angegebenen Route durchführen. Diese Suche wird eingeschränkt, indem das maxDetourTime einschränkende Measure angegeben wird. Zum Senden der Routenpunkte verwenden Sie eine body , die das route als GeoJSON LineString Typ dargestellte Objekt enthält, und der Content-Type Header wird auf application/jsonfestgelegt. Jeder Routenpunkt in route wird als GeoJSON Position Typ dargestellt, d. h. als Array, auf dem der Längengrad vom Breitengrad und dem Höhenwert ignoriert wird. Die route sollte mindestens 2 Routenpunkte enthalten. Es ist möglich, dass die ursprüngliche Route geändert wird, einige punkte werden möglicherweise übersprungen. Wenn die Route, die den gefundenen Punkt durchläuft, schneller als der ursprüngliche ist, ist der detourTime Wert in der Antwort negativ. Verwendet die Post Search Along Route-API:https://docs.microsoft.com/rest/api/maps/search/postsearchalongroute
searchFuzzy(Aborter, string | GeoJSON.Position, SearchFuzzyOptions)

Free Form Search Die grundlegende Standard-API ist Free Form Search, die die meisten Fuzzy von Eingaben verarbeitet, die eine Beliebige Kombination von Adress- oder POI-Token verarbeiten. Diese Such-API ist die kanonische "einzeilige Suche". Die Freiform-Search-API ist eine nahtlose Kombination aus POI-Suche und Geocodierung. Die API kann auch mit einer kontextbezogenen Position (lat./lon.-Paar) gewichtet oder vollständig durch eine Koordinate und einen Radius eingeschränkt werden, oder sie kann allgemeiner ohne geoverzerrungsbasierte Ankerpunkte ausgeführt werden. Wir empfehlen Ihnen dringend, den Parameter "countrySet" zu verwenden, um nur die Länder anzugeben, für die Ihre Anwendung abgedeckt werden muss, da das Standardverhalten das Durchsuchen der gesamten Welt ist und möglicherweise unnötige Ergebnisse zurückgibt. Beispiel: countrySet=US,FR. Eine vollständige Liste aller unterstützten Länder finden Sie unter [Search Coverage] (https://docs.microsoft.com/azure/location-based-services/geocoding-coverage). Die meisten Search Abfragen standardmäßig =2, maxFuzzyLevelum die Leistung zu steigern und ungewöhnliche Ergebnisse zu reduzieren. Dieser neue Standardwert kann bei Bedarf pro Anforderung überschrieben werden, indem der Abfrageparam maxFuzzyLevel=3 oder 4 übergeben wird. Verwendet die Get Search Fuzzy-API:https://docs.microsoft.com/rest/api/maps/search/getsearchfuzzy
searchInsideGeometry(Aborter, string, SearchInsideGeometryRequestBody, SearchInsideGeometryOptions)

Mit dem Search Geometry-Endpunkts können Sie eine Freiformsuche innerhalb einer einzelnen Geometrie oder einer Vielzahl von Geometrien ausführen. Die Suchergebnisse, die innerhalb der Geometrie/Geometrien liegen, werden zurückgegeben. Die zu durchsuchenden geografischen Features können als Polygon- und/oder Kreisgeometrien modelliert werden, die mit einem der folgenden GeoJSON Typen dargestellt werden: GeoJSON FeatureCollection, The geometry kann als GeoJSON FeatureCollection Objekt dargestellt werden. Dies ist die empfohlene Option, wenn die Geometrie sowohl Polygone als auch Kreise enthält. Die FeatureCollection kann maximal 50 GeoJSON Feature Objekte enthalten. Jedes Feature Objekt sollte entweder ein Polygon oder einen Kreis mit den folgenden Bedingungen darstellen: Ein Feature Objekt für die Polygongeometrie kann maximal 50 Koordinaten aufweisen, und seine Eigenschaften müssen leer sein. Ein Feature Objekt für die Circle-Geometrie besteht aus einer Mitte , die mit einem GeoJSON Point Typ und einem Radiuswert (in Metern) dargestellt wird, der in den Eigenschaften des Objekts zusammen mit der subType-Eigenschaft angegeben werden muss, deren Wert "Circle" sein soll. Eine Beispieldarstellung FeatureCollection finden Sie weiter unten im Abschnitt Beispiele. GeoJSON GeometryCollection, kann geometry als GeoJSON GeometryCollection Objekt dargestellt werden. Dies ist die empfohlene Option, wenn die Geometrie nur eine Liste von Polygonen enthält. Die GeometryCollection kann maximal 50 GeoJSON Polygon Objekte enthalten. Jedes Polygon Objekt kann maximal 50 Koordinaten aufweisen. Eine Beispieldarstellung GeometryCollection finden Sie weiter unten im Abschnitt Beispiele. GeoJSON Polygon, kann geometry als GeoJSON Polygon Objekt dargestellt werden. Dies ist die empfohlene Option, wenn die Geometrie ein einzelnes Polygon enthält. Das Polygon Objekt kann maximal 50 Koordinaten aufweisen. Verwendet die Post Search Inside Geometry-API:https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry
searchNearby(Aborter, GeoJSON.Position, SearchNearbyOptions)

In der Nähe Search Wenn Sie einen Anwendungsfall für das Abrufen von POI-Ergebnissen an einem bestimmten Ort haben, kann die Suchmethode in der Nähe die richtige Wahl sein. Dieser Endpunkt liefert nur POI-Ergebnisse und übernimmt keinen Suchabfrageparameter. Verwendet die API get Search Nearby:https://docs.microsoft.com/rest/api/maps/search/getsearchnearby
searchPOI(Aborter, string, SearchPOIOptions)

Abrufen von POI nach Name Wenn Für Ihren Suchanwendungsfall nur POI-Ergebnisse erforderlich sind, können Sie den POI-Endpunkt für die Suche verwenden. Dieser Endpunkt gibt nur POI-Ergebnisse zurück. Verwendet die GET Search POI-API:https://docs.microsoft.com/rest/api/maps/search/getsearchpoi
searchPOICategory(Aborter, string, SearchPOICategoryOptions)

Abrufen von POI nach Kategorie Wenn ihr Suchanwendungsfall nur POI-Ergebnisse erfordert, die nach Kategorie gefiltert sind, können Sie den Kategorieendpunkt verwenden. Dieser Endpunkt gibt nur POI-Ergebnisse zurück, die wie angegeben kategorisiert sind. Eine Liste der verfügbaren Kategorien finden Sie hier. Verwendet die API zum Abrufen Search POI-Kategorie:https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory
searchPolygon(Aborter, string[])

Mit der Search Polygon-API können Sie die Geometriedaten anfordern, z. B. eine Stadt- oder Ländergliederung für eine Gruppe von Entitäten, die zuvor aus einer Online-Search-Anforderung im GeoJSON-Format abgerufen wurden. Die geometry-ID wird im dataSources-Objekt unter "geometry" und "id" entweder in einem Search Address oder Search Fuzzyaufruf zurückgegeben. Beachten Sie, dass jede geometrie-ID, die von einem Online-Search-Endpunkt abgerufen wird, eine begrenzte Lebensdauer hat. Der Client sollte geometrie-IDs nicht im persistenten Speicher für eine spätere Empfehlung speichern, da die Stabilität dieser Bezeichner für einen längeren Zeitraum nicht garantiert ist. Es wird erwartet, dass eine Anforderung an die Polygon-Methode innerhalb weniger Minuten nach der Anforderung an die Online-Search-Methode erfolgt, die die ID bereitgestellt hat. Der Dienst ermöglicht Batchanforderungen mit bis zu 20 Bezeichnern.

Verwendet die GET Search Polygon-API:https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon

Geerbte Methoden

newPipeline(Credential, INewPipelineOptions)

Eine statische Methode zum Erstellen eines neuen Pipelineobjekts mit bereitgestellten Anmeldeinformationen.

Details zum Konstruktor

SearchURL(Pipeline, string)

Erstellt eine instance von SearchURL.

new SearchURL(pipeline: Pipeline, mapsUrl?: string)

Parameter

pipeline
Pipeline

Rufen Sie MapsURL.newPipeline() auf, um eine Standardpipeline zu erstellen oder eine benutzerdefinierte Pipeline bereitzustellen.

mapsUrl

string

Eine URL-Zeichenfolge, die auf Azure Maps Dienst zeigt. Der Standardwert ist "https://atlas.microsoft.com". Wenn kein Protokoll angegeben wird, z. B. "atlas.microsoft.com", https wird angenommen.

Geerbte Eigenschaftsdetails

mapsUrl

Basis-URL-Zeichenfolgenwert.

mapsUrl: string

Eigenschaftswert

string

Geerbt vonMapsURL.mapsUrl

Details zur Methode

searchAddress(Aborter, string, SearchAddressOptions)

Adressgeocodierung In vielen Fällen kann der vollständige Suchdienst zu viel sein, für instance, wenn Sie nur an der herkömmlichen Geocodierung interessiert sind. auf Search kann auch exklusiv für die Adresssuche zugegriffen werden. Die Geocodierung erfolgt durch Erreichen des Geocodeendpunkts mit nur der betreffenden Adresse oder Teiladresse. Der Geocodierungssuchindex wird nach allen Daten abgefragt, die über den Daten auf Straßenebene liegen. Es werden keine POIs zurückgegeben. Beachten Sie, dass der Geocoder gegenüber Tippfehlern und unvollständigen Adressen sehr tolerant ist. Es wird auch alles von genauen Straßenadressen oder Straßen oder Kreuzungen sowie von geografischen Regionen auf höherer Ebene wie Stadtzentren, Landkreisen, Bundesstaaten usw. behandeln. Verwendet die API zum Abrufen von Search Adressen:https://docs.microsoft.com/rest/api/maps/search/getsearchaddress

function searchAddress(aborter: Aborter, query: string, options?: SearchAddressOptions): Promise<SearchAddressResponse>

Parameter

aborter
Aborter

Erstellen Sie eine neue Aborter-instance mit Aborter.none oder Aborter.timeout(). Weitere Beispiele zum Abbrechen von Anforderungen erhalten Sie in den Dokumenten von Aborter.

query

string

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

options
SearchAddressOptions

Gibt zurück

Promise<SearchAddressResponse>

searchAddressReverse(Aborter, GeoJSON.Position, SearchAddressReverseOptions)

Umkehren der Geocodierung in eine Adresse Es kann vorkommen, dass Sie eine Koordinate (Beispiel: -122.3862, 37.786505) in eine für Menschen verständliche Adresse übersetzen müssen. Dies wird meistens bei Anwendungen für die Nachverfolgung benötigt, bei denen Sie einen GPS-Feed von dem Gerät oder der Ressource erhalten und wissen möchten, welche Adresse sich an dieser Koordinate befindet. Dieser Endpunkt gibt Adressinformationen für eine bestimmte Koordinate zurück. Verwendet die API zum Abrufen von Search Adressenrückkehr:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreverse

function searchAddressReverse(aborter: Aborter, position: GeoJSON.Position, options?: SearchAddressReverseOptions): Promise<SearchAddressReverseResponse>

Parameter

aborter
Aborter

Erstellen Sie eine neue Aborter-instance mit Aborter.none oder Aborter.timeout(). Weitere Beispiele zum Abbrechen von Anforderungen erhalten Sie in den Dokumenten von Aborter.

position
GeoJSON.Position

Die Position zum Umkehren der Suche, ein Koordinatenarray von [longitude, latitude] z. B. [-122.125679, 47.641268].

options
SearchAddressReverseOptions

Gibt zurück

Promise<SearchAddressReverseResponse>

searchAddressReverseCrossStreet(Aborter, GeoJSON.Position, SearchAddressReverseCrossStreetOptions)

Umgekehrte Geocodierung in eine Cross Street Es kann vorkommen, dass Sie eine Koordinate (Beispiel: -122.3862, 37.786505) in eine menschlich verständliche Kreuzstraße übersetzen müssen. Dies wird meistens bei Anwendungen für die Nachverfolgung benötigt, bei denen Sie einen GPS-Feed von dem Gerät oder der Ressource erhalten und wissen möchten, welche Adresse sich an dieser Koordinate befindet. Dieser Endpunkt gibt straßenübergreifende Informationen für eine bestimmte Koordinate zurück. Verwendet die Get Search Address Reverse Cross Street API:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressreversecrossstreet

function searchAddressReverseCrossStreet(aborter: Aborter, position: GeoJSON.Position, options?: SearchAddressReverseCrossStreetOptions): Promise<SearchAddressReverseCrossStreetResponse>

Parameter

aborter
Aborter

Erstellen Sie eine neue Aborter-instance mit Aborter.none oder Aborter.timeout(). Weitere Beispiele zum Abbrechen von Anforderungen erhalten Sie in den Dokumenten von Aborter.

position
GeoJSON.Position

Die Position zum Umkehren der Suche, ein Koordinatenarray von [longitude, latitude] z. B. [-122.125679, 47.641268].

options
SearchAddressReverseCrossStreetOptions

Gibt zurück

Promise<SearchAddressReverseCrossStreetResponse>

searchAddressStructured(Aborter, string, SearchAddressStructuredOptions)

Geocodierung strukturierter Adressen Auf die Azure-Adressgeocodierung kann auch exklusiv für die strukturierte Adresssuche zugegriffen werden. Der Geocodierungssuchindex wird nach allen Daten abgefragt, die über den Daten auf Straßenebene liegen. Es werden keine POIs zurückgegeben. Beachten Sie, dass der Geocoder gegenüber Tippfehlern und unvollständigen Adressen sehr tolerant ist. Es wird auch alles von genauen Straßenadressen oder Straßen oder Kreuzungen sowie von geografischen Regionen auf höherer Ebene wie Stadtzentren, Landkreisen, Bundesstaaten usw. behandeln. Verwendet die get Search Address Structured API:https://docs.microsoft.com/rest/api/maps/search/getsearchaddressstructured

function searchAddressStructured(aborter: Aborter, countryCode: string, options?: SearchAddressStructuredOptions): Promise<SearchAddressStructuredResponse>

Parameter

aborter
Aborter

Erstellen Sie eine neue Aborter-instance mit Aborter.none oder Aborter.timeout(). Weitere Beispiele zum Abbrechen von Anforderungen erhalten Sie in den Dokumenten von Aborter.

countryCode

string

Der 2 oder 3 Buchstaben ISO3166-1-Ländercodeteil einer Adresse. Z.B. USA.

options
SearchAddressStructuredOptions

Gibt zurück

Promise<SearchAddressStructuredResponse>

searchAlongRoute(Aborter, string, number, SearchAlongRouteRequestBody, SearchAlongRouteOptions)

Mit dem endpunkt Search Entlang der Route können Sie eine Fuzzysuche nach POIs entlang einer angegebenen Route durchführen. Diese Suche wird eingeschränkt, indem das maxDetourTime einschränkende Measure angegeben wird. Zum Senden der Routenpunkte verwenden Sie eine body , die das route als GeoJSON LineString Typ dargestellte Objekt enthält, und der Content-Type Header wird auf application/jsonfestgelegt. Jeder Routenpunkt in route wird als GeoJSON Position Typ dargestellt, d. h. als Array, auf dem der Längengrad vom Breitengrad und dem Höhenwert ignoriert wird. Die route sollte mindestens 2 Routenpunkte enthalten. Es ist möglich, dass die ursprüngliche Route geändert wird, einige punkte werden möglicherweise übersprungen. Wenn die Route, die den gefundenen Punkt durchläuft, schneller als der ursprüngliche ist, ist der detourTime Wert in der Antwort negativ. Verwendet die Post Search Along Route-API:https://docs.microsoft.com/rest/api/maps/search/postsearchalongroute

function searchAlongRoute(aborter: Aborter, query: string, maxDetourTime: number, body: SearchAlongRouteRequestBody, options?: SearchAlongRouteOptions): Promise<SearchAlongRouteResponse>

Parameter

aborter
Aborter

Erstellen Sie eine neue Aborter-instance mit Aborter.none oder Aborter.timeout(). Weitere Beispiele zum Abbrechen von Anforderungen erhalten Sie in den Dokumenten von Aborter.

query

string

Die anwendbare Abfragezeichenfolge (z. B. "seattle", "pizza").

maxDetourTime

number

Maximale Umleitungszeit des Point of Interest in Sekunden. Maximaler Wert ist 3600 Sekunden

body
SearchAlongRouteRequestBody

Dies stellt die Zusuchroute dar und sollte ein gültiger GeoJSON LineString Typ sein. Weitere Informationen finden Sie unter RFC 7946 .

options
SearchAlongRouteOptions

Gibt zurück

Promise<SearchAlongRouteResponse>

searchFuzzy(Aborter, string | GeoJSON.Position, SearchFuzzyOptions)

Free Form Search Die grundlegende Standard-API ist Free Form Search, die die meisten Fuzzy von Eingaben verarbeitet, die eine Beliebige Kombination von Adress- oder POI-Token verarbeiten. Diese Such-API ist die kanonische "einzeilige Suche". Die Freiform-Search-API ist eine nahtlose Kombination aus POI-Suche und Geocodierung. Die API kann auch mit einer kontextbezogenen Position (lat./lon.-Paar) gewichtet oder vollständig durch eine Koordinate und einen Radius eingeschränkt werden, oder sie kann allgemeiner ohne geoverzerrungsbasierte Ankerpunkte ausgeführt werden. Wir empfehlen Ihnen dringend, den Parameter "countrySet" zu verwenden, um nur die Länder anzugeben, für die Ihre Anwendung abgedeckt werden muss, da das Standardverhalten das Durchsuchen der gesamten Welt ist und möglicherweise unnötige Ergebnisse zurückgibt. Beispiel: countrySet=US,FR. Eine vollständige Liste aller unterstützten Länder finden Sie unter [Search Coverage] (https://docs.microsoft.com/azure/location-based-services/geocoding-coverage). Die meisten Search Abfragen standardmäßig =2, maxFuzzyLevelum die Leistung zu steigern und ungewöhnliche Ergebnisse zu reduzieren. Dieser neue Standardwert kann bei Bedarf pro Anforderung überschrieben werden, indem der Abfrageparam maxFuzzyLevel=3 oder 4 übergeben wird. Verwendet die Get Search Fuzzy-API:https://docs.microsoft.com/rest/api/maps/search/getsearchfuzzy

function searchFuzzy(aborter: Aborter, query: string | GeoJSON.Position, options?: SearchFuzzyOptions): Promise<SearchFuzzyResponse>

Parameter

aborter
Aborter

Erstellen Sie eine neue Aborter-instance mit Aborter.none oder Aborter.timeout(). Weitere Beispiele zum Abbrechen von Anforderungen erhalten Sie in den Dokumenten von Aborter.

query

string | GeoJSON.Position

Die anwendbare Abfragezeichenfolge (z. B. "seattle", "pizza"). Kann auch als Koordinatenarray von [longitude, latitude] angegeben werden (z. B. [-122.125679, 47.641268]).

options
SearchFuzzyOptions

Gibt zurück

Promise<SearchFuzzyResponse>

searchInsideGeometry(Aborter, string, SearchInsideGeometryRequestBody, SearchInsideGeometryOptions)

Mit dem Search Geometry-Endpunkts können Sie eine Freiformsuche innerhalb einer einzelnen Geometrie oder einer Vielzahl von Geometrien ausführen. Die Suchergebnisse, die innerhalb der Geometrie/Geometrien liegen, werden zurückgegeben. Die zu durchsuchenden geografischen Features können als Polygon- und/oder Kreisgeometrien modelliert werden, die mit einem der folgenden GeoJSON Typen dargestellt werden: GeoJSON FeatureCollection, The geometry kann als GeoJSON FeatureCollection Objekt dargestellt werden. Dies ist die empfohlene Option, wenn die Geometrie sowohl Polygone als auch Kreise enthält. Die FeatureCollection kann maximal 50 GeoJSON Feature Objekte enthalten. Jedes Feature Objekt sollte entweder ein Polygon oder einen Kreis mit den folgenden Bedingungen darstellen: Ein Feature Objekt für die Polygongeometrie kann maximal 50 Koordinaten aufweisen, und seine Eigenschaften müssen leer sein. Ein Feature Objekt für die Circle-Geometrie besteht aus einer Mitte , die mit einem GeoJSON Point Typ und einem Radiuswert (in Metern) dargestellt wird, der in den Eigenschaften des Objekts zusammen mit der subType-Eigenschaft angegeben werden muss, deren Wert "Circle" sein soll. Eine Beispieldarstellung FeatureCollection finden Sie weiter unten im Abschnitt Beispiele. GeoJSON GeometryCollection, kann geometry als GeoJSON GeometryCollection Objekt dargestellt werden. Dies ist die empfohlene Option, wenn die Geometrie nur eine Liste von Polygonen enthält. Die GeometryCollection kann maximal 50 GeoJSON Polygon Objekte enthalten. Jedes Polygon Objekt kann maximal 50 Koordinaten aufweisen. Eine Beispieldarstellung GeometryCollection finden Sie weiter unten im Abschnitt Beispiele. GeoJSON Polygon, kann geometry als GeoJSON Polygon Objekt dargestellt werden. Dies ist die empfohlene Option, wenn die Geometrie ein einzelnes Polygon enthält. Das Polygon Objekt kann maximal 50 Koordinaten aufweisen. Verwendet die Post Search Inside Geometry-API:https://docs.microsoft.com/rest/api/maps/search/postsearchinsidegeometry

function searchInsideGeometry(aborter: Aborter, query: string, body: SearchInsideGeometryRequestBody, options?: SearchInsideGeometryOptions): Promise<SearchInsideGeometryResponse>

Parameter

aborter
Aborter

Erstellen Sie eine neue Aborter-instance mit Aborter.none oder Aborter.timeout(). Weitere Beispiele zum Abbrechen von Anforderungen erhalten Sie in den Dokumenten von Aborter.

query

string

Die anwendbare Abfragezeichenfolge (z. B. "seattle", "pizza").

body
SearchInsideGeometryRequestBody

Dies stellt die Geometrie für ein oder mehrere geografische Merkmale (Parks, Zustandsgrenze usw.) dar, in die gesucht werden soll, und sollte ein GeoJSON-konformer Typ sein. Weitere Informationen finden Sie unter RFC 7946 .

options
SearchInsideGeometryOptions

Gibt zurück

Promise<SearchInsideGeometryResponse>

searchNearby(Aborter, GeoJSON.Position, SearchNearbyOptions)

In der Nähe Search Wenn Sie einen Anwendungsfall für das Abrufen von POI-Ergebnissen an einem bestimmten Ort haben, kann die Suchmethode in der Nähe die richtige Wahl sein. Dieser Endpunkt liefert nur POI-Ergebnisse und übernimmt keinen Suchabfrageparameter. Verwendet die API get Search Nearby:https://docs.microsoft.com/rest/api/maps/search/getsearchnearby

function searchNearby(aborter: Aborter, location: GeoJSON.Position, options?: SearchNearbyOptions): Promise<SearchNearbyResponse>

Parameter

aborter
Aborter

Erstellen Sie eine neue Aborter-instance mit Aborter.none oder Aborter.timeout(). Weitere Beispiele zum Abbrechen von Anforderungen erhalten Sie in den Dokumenten von Aborter.

location
GeoJSON.Position

Speicherort, an dem die Ergebnisse verzerrt sein sollen. Sollte ein Array von [longitude, latitude]sein, z. B. [-121.89, 37.337].

options
SearchNearbyOptions

Gibt zurück

Promise<SearchNearbyResponse>

searchPOI(Aborter, string, SearchPOIOptions)

Abrufen von POI nach Name Wenn Für Ihren Suchanwendungsfall nur POI-Ergebnisse erforderlich sind, können Sie den POI-Endpunkt für die Suche verwenden. Dieser Endpunkt gibt nur POI-Ergebnisse zurück. Verwendet die GET Search POI-API:https://docs.microsoft.com/rest/api/maps/search/getsearchpoi

function searchPOI(aborter: Aborter, query: string, options?: SearchPOIOptions): Promise<SearchPOIResponse>

Parameter

aborter
Aborter

Erstellen Sie eine neue Aborter-instance mit Aborter.none oder Aborter.timeout(). Weitere Beispiele zum Abbrechen von Anforderungen erhalten Sie in den Dokumenten von Aborter.

query

string

Der zu suchde POI-Name (z. B. "Freiheitsstatue", "Starbucks").

options
SearchPOIOptions

Gibt zurück

Promise<SearchPOIResponse>

searchPOICategory(Aborter, string, SearchPOICategoryOptions)

Abrufen von POI nach Kategorie Wenn ihr Suchanwendungsfall nur POI-Ergebnisse erfordert, die nach Kategorie gefiltert sind, können Sie den Kategorieendpunkt verwenden. Dieser Endpunkt gibt nur POI-Ergebnisse zurück, die wie angegeben kategorisiert sind. Eine Liste der verfügbaren Kategorien finden Sie hier. Verwendet die API zum Abrufen Search POI-Kategorie:https://docs.microsoft.com/rest/api/maps/search/getsearchpoicategory

function searchPOICategory(aborter: Aborter, query: string, options?: SearchPOICategoryOptions): Promise<SearchPOICategoryResponse>

Parameter

aborter
Aborter

Erstellen Sie eine neue Aborter-instance mit Aborter.none oder Aborter.timeout(). Weitere Beispiele zum Abbrechen von Anforderungen erhalten Sie in den Dokumenten von Aborter.

query

string

Die zu suchde POI-Kategorie (z. B. "AIRPORT", "BEACH").

options
SearchPOICategoryOptions

Gibt zurück

Promise<SearchPOICategoryResponse>

searchPolygon(Aborter, string[])

Mit der Search Polygon-API können Sie die Geometriedaten anfordern, z. B. eine Stadt- oder Ländergliederung für eine Gruppe von Entitäten, die zuvor aus einer Online-Search-Anforderung im GeoJSON-Format abgerufen wurden. Die geometry-ID wird im dataSources-Objekt unter "geometry" und "id" entweder in einem Search Address oder Search Fuzzyaufruf zurückgegeben. Beachten Sie, dass jede geometrie-ID, die von einem Online-Search-Endpunkt abgerufen wird, eine begrenzte Lebensdauer hat. Der Client sollte geometrie-IDs nicht im persistenten Speicher für eine spätere Empfehlung speichern, da die Stabilität dieser Bezeichner für einen längeren Zeitraum nicht garantiert ist. Es wird erwartet, dass eine Anforderung an die Polygon-Methode innerhalb weniger Minuten nach der Anforderung an die Online-Search-Methode erfolgt, die die ID bereitgestellt hat. Der Dienst ermöglicht Batchanforderungen mit bis zu 20 Bezeichnern.

Verwendet die GET Search Polygon-API:https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon

function searchPolygon(aborter: Aborter, geometries: string[]): Promise<SearchPolygonResponse>

Parameter

aborter
Aborter

Erstellen Sie eine neue Aborter-instance mit Aborter.none oder Aborter.timeout(). Weitere Beispiele zum Abbrechen von Anforderungen erhalten Sie in den Dokumenten von Aborter.

geometries

string[]

Durch Trennzeichen getrennte Liste von Geometrie-UUIDs, die zuvor aus einer Online-Search-Anforderung abgerufen wurden.

Gibt zurück

Promise<SearchPolygonResponse>

Details zur geerbten Methode

newPipeline(Credential, INewPipelineOptions)

Eine statische Methode zum Erstellen eines neuen Pipelineobjekts mit bereitgestellten Anmeldeinformationen.

static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions): Pipeline

Parameter

credential
Credential

Beispielsweise SubscriptionKeyCredential, TokenCredential und MapControlCredential.

pipelineOptions
INewPipelineOptions

Gibt zurück

Pipeline

Ein neues Pipelineobjekt.

Geerbt vonMapsURL.newPipeline