Share via

SearchGetSearchNearbyOptionalParams interface

  • Référence
Paquet:
azure-maps-rest

Paramètres facultatifs.

Extends

RequestOptionsBase

Propriétés

brandSet

Liste séparée par des virgules de noms de marques qui pourraient être utilisés pour restreindre le résultat à des marques spécifiques. L’ordre des éléments importe peu. Lorsque plusieurs marques sont fournies, seuls les résultats qui appartiennent à (au moins) une des listes fournies sont retournés. Les marques qui contiennent un « , » dans leur nom doivent être placées entre guillemets. Exemples d'utilisation :

brandSet=Foo

brandSet=Foo,Bar

brandSet="A,B,C Virgule »,Bar
connectorSet

Liste séparée par des virgules de types de connecteurs qui peuvent être utilisés pour limiter le résultat à Electric Vehicle Station prenant en charge des types de connecteurs spécifiques. L’ordre des éléments importe peu. Lorsque plusieurs types de connecteurs sont fournis, seuls les résultats qui appartiennent à (au moins) l’une de la liste fournie sont retournés. Les types de connecteurs disponibles sont les suivants :

  • StandardHouseholdCountrySpecific - Il s’agit des connecteurs domestiques standard pour une région donnée. Ils sont tous ca monophasé et la tension standard et l’ampérage standard. Voir aussi : Types de sockets plug-& - Normes mondiales.
  • IEC62196Type1 - Connecteur de type 1 tel que défini dans la norme IEC 62196-2. Aussi appelé Yazaki d’après le fabricant d’origine ou SAE J1772 après la norme qui l’a publié en premier. Principalement utilisé en combinaison avec une infrastructure monophase 120V ou monophase 240V maximum.
  • IEC62196Type1CCS - Connecteur combo de type 1 tel que défini dans la norme IEC 62196-3. Le connecteur est basé sur le connecteur de type 1 , tel que défini dans la norme IEC 62196-2, avec deux contacts de courant continu (DC) supplémentaires pour permettre la charge rapide DC.
  • IEC62196Type2CableAttached - Connecteur de type 2 tel que défini dans la norme IEC 62196-2. Fourni sous forme de câble et de prise attaché au point de charge.
  • IEC62196Type2Outlet - Connecteur de type 2 tel que défini dans la norme IEC 62196-2. Fourni en tant que socket défini dans le point de charge.
  • IEC62196Type2CCS - Connecteur combiné de type 2 tel que défini dans la norme IEC 62196-3. Le connecteur est basé sur le connecteur de type 2 , tel que défini dans la norme IEC 62196-2, avec deux contacts de courant continu (DC) supplémentaires pour permettre la charge rapide dc.
  • IEC62196Type3 - Connecteur de type 3 tel que défini dans la norme IEC 62196-2. Également appelé Scame après le fabricant d’origine. Principalement utilisé en combinaison avec une infrastructure monophase jusqu’à 240 V ou jusqu’à 420 V en trois phases.
  • Chademo - Connecteur CHAdeMO nommé d’après une association formée par la Tokyo Electric Power Company et des partenaires industriels. Pour cette raison, est également connu sous le nom de connecteur de TEPCO. Il prend en charge la charge dc rapide.
  • IEC60309AC1PhaseBlue - Le connecteur Industrial Blue est un connecteur défini dans la norme IEC 60309. Il est parfois appelé par une combinaison de la norme, de la couleur et du fait qu’il s’agit d’un connecteur à phase unique. Le connecteur a généralement la configuration « P+N+E, 6h ».
  • IEC60309DCWhite - Le connecteur Industrial White est un connecteur DC défini dans la norme IEC 60309.
  • Tesla - Le connecteur Tesla est le connecteur Tesla Supercharger spécifique à la région. C’est-à-dire qu’il fait référence au connecteur propriétaire de Tesla, parfois appelé Tesla Port principalement limité à Amérique du Nord ou au type 2 modifié (DC sur type 2) en Europe.

Exemples d'utilisation :

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached
countrySet

Chaîne séparée par des virgules des codes de pays, par exemple FR, ES. Cela limitera la recherche aux pays spécifiés.
extendedPostalCodesFor

Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats. Les index disponibles sont les suivants :

Addr = Plages d’adresses

Géo = Zones géographiques

PAD = Adresses de point

POI = Points d’intérêt

Str = Rues

XStr = Rues croisées (intersections)

La valeur doit être une liste séparée par des virgules de types d’index (dans n’importe quel ordre) ou Aucun pour aucun index.

Par défaut, les codes postaux étendus sont inclus pour tous les index à l’exception de Geo. Les listes de codes postaux étendues pour les zones géographiques peuvent être assez longues et doivent donc être demandées explicitement si nécessaire.

Exemples d'utilisation :

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Le code postal étendu est retourné en tant que propriété extendedPostalCode d’une adresse. La disponibilité dépend de la région.
language

Langue dans laquelle les résultats de la recherche doivent être retournés. Doit être l’une des balises de langue IETF prises en charge, ne respectant pas la casse. Lorsque les données dans la langue spécifiée ne sont pas disponibles pour un champ spécifique, la langue par défaut est utilisée. Pour plus d’informations, consultez Langues prises en charge .
limit

Nombre maximal de réponses qui seront retournées. Valeur par défaut : 10, minimum : 1 et maximum : 100
ofs

Décalage de départ des résultats retournés. La valeur maximale est 1900.
radius

Rayon en mètres à pour que les résultats soient limités à la zone définie, Valeur minimale est 1, Valeur maximale est 50 000.
view

Le paramètre View spécifie l’ensemble de contenu géopolitiquement contesté qui est retourné via Azure Maps services, y compris les bordures et les étiquettes affichées sur la carte. Le paramètre View (également appelé « paramètre de région utilisateur ») affiche les cartes correctes pour ce pays/région. Par défaut, le paramètre View est défini sur « Unified », même si vous ne l’avez pas défini dans la requête. Il vous incombe de déterminer l'emplacement de vos utilisateurs, puis de définir correctement le paramètre Affichage correspondant à cet emplacement. Vous avez aussi la possibilité de définir le paramètre d’affichage « Vue=Auto », qui retourne les données cartographiques correspondant à l’adresse IP de la requête. Le paramètre View dans Azure Maps doit être utilisé conformément aux lois applicables, y compris celles relatives au mappage, du pays où les cartes, images et autres données et le contenu tiers auquel vous êtes autorisé à accéder via Azure Maps est mis à disposition. Exemple : view=IN. Reportez-vous à Affichages pris en charge pour plus d’informations et pour afficher les vues disponibles.

Propriétés héritées

abortSignal

Signal qui peut être utilisé pour annuler les demandes.
customHeaders

{object} [customHeaders] L’utilisateur a défini des en-têtes de requête personnalisés qui seront appliqués avant l’envoi de la demande.
onDownloadProgress

Rappel qui se déclenche lors de la progression du téléchargement.
onUploadProgress

Rappel qui se déclenche lors de la progression du chargement.
timeout

Nombre de millisecondes qu’une demande peut prendre avant de se terminer automatiquement.

Détails de la propriété

brandSet

Liste séparée par des virgules de noms de marques qui pourraient être utilisés pour restreindre le résultat à des marques spécifiques. L’ordre des éléments importe peu. Lorsque plusieurs marques sont fournies, seuls les résultats qui appartiennent à (au moins) une des listes fournies sont retournés. Les marques qui contiennent un « , » dans leur nom doivent être placées entre guillemets. Exemples d'utilisation :

brandSet=Foo

brandSet=Foo,Bar

brandSet="A,B,C Virgule »,Bar

brandSet?: string[]

Valeur de propriété

string[]

connectorSet

Liste séparée par des virgules de types de connecteurs qui peuvent être utilisés pour limiter le résultat à Electric Vehicle Station prenant en charge des types de connecteurs spécifiques. L’ordre des éléments importe peu. Lorsque plusieurs types de connecteurs sont fournis, seuls les résultats qui appartiennent à (au moins) l’une de la liste fournie sont retournés. Les types de connecteurs disponibles sont les suivants :

  • StandardHouseholdCountrySpecific - Il s’agit des connecteurs domestiques standard pour une région donnée. Ils sont tous ca monophasé et la tension standard et l’ampérage standard. Voir aussi : Types de sockets plug-& - Normes mondiales.
  • IEC62196Type1 - Connecteur de type 1 tel que défini dans la norme IEC 62196-2. Aussi appelé Yazaki d’après le fabricant d’origine ou SAE J1772 après la norme qui l’a publié en premier. Principalement utilisé en combinaison avec une infrastructure monophase 120V ou monophase 240V maximum.
  • IEC62196Type1CCS - Connecteur combo de type 1 tel que défini dans la norme IEC 62196-3. Le connecteur est basé sur le connecteur de type 1 , tel que défini dans la norme IEC 62196-2, avec deux contacts de courant continu (DC) supplémentaires pour permettre la charge rapide DC.
  • IEC62196Type2CableAttached - Connecteur de type 2 tel que défini dans la norme IEC 62196-2. Fourni sous forme de câble et de prise attaché au point de charge.
  • IEC62196Type2Outlet - Connecteur de type 2 tel que défini dans la norme IEC 62196-2. Fourni en tant que socket défini dans le point de charge.
  • IEC62196Type2CCS - Connecteur combiné de type 2 tel que défini dans la norme IEC 62196-3. Le connecteur est basé sur le connecteur de type 2 , tel que défini dans la norme IEC 62196-2, avec deux contacts de courant continu (DC) supplémentaires pour permettre la charge rapide dc.
  • IEC62196Type3 - Connecteur de type 3 tel que défini dans la norme IEC 62196-2. Également appelé Scame après le fabricant d’origine. Principalement utilisé en combinaison avec une infrastructure monophase jusqu’à 240 V ou jusqu’à 420 V en trois phases.
  • Chademo - Connecteur CHAdeMO nommé d’après une association formée par la Tokyo Electric Power Company et des partenaires industriels. Pour cette raison, est également connu sous le nom de connecteur de TEPCO. Il prend en charge la charge dc rapide.
  • IEC60309AC1PhaseBlue - Le connecteur Industrial Blue est un connecteur défini dans la norme IEC 60309. Il est parfois appelé par une combinaison de la norme, de la couleur et du fait qu’il s’agit d’un connecteur à phase unique. Le connecteur a généralement la configuration « P+N+E, 6h ».
  • IEC60309DCWhite - Le connecteur Industrial White est un connecteur DC défini dans la norme IEC 60309.
  • Tesla - Le connecteur Tesla est le connecteur Tesla Supercharger spécifique à la région. C’est-à-dire qu’il fait référence au connecteur propriétaire de Tesla, parfois appelé Tesla Port principalement limité à Amérique du Nord ou au type 2 modifié (DC sur type 2) en Europe.

Exemples d'utilisation :

connectorSet=IEC62196Type2CableAttached connectorSet=IEC62196Type2Outlet,IEC62196Type2CableAttached

connectorSet?: ConnectorSet[]

Valeur de propriété

ConnectorSet[]

countrySet

Chaîne séparée par des virgules des codes de pays, par exemple FR, ES. Cela limitera la recherche aux pays spécifiés.

countrySet?: string[]

Valeur de propriété

string[]

extendedPostalCodesFor

Index pour lesquels les codes postaux étendus doivent être inclus dans les résultats. Les index disponibles sont les suivants :

Addr = Plages d’adresses

Géo = Zones géographiques

PAD = Adresses de point

POI = Points d’intérêt

Str = Rues

XStr = Rues croisées (intersections)

La valeur doit être une liste séparée par des virgules de types d’index (dans n’importe quel ordre) ou Aucun pour aucun index.

Par défaut, les codes postaux étendus sont inclus pour tous les index à l’exception de Geo. Les listes de codes postaux étendues pour les zones géographiques peuvent être assez longues et doivent donc être demandées explicitement si nécessaire.

Exemples d'utilisation :

extendedPostalCodesFor=POI

extendedPostalCodesFor=PAD,Addr,POI

extendedPostalCodesFor=None

Le code postal étendu est retourné en tant que propriété extendedPostalCode d’une adresse. La disponibilité dépend de la région.

extendedPostalCodesFor?: string

Valeur de propriété

string

language

Langue dans laquelle les résultats de la recherche doivent être retournés. Doit être l’une des balises de langue IETF prises en charge, ne respectant pas la casse. Lorsque les données dans la langue spécifiée ne sont pas disponibles pour un champ spécifique, la langue par défaut est utilisée. Pour plus d’informations, consultez Langues prises en charge .

language?: string

Valeur de propriété

string

limit

Nombre maximal de réponses qui seront retournées. Valeur par défaut : 10, minimum : 1 et maximum : 100

limit?: number

Valeur de propriété

number

ofs

Décalage de départ des résultats retournés. La valeur maximale est 1900.

ofs?: number

Valeur de propriété

number

radius

Rayon en mètres à pour que les résultats soient limités à la zone définie, Valeur minimale est 1, Valeur maximale est 50 000.

radius?: number

Valeur de propriété

number

view

Le paramètre View spécifie l’ensemble de contenu géopolitiquement contesté qui est retourné via Azure Maps services, y compris les bordures et les étiquettes affichées sur la carte. Le paramètre View (également appelé « paramètre de région utilisateur ») affiche les cartes correctes pour ce pays/région. Par défaut, le paramètre View est défini sur « Unified », même si vous ne l’avez pas défini dans la requête. Il vous incombe de déterminer l'emplacement de vos utilisateurs, puis de définir correctement le paramètre Affichage correspondant à cet emplacement. Vous avez aussi la possibilité de définir le paramètre d’affichage « Vue=Auto », qui retourne les données cartographiques correspondant à l’adresse IP de la requête. Le paramètre View dans Azure Maps doit être utilisé conformément aux lois applicables, y compris celles relatives au mappage, du pays où les cartes, images et autres données et le contenu tiers auquel vous êtes autorisé à accéder via Azure Maps est mis à disposition. Exemple : view=IN. Reportez-vous à Affichages pris en charge pour plus d’informations et pour afficher les vues disponibles.

view?: string

Valeur de propriété

string

Détails de la propriété héritée

abortSignal

Signal qui peut être utilisé pour annuler les demandes.

abortSignal?: AbortSignalLike

Valeur de propriété

AbortSignalLike

Hérité de RequestOptionsBase.abortSignal

customHeaders

{object} [customHeaders] L’utilisateur a défini des en-têtes de requête personnalisés qui seront appliqués avant l’envoi de la demande.

customHeaders?: [key: string]: string

Valeur de propriété

[key: string]: string

Hérité de RequestOptionsBase.customHeaders

onDownloadProgress

Rappel qui se déclenche lors de la progression du téléchargement.

onDownloadProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

(progress: TransferProgressEvent) => void

Hérité de RequestOptionsBase.onDownloadProgress

onUploadProgress

Rappel qui se déclenche lors de la progression du chargement.

onUploadProgress?: (progress: TransferProgressEvent) => void

Valeur de propriété

(progress: TransferProgressEvent) => void

Hérité de RequestOptionsBase.onUploadProgress

timeout

Nombre de millisecondes qu’une demande peut prendre avant de se terminer automatiquement.

timeout?: number

Valeur de propriété

number

Hérité de RequestOptionsBase.timeout