SearchGetSearchPOICategoryOptionalParams interface

  • Referenz
Paket:
azure-maps-rest

Optionale Parameter.

Extends

RequestOptionsBase

Eigenschaften

brandSet

Eine durch Trennzeichen getrennte Liste von Markennamen, die verwendet werden können, um das Ergebnis auf bestimmte Marken zu beschränken. Die Reihenfolge der Elemente ist unerheblich. Wenn mehrere Marken bereitgestellt werden, werden nur Ergebnisse zurückgegeben, die (mindestens) zu einer der bereitgestellten Liste gehören. Marken, die ein "," in ihrem Namen enthalten, sollten in Anführungszeichen gesetzt werden. Anwendungsbeispiele:

brandSet=Foo

brandSet=Foo,Bar

brandSet="A,B,C Kommma",Bar
btmRight

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

Eine durch Trennzeichen getrennte Liste von Verbindertypen, die verwendet werden können, um das Ergebnis auf die Elektrische Fahrzeugstation zu beschränken, die bestimmte Verbindertypen unterstützt. Die Reihenfolge der Elemente ist unerheblich. Wenn mehrere Connectortypen bereitgestellt werden, werden nur Ergebnisse zurückgegeben, die (mindestens) zu einem der bereitgestellten Liste gehören. Folgende Connectortypen sind verfügbar:

  • StandardHouseholdCountrySpecific - Dies sind die Standard-Haushaltsconnectors für eine bestimmte Region. Sie sind alle ac einphasig und die Standardspannung und Standard-Stromerage. Siehe auch: Steckdosentypen & – Weltstandards.
  • IEC62196Type1 - Typ-1-Stecker, wie in der NORM IEC 62196-2 definiert. Auch Yazaki nach dem originalen Hersteller oder SAE J1772 nach dem Standard genannt, der es zuerst veröffentlicht hat. Wird meist in Kombination mit einer 120V-Einphaseninfrastruktur oder einer einphasigen Infrastruktur mit bis zu 240 V verwendet.
  • IEC62196Type1CCS - Typ-1-basierter Kombinationsstecker, wie im IEC 62196-3-Standard definiert. Der Stecker basiert auf dem Typ-1-Stecker – wie in der NORM IEC 62196-2 definiert – mit zwei zusätzlichen Gleichstromkontakten, um das Schnelle Laden von Gleichstrom zu ermöglichen.
  • IEC62196Type2CableAttached - Typ-2-Verbinder, wie in der IEC 62196-2-Norm definiert. Wird als Kabel und Stecker am Ladepunkt bereitgestellt.
  • IEC62196Type2Outlet - Typ-2-Verbinder, wie in der IEC 62196-2-Norm definiert. Wird als Steckdose im Ladepunkt bereitgestellt.
  • IEC62196Type2CCS - Typ-2-basierter Kombinationsstecker, wie im IEC 62196-3-Standard definiert. Der Stecker basiert auf dem Typ-2-Stecker – wie in der NORM IEC 62196-2 definiert – mit zwei zusätzlichen Gleichstromkontakten, um das Schnelle Laden von Gleichstrom zu ermöglichen.
  • IEC62196Type3 - Typ-3-Verbinder, wie in der IEC 62196-2-Norm definiert. Auch Scame nach dem originalen Hersteller genannt. Meist in Kombination mit bis zu 240 V einphasigen oder bis zu 420 V dreiphasigen Infrastruktur.
  • Chademo - CHAdeMO-Verbinder benannt nach einer Vereinigung, die von der Tokyo Electric Power Company und Industriepartnern gegründet wurde. Aus diesem Grund wird auch als TEPCO-Connector bezeichnet. Es unterstützt schnelle Dc-Ladevorgänge.
  • IEC60309AC1PhaseBlue - Industrial Blue-Verbinder ist eine in der IEC 60309-Norm definierte Verbinder. Es wird irgendwann als eine Kombination aus dem Standard, der Farbe und der Tatsache bezeichnet, dass es sich um einen einstufigen Verbinder handelt. Der Connector verfügt in der Regel über die Konfiguration "P+N+E, 6h".
  • IEC60309DCWhite - Industrial White-Verbinder ist ein gleichgestellter Stecker, der im IEC 60309-Standard definiert ist.
  • Tesla - Der Tesla-Connector ist der regional spezifische Tesla Supercharger Connector. Das heißt, es bezieht sich entweder auf den proprietären Connector von Tesla, manchmal auch als Tesla Port bezeichnet, der in Europa meist auf Nordamerika beschränkt ist, oder auf den modifizierten Typ 2 (DC über Typ 2).

Anwendungsbeispiele:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
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
openingHours

Öffnungszeiten für einen POI (Points of Interest). Die Verfügbarkeit der Öffnungszeiten hängt von den verfügbaren Daten ab. Mögliche Werte: "nextSevenDays"
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

brandSet

Eine durch Trennzeichen getrennte Liste von Markennamen, die verwendet werden können, um das Ergebnis auf bestimmte Marken zu beschränken. Die Reihenfolge der Elemente ist unerheblich. Wenn mehrere Marken bereitgestellt werden, werden nur Ergebnisse zurückgegeben, die (mindestens) zu einer der bereitgestellten Liste gehören. Marken, die ein "," in ihrem Namen enthalten, sollten in Anführungszeichen gesetzt werden. Anwendungsbeispiele:

brandSet=Foo

brandSet=Foo,Bar

brandSet="A,B,C Kommma",Bar

brandSet?: string[]

Eigenschaftswert

string[]

btmRight

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

btmRight?: string

Eigenschaftswert

string

connectorSet

Eine durch Trennzeichen getrennte Liste von Verbindertypen, die verwendet werden können, um das Ergebnis auf die Elektrische Fahrzeugstation zu beschränken, die bestimmte Verbindertypen unterstützt. Die Reihenfolge der Elemente ist unerheblich. Wenn mehrere Connectortypen bereitgestellt werden, werden nur Ergebnisse zurückgegeben, die (mindestens) zu einem der bereitgestellten Liste gehören. Folgende Connectortypen sind verfügbar:

  • StandardHouseholdCountrySpecific - Dies sind die Standard-Haushaltsconnectors für eine bestimmte Region. Sie sind alle ac einphasig und die Standardspannung und Standard-Stromerage. Siehe auch: Steckdosentypen & – Weltstandards.
  • IEC62196Type1 - Typ-1-Stecker, wie in der NORM IEC 62196-2 definiert. Auch Yazaki nach dem originalen Hersteller oder SAE J1772 nach dem Standard genannt, der es zuerst veröffentlicht hat. Wird meist in Kombination mit einer 120V-Einphaseninfrastruktur oder einer einphasigen Infrastruktur mit bis zu 240 V verwendet.
  • IEC62196Type1CCS - Typ-1-basierter Kombinationsstecker, wie im IEC 62196-3-Standard definiert. Der Stecker basiert auf dem Typ-1-Stecker – wie in der NORM IEC 62196-2 definiert – mit zwei zusätzlichen Gleichstromkontakten, um das Schnelle Laden von Gleichstrom zu ermöglichen.
  • IEC62196Type2CableAttached - Typ-2-Verbinder, wie in der IEC 62196-2-Norm definiert. Wird als Kabel und Stecker am Ladepunkt bereitgestellt.
  • IEC62196Type2Outlet - Typ-2-Verbinder, wie in der IEC 62196-2-Norm definiert. Wird als Steckdose im Ladepunkt bereitgestellt.
  • IEC62196Type2CCS - Typ-2-basierter Kombinationsstecker, wie im IEC 62196-3-Standard definiert. Der Stecker basiert auf dem Typ-2-Stecker – wie in der NORM IEC 62196-2 definiert – mit zwei zusätzlichen Gleichstromkontakten, um das Schnelle Laden von Gleichstrom zu ermöglichen.
  • IEC62196Type3 - Typ-3-Verbinder, wie in der IEC 62196-2-Norm definiert. Auch Scame nach dem originalen Hersteller genannt. Meist in Kombination mit bis zu 240 V einphasigen oder bis zu 420 V dreiphasigen Infrastruktur.
  • Chademo - CHAdeMO-Verbinder benannt nach einer Vereinigung, die von der Tokyo Electric Power Company und Industriepartnern gegründet wurde. Aus diesem Grund wird auch als TEPCO-Connector bezeichnet. Es unterstützt schnelle Dc-Ladevorgänge.
  • IEC60309AC1PhaseBlue - Industrial Blue-Verbinder ist eine in der IEC 60309-Norm definierte Verbinder. Es wird irgendwann als eine Kombination aus dem Standard, der Farbe und der Tatsache bezeichnet, dass es sich um einen einstufigen Verbinder handelt. Der Connector verfügt in der Regel über die Konfiguration "P+N+E, 6h".
  • IEC60309DCWhite - Industrial White-Verbinder ist ein gleichgestellter Stecker, der im IEC 60309-Standard definiert ist.
  • Tesla - Der Tesla-Connector ist der regional spezifische Tesla Supercharger Connector. Das heißt, es bezieht sich entweder auf den proprietären Connector von Tesla, manchmal auch als Tesla Port bezeichnet, der in Europa meist auf Nordamerika beschränkt ist, oder auf den modifizierten Typ 2 (DC über Typ 2).

Anwendungsbeispiele:

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

connectorSet?: ConnectorSet[]

Eigenschaftswert

ConnectorSet[]

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

openingHours

Öffnungszeiten für einen POI (Points of Interest). Die Verfügbarkeit der Öffnungszeiten hängt von den verfügbaren Daten ab. Mögliche Werte: "nextSevenDays"

openingHours?: OpeningHours

Eigenschaftswert

OpeningHours

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