ServiceOptions interface
Propriétés globales utilisées dans toutes les demandes de service atlas.
- Extends
Propriétés
auth |
Options d’authentification utilisées pour personnaliser la façon dont le contrôle de carte s’authentifie auprès des services Azure Maps. Si ces options d’authentification sont spécifiées, ServiceOptions.subscriptionKey ne doit pas l’être. Nous vous recommandons d’utiliser la fonction atlas.setAuthenticationOptions à la place. |
disable |
Désactiver la collecte de données de télémétrie Cette option peut être définie uniquement lors de l’initialisation de la carte. default : false (true pour le cloud Azure Government) |
domain | Domaine à utiliser lors de la demande de vignettes de carte et d’autres services Azure Maps.
Si le protocole n’est pas spécifié est supposé |
enable |
Activez la fonctionnalité d’accessibilité pour fournir la prise en charge du lecteur d’écran pour les utilisateurs qui ont des difficultés à visualiser l’application web. Cette propriété a la valeur true par défaut. |
enable |
Activez le secours vers le géocodeur de l’API REST pour détecter l’accessibilité des emplacements en cas d’échec de l’extraction de l’emplacement à partir de données vectorielles. La désactivation de cette option empêche la génération de demandes d’API de géocodage, mais peut entraîner un manque d’informations d’emplacement pour les lecteurs d’écran. default : true |
fade |
Contrôle la durée de l’animation fondue/fondue pour les collisions d’étiquettes, en millisecondes. Ce paramètre affecte toutes les couches de symboles. Ce paramètre n’affecte pas la durée des transitions de style d’exécution ou de la décoloration croisée des vignettes raster. |
local |
Définit une famille de polices CSS pour remplacer localement la génération de glyphes dans les plages « Idéogrammes unifiés CJK », « Hiragana », « Katakana » et « Syllabes hangûl ». Dans ces plages, les paramètres de police du style de la carte sont ignorés, à l’exception des mots clés de poids de police (light/regular/medium/bold). Définissez sur false pour activer les paramètres de police à partir du style de la carte pour ces plages de glyphes. L’objectif de cette option est d’éviter les demandes de serveur de glyphes gourmandes en bande passante. |
map |
La configuration de la carte définit l’ensemble des styles disponibles pour la carte. |
max |
Nombre maximal d’images (mosaïques raster, sprites, icônes) à charger en parallèle, ce qui affecte les performances dans les cartes à trame lourde. 16 par défaut. |
refresh |
Boolean qui spécifie si les vignettes vector et raster doivent être rechargées à l’expiration (en fonction de l’en-tête expire). Cela est utile pour les jeux de données qui se mettent à jour fréquemment. Lorsqu’elle est définie sur false, chaque vignette est chargée une fois, si nécessaire, et non rechargée à l’expiration. default : true |
session |
ID de session à passer avec les requêtes. Recommandez d’utiliser atlas.setSessionId à la place. |
style |
Version de l’API de style utilisée lors de la demande de styles et d’ensembles de styles |
style |
Version des définitions de style à demander lors de la demande de styles à partir de styleDefinitionsPath. |
subscription |
Clé d’abonnement client utilisée pour autoriser les demandes. Cette option peut uniquement être définie lors de l’initialisation de la carte. Recommandez d’utiliser la fonction atlas.setSubscriptionKey à la place |
transform |
Si la requête transformRequest est définie, elle sera appelée pour fournir des paramètres de requête personnalisés pour le chargement d’une vignette. |
validate |
True pour valider les styles avant son application. La validation prend beaucoup de temps (quelques centaines de ms) pour traiter les styles pendant le chargement initial. |
worker |
Nombre de web workers instanciés sur une page. Par défaut, il est défini sur la moitié du nombre de cœurs d’UC (limité à 6). |
Détails de la propriété
authOptions
Options d’authentification utilisées pour personnaliser la façon dont le contrôle de carte s’authentifie auprès des services Azure Maps. Si ces options d’authentification sont spécifiées, ServiceOptions.subscriptionKey ne doit pas l’être. Nous vous recommandons d’utiliser la fonction atlas.setAuthenticationOptions à la place.
authOptions?: AuthenticationOptions
Valeur de propriété
disableTelemetry
Désactiver la collecte de données de télémétrie Cette option peut être définie uniquement lors de l’initialisation de la carte. default : false (true pour le cloud Azure Government)
disableTelemetry?: boolean
Valeur de propriété
boolean
domain
Domaine à utiliser lors de la demande de vignettes de carte et d’autres services Azure Maps.
Si le protocole n’est pas spécifié est supposé https
.
Recommandez d’utiliser la fonction atlas.setDomain à la place.
domain?: string
Valeur de propriété
string
enableAccessibility
Activez la fonctionnalité d’accessibilité pour fournir la prise en charge du lecteur d’écran pour les utilisateurs qui ont des difficultés à visualiser l’application web. Cette propriété a la valeur true par défaut.
enableAccessibility?: boolean
Valeur de propriété
boolean
enableAccessibilityLocationFallback
Activez le secours vers le géocodeur de l’API REST pour détecter l’accessibilité des emplacements en cas d’échec de l’extraction de l’emplacement à partir de données vectorielles. La désactivation de cette option empêche la génération de demandes d’API de géocodage, mais peut entraîner un manque d’informations d’emplacement pour les lecteurs d’écran. default : true
enableAccessibilityLocationFallback?: boolean
Valeur de propriété
boolean
fadeDuration
Contrôle la durée de l’animation fondue/fondue pour les collisions d’étiquettes, en millisecondes. Ce paramètre affecte toutes les couches de symboles. Ce paramètre n’affecte pas la durée des transitions de style d’exécution ou de la décoloration croisée des vignettes raster.
fadeDuration?: number
Valeur de propriété
number
localIdeographFontFamily
Définit une famille de polices CSS pour remplacer localement la génération de glyphes dans les plages « Idéogrammes unifiés CJK », « Hiragana », « Katakana » et « Syllabes hangûl ». Dans ces plages, les paramètres de police du style de la carte sont ignorés, à l’exception des mots clés de poids de police (light/regular/medium/bold). Définissez sur false pour activer les paramètres de police à partir du style de la carte pour ces plages de glyphes. L’objectif de cette option est d’éviter les demandes de serveur de glyphes gourmandes en bande passante.
localIdeographFontFamily?: string
Valeur de propriété
string
mapConfiguration
La configuration de la carte définit l’ensemble des styles disponibles pour la carte.
mapConfiguration?: string | MapConfiguration
Valeur de propriété
string | MapConfiguration
maxParallelImageRequests
Nombre maximal d’images (mosaïques raster, sprites, icônes) à charger en parallèle, ce qui affecte les performances dans les cartes à trame lourde. 16 par défaut.
maxParallelImageRequests?: number
Valeur de propriété
number
refreshExpiredTiles
Boolean qui spécifie si les vignettes vector et raster doivent être rechargées à l’expiration (en fonction de l’en-tête expire). Cela est utile pour les jeux de données qui se mettent à jour fréquemment. Lorsqu’elle est définie sur false, chaque vignette est chargée une fois, si nécessaire, et non rechargée à l’expiration. default : true
refreshExpiredTiles?: boolean
Valeur de propriété
boolean
sessionId
ID de session à passer avec les requêtes. Recommandez d’utiliser atlas.setSessionId à la place.
sessionId?: string
Valeur de propriété
string
styleAPIVersion
Version de l’API de style utilisée lors de la demande de styles et d’ensembles de styles
styleAPIVersion?: string
Valeur de propriété
string
styleDefinitionsVersion
Version des définitions de style à demander lors de la demande de styles à partir de styleDefinitionsPath.
styleDefinitionsVersion?: string
Valeur de propriété
string
subscriptionKey
Clé d’abonnement client utilisée pour autoriser les demandes. Cette option peut uniquement être définie lors de l’initialisation de la carte. Recommandez d’utiliser la fonction atlas.setSubscriptionKey à la place
subscriptionKey?: string
Valeur de propriété
string
transformRequest
Si la requête transformRequest est définie, elle sera appelée pour fournir des paramètres de requête personnalisés pour le chargement d’une vignette.
transformRequest?: (url: string, resourceType: ResourceType) => RequestParameters
Valeur de propriété
(url: string, resourceType: ResourceType) => RequestParameters
validateStyle
True pour valider les styles avant son application. La validation prend beaucoup de temps (quelques centaines de ms) pour traiter les styles pendant le chargement initial.
validateStyle?: boolean
Valeur de propriété
boolean
workerCount
Nombre de web workers instanciés sur une page. Par défaut, il est défini sur la moitié du nombre de cœurs d’UC (limité à 6).
workerCount?: number
Valeur de propriété
number