SearchGetSearchAddressReverseOptionalParams interface

Paket:

azure-maps-rest

Optionale Parameter.

Extends

RequestOptionsBase

Eigenschaften

allowFreeformNewline	Format der Zeilenneulinien in der formatierten Adresse. Wenn true, enthält die Adresse neue Zeilen. Wenn false, werden neue Linien in Kommas konvertiert.
entityType	Schränkt die Suche nach angegebenen geografischen Entitätstypen ein, z. B. nur Gemeinde zurückgeben. Die resultierende Antwort enthält die Geografie-ID sowie den passenden Entitätstyp. Wenn Sie mehrere Entitäten als kommagetrennte Liste angeben, gibt der Endpunkt die "kleinste verfügbare Entität" zurück. Die zurückgegebene Geometrie-ID kann verwendet werden, um die Geometrie dieser Geografie über die Get Search Polygon-API abzurufen. Mögliche Werte: "Country", "CountrySubdivision", "CountrySecondarySubdivision", "CountryTertiarySubdivision", "Municipality", "MunicipalitySubdivision", "Neighbourhood", "PostalCodeArea"
heading	Die Richtungsrichtung des Fahrzeugs in Grad für die Fahrt entlang eines Streckenabschnitts. 0 ist Norden, 90 ist Osten usw. Die Werte liegen zwischen -360 und 360. Die Genauigkeit kann bis zu einer Dezimalstelle umfassen.
language	Sprache, in der Suchergebnisse zurückgegeben werden sollen. Sollte eines der unterstützten IETF-Sprachtags sein, wobei die Groß-/Kleinschreibung nicht beachtet wird. Wenn Daten in der angegebenen Sprache für ein bestimmtes Feld nicht verfügbar sind, wird die Standardsprache verwendet. Weitere Informationen finden Sie unter Unterstützte Sprachen .
number	Wenn eine Zahl zusammen mit der Anforderung eingesendet wird, kann die Antwort die Straßenseite (links/rechts) und eine Versatzposition für diese Zahl enthalten.
radius	Der Radius in Metern bis, damit die Ergebnisse auf den definierten Bereich beschränkt werden.
returnMatchType	Fügen Sie Informationen zum Typ der Übereinstimmung ein, die der Geocoder in der Antwort erreicht hat.
returnRoadUse	Boolesch. So aktivieren Sie die Rückgabe des Straßennutzungsarrays für Reversegeocodes auf Straßenebene
returnSpeedLimit	Boolesch. So aktivieren Sie die Rückgabe des bereitgestellten Speedlimits
roadUse	Einschränken von Reversegeocodes auf eine bestimmte Art von Straßennutzung. Das Straßennutzungsarray für Reversegeocodes kann eine oder mehrere von LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet sein.
view	Der View-Parameter gibt an, welcher Satz geopolitisch umstrittener Inhalte über Azure Maps-Dienste zurückgegeben wird, einschließlich Rahmen und Bezeichnungen, die auf der Karte angezeigt werden. Der View-Parameter (auch als "Benutzerregionsparameter" bezeichnet) zeigt die richtigen Karten für dieses Land/diese Region an. Standardmäßig ist der View-Parameter auf "Unified" festgelegt, auch wenn Sie ihn in der Anforderung nicht definiert haben. Es liegt in Ihrer Verantwortung, den Standort Ihrer Benutzer zu bestimmen und dann den „View“-Parameter für diesen Standort entsprechend festzulegen. Alternativ haben Sie die Möglichkeit, „View=Auto“ festzulegen, wodurch die Kartendaten basierend auf der IP-Adresse der Anforderung zurückgibt. Der Parameter View in Azure Maps muss in Übereinstimmung mit den geltenden Gesetzen des Landes verwendet werden, in dem Karten, Bilder und andere Daten sowie Inhalte dritter Parteien, auf die Sie über Azure Maps zugreifen dürfen, verfügbar gemacht werden. Beispiel: view=IN. Weitere Informationen und die verfügbaren Ansichten finden Sie unter Unterstützte Ansichten .

Geerbte Eigenschaften

abortSignal	Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.
customHeaders	{object} [customHeaders] Benutzerdefinierte benutzerdefinierte Anforderungsheader, die angewendet werden, bevor die Anforderung gesendet wird.
onDownloadProgress	Rückruf, der beim Downloadfortschritt ausgelöst wird.
onUploadProgress	Rückruf, der beim Hochladen des Fortschritts ausgelöst wird.
timeout	Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird.

Details zur Eigenschaft

allowFreeformNewline

Format der Zeilenneulinien in der formatierten Adresse. Wenn true, enthält die Adresse neue Zeilen. Wenn false, werden neue Linien in Kommas konvertiert.

allowFreeformNewline?: boolean

Eigenschaftswert

boolean

entityType

Schränkt die Suche nach angegebenen geografischen Entitätstypen ein, z. B. nur Gemeinde zurückgeben. Die resultierende Antwort enthält die Geografie-ID sowie den passenden Entitätstyp. Wenn Sie mehrere Entitäten als kommagetrennte Liste angeben, gibt der Endpunkt die "kleinste verfügbare Entität" zurück. Die zurückgegebene Geometrie-ID kann verwendet werden, um die Geometrie dieser Geografie über die Get Search Polygon-API abzurufen. Mögliche Werte: "Country", "CountrySubdivision", "CountrySecondarySubdivision", "CountryTertiarySubdivision", "Municipality", "MunicipalitySubdivision", "Neighbourhood", "PostalCodeArea"

entityType?: EntityType

Eigenschaftswert

EntityType

heading

Die Richtungsrichtung des Fahrzeugs in Grad für die Fahrt entlang eines Streckenabschnitts. 0 ist Norden, 90 ist Osten usw. Die Werte liegen zwischen -360 und 360. Die Genauigkeit kann bis zu einer Dezimalstelle umfassen.

heading?: number

Eigenschaftswert

number

language

Sprache, in der Suchergebnisse zurückgegeben werden sollen. Sollte eines der unterstützten IETF-Sprachtags sein, wobei die Groß-/Kleinschreibung nicht beachtet wird. Wenn Daten in der angegebenen Sprache für ein bestimmtes Feld nicht verfügbar sind, wird die Standardsprache verwendet. Weitere Informationen finden Sie unter Unterstützte Sprachen .

language?: string

Eigenschaftswert

string

number

Wenn eine Zahl zusammen mit der Anforderung eingesendet wird, kann die Antwort die Straßenseite (links/rechts) und eine Versatzposition für diese Zahl enthalten.

number?: string

Eigenschaftswert

string

radius

Der Radius in Metern bis, damit die Ergebnisse auf den definierten Bereich beschränkt werden.

radius?: number

Eigenschaftswert

number

returnMatchType

Fügen Sie Informationen zum Typ der Übereinstimmung ein, die der Geocoder in der Antwort erreicht hat.

returnMatchType?: boolean

Eigenschaftswert

boolean

returnRoadUse

Boolesch. So aktivieren Sie die Rückgabe des Straßennutzungsarrays für Reversegeocodes auf Straßenebene

returnRoadUse?: boolean

Eigenschaftswert

boolean

returnSpeedLimit

Boolesch. So aktivieren Sie die Rückgabe des bereitgestellten Speedlimits

returnSpeedLimit?: boolean

Eigenschaftswert

boolean

roadUse

Einschränken von Reversegeocodes auf eine bestimmte Art von Straßennutzung. Das Straßennutzungsarray für Reversegeocodes kann eine oder mehrere von LimitedAccess, Arterial, Terminal, Ramp, Rotary, LocalStreet sein.

roadUse?: string

Eigenschaftswert

string

view

Der View-Parameter gibt an, welcher Satz geopolitisch umstrittener Inhalte über Azure Maps-Dienste zurückgegeben wird, einschließlich Rahmen und Bezeichnungen, die auf der Karte angezeigt werden. Der View-Parameter (auch als "Benutzerregionsparameter" bezeichnet) zeigt die richtigen Karten für dieses Land/diese Region an. Standardmäßig ist der View-Parameter auf "Unified" festgelegt, auch wenn Sie ihn in der Anforderung nicht definiert haben. Es liegt in Ihrer Verantwortung, den Standort Ihrer Benutzer zu bestimmen und dann den „View“-Parameter für diesen Standort entsprechend festzulegen. Alternativ haben Sie die Möglichkeit, „View=Auto“ festzulegen, wodurch die Kartendaten basierend auf der IP-Adresse der Anforderung zurückgibt. Der Parameter View in Azure Maps muss in Übereinstimmung mit den geltenden Gesetzen des Landes verwendet werden, in dem Karten, Bilder und andere Daten sowie Inhalte dritter Parteien, auf die Sie über Azure Maps zugreifen dürfen, verfügbar gemacht werden. Beispiel: view=IN. Weitere Informationen und die verfügbaren Ansichten finden Sie unter Unterstützte Ansichten .

view?: string

Eigenschaftswert

string

Geerbte Eigenschaftsdetails

abortSignal

Das Signal, das zum Abbrechen von Anforderungen verwendet werden kann.

abortSignal?: AbortSignalLike

Eigenschaftswert

AbortSignalLike

Geerbt von RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] Benutzerdefinierte benutzerdefinierte Anforderungsheader, die angewendet werden, bevor die Anforderung gesendet wird.

customHeaders?: [key: string]: string

Eigenschaftswert

[key: string]: string

Geerbt von RequestOptionsBase.customHeaders

onDownloadProgress

Rückruf, der beim Downloadfortschritt ausgelöst wird.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

Geerbt von RequestOptionsBase.onDownloadProgress

onUploadProgress

Rückruf, der beim Hochladen des Fortschritts ausgelöst wird.

onUploadProgress?: (progress: TransferProgressEvent) => void

Eigenschaftswert

(progress: TransferProgressEvent) => void

Geerbt von RequestOptionsBase.onUploadProgress

timeout

Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird.

timeout?: number

Eigenschaftswert

number

Geerbt von RequestOptionsBase.timeout