SearchGetSearchAddressOptionalParams interface

Paket:

azure-maps-rest

Optionale Parameter.

Extends

RequestOptionsBase

Eigenschaften

btmRight	Rechts unten des Begrenzungsrahmens. Z.B. 37.553,-122.453
countrySet	Durch Trennzeichen getrennte Zeichenfolge von Ländercodes, z. B. FR, ES. Dadurch wird die Suche auf die angegebenen Länder beschränkt.
extendedPostalCodesFor	Indizes, für die erweiterte Postleitzahlen in die Ergebnisse aufgenommen werden sollen. Verfügbare Indizes sind: Addr = Adressbereiche Geo = Geografien PAD = Punktadressen POI = Points of Interest Str = Straßen XStr = Cross Street (Kreuzungen) Der Wert sollte eine durch Trennzeichen getrennte Liste von Indextypen (in beliebiger Reihenfolge) oder Keine für keine Indizes sein. Standardmäßig sind erweiterte Postleitzahlen für alle Indizes mit Ausnahme von Geo enthalten. Erweiterte Postleitzahlenlisten für geografische Regionen können recht lang sein, sodass sie bei Bedarf explizit angefordert werden müssen. Anwendungsbeispiele: extendedPostalCodesFor=POI extendedPostalCodesFor=PAD,Addr,POI extendedPostalCodesFor=None Erweiterte Postleitzahl wird als extendedPostalCode-Eigenschaft einer Adresse zurückgegeben. Die Verfügbarkeit ist regionsabhängig.
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 .
lat	Breitengrad, in dem die Ergebnisse verzerrt sein sollen. Beispiel: 37.337
limit	Maximale Anzahl von Antworten, die zurückgegeben werden. Standard: 10, Minimum: 1 und Maximum: 100
lon	Längengrad, bei dem die Ergebnisse verzerrt sein sollen. Beispiel: -121,89
ofs	Startoffset der zurückgegebenen Ergebnisse innerhalb des vollständigen Resultsets.
radius	Der Radius in Metern bis, damit die Ergebnisse auf den definierten Bereich beschränkt werden.
topLeft	Obere linke Position des Begrenzungsrahmens. Z.B. 37.553,-122.453
typeahead	Boolesch. Wenn das Flag typeahead festgelegt ist, wird die Abfrage als teilbare Eingabe interpretiert, und die Suche wechselt in den Vorhersagemodus.
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 Anforderungsheader, die angewendet werden, bevor die Anforderung gesendet wird.
onDownloadProgress	Rückruf, der beim Downloadfortschritt ausgelöst wird.
onUploadProgress	Rückruf, der beim Uploadvorgang ausgelöst wird.
timeout	Die Anzahl von Millisekunden, die eine Anforderung dauern kann, bevor sie automatisch beendet wird.

Details zur Eigenschaft

btmRight

Rechts unten des Begrenzungsrahmens. Z.B. 37.553,-122.453

btmRight?: string

Eigenschaftswert

string

countrySet

Durch Trennzeichen getrennte Zeichenfolge von Ländercodes, z. B. FR, ES. Dadurch wird die Suche auf die angegebenen Länder beschränkt.

countrySet?: string[]

Eigenschaftswert

string[]

extendedPostalCodesFor

Indizes, für die erweiterte Postleitzahlen in die Ergebnisse aufgenommen werden sollen. Verfügbare Indizes sind:

Addr = Adressbereiche

Geo = Geografien

PAD = Punktadressen

POI = Points of Interest

Str = Straßen

XStr = Cross Street (Kreuzungen)

Der Wert sollte eine durch Trennzeichen getrennte Liste von Indextypen (in beliebiger Reihenfolge) oder Keine für keine Indizes sein.

Standardmäßig sind erweiterte Postleitzahlen für alle Indizes mit Ausnahme von Geo enthalten. Erweiterte Postleitzahlenlisten für geografische Regionen können recht lang sein, sodass sie bei Bedarf explizit angefordert werden müssen.

Anwendungsbeispiele:

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Erweiterte Postleitzahl wird als extendedPostalCode-Eigenschaft einer Adresse zurückgegeben. Die Verfügbarkeit ist regionsabhängig.

extendedPostalCodesFor?: string

Eigenschaftswert

string

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

lat

Breitengrad, in dem die Ergebnisse verzerrt sein sollen. Beispiel: 37.337

lat?: number

Eigenschaftswert

number

limit

Maximale Anzahl von Antworten, die zurückgegeben werden. Standard: 10, Minimum: 1 und Maximum: 100

limit?: number

Eigenschaftswert

number

lon

Längengrad, bei dem die Ergebnisse verzerrt sein sollen. Beispiel: -121,89

lon?: number

Eigenschaftswert

number

ofs

Startoffset der zurückgegebenen Ergebnisse innerhalb des vollständigen Resultsets.

ofs?: number

Eigenschaftswert

number

radius

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

radius?: number

Eigenschaftswert

number

topLeft

Obere linke Position des Begrenzungsrahmens. Z.B. 37.553,-122.453

topLeft?: string

Eigenschaftswert

string

typeahead

Boolesch. Wenn das Flag typeahead festgelegt ist, wird die Abfrage als teilbare Eingabe interpretiert, und die Suche wechselt in den Vorhersagemodus.

typeahead?: boolean

Eigenschaftswert

boolean

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 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 Uploadvorgang 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