atlas module

Classes

EventManager

Gestionnaire des événements du contrôle de carte. Exposé par le biais de la propriété d’événements de l’atlas. Classe Map. Impossible d’instancier l’utilisateur.

HtmlMarker

Cette classe encapsule un élément HTML qui peut être affiché sur la carte.

Map

Contrôle d’une carte web visuelle et interactive.

Pixel

Représente une coordonnée ou un décalage de pixel. Étend un tableau de [x, y].

Popup

Fenêtre d’informations ancrée à une position spécifiée sur une carte.

PopupTemplate

Modèle de disposition pour une fenêtre contextuelle.

Shape

Classe d’assistance qui encapsule une géométrie ou une fonctionnalité et facilite la mise à jour et la maintenance.

Interfaces

AggregateExpression

Une expression d’agrégation définit un calcul traité sur un jeu de données. Schéma : [operator : string, initialValue ?: boolean | number, mapExpression : Expression] opérateur : fonction d’expression qui est ensuite appliquée à toutes les valeurs calculées par l'mapExpression pour chaque point du cluster. Opérateurs pris en charge : o Pour les nombres : +, *, max, min o Pour les booléens : all, any initialValue : Facultatif, valeur initiale dans laquelle la première valeur calculée est agrégée. mapExpression : expression appliquée à chaque point du jeu de données.

AnimationOptions

Options d’animation des modifications apportées à la caméra du contrôle de carte.

AuthenticationManager

Gestionnaire de l’authentification du contrôle de carte. Exposé par le biais de la propriété d’authentification de l’atlas. Classe Map. Impossible d’instancier l’utilisateur.

AuthenticationOptions

Options de spécification de la façon dont le contrôle de carte doit s’authentifier auprès des services Azure Maps.

BubbleLayerOptions

Options utilisées lors du rendu d’objets Point dans un BubbleLayer.

CameraBoundsOptions

Options de définition des limites de la caméra du contrôle de carte.

CameraOptions

Options de définition de l’appareil photo du contrôle de carte.

ClusteredProperties

Propriétés qui existent pour ClusteredProperties

CompassControlOptions

Options d’un objet CompassControl.

Control

Interface permettant de définir un contrôle de la carte.

ControlManager

Gestionnaire des contrôles du contrôle de carte. Exposé par le biais de la propriété des contrôles de l’atlas. Classe Map. Impossible d’instancier l’utilisateur.

ControlOptions

Options d’ajout d’un contrôle à la carte.

DataSourceOptions

Source de données pour la gestion des données de forme qui seront affichées sur la carte. Une source de données doit être ajoutée à une couche avant d’être visible sur la carte. Options d’un DataSourceOptions.

ElevationTileSourceOptions
FullscreenControlOptions

Options d’un objet FullscreenControl.

HeatMapLayerOptions

Options utilisées lors du rendu d’objets Point dans un HeatMapLayer.

HtmlMarkerEvents
HtmlMarkerManager

Gestionnaire des marqueurs HTML du contrôle de carte. Exposé par la propriété marqueurs de l’atlas. Classe Map. Impossible d’instancier l’utilisateur.

HtmlMarkerOptions

Options de rendu d’un objet HtmlMarker

HyperLinkFormatOptions

Option Format pour les chaînes de lien hypertexte.

IconOptions

Options utilisées pour personnaliser les icônes dans un SymbolLayer

ImageLayerOptions

Options utilisées lors du rendu d’objets Point dans un ImageLayer.

ImageSpriteManager

Gestionnaire du sprite d’image du contrôle de carte. Exposé par le biais de la propriété imageSprite de l’atlas. Classe Map. Impossible d’instancier l’utilisateur.

LayerManager

Gestionnaire des couches du contrôle de carte. Exposé à travers la propriété couches de l’atlas. Classe Map. Impossible d’instancier l’utilisateur.

LayerOptions

Classe de base dont héritent toutes les autres options de couche.

LightOptions

Options pour l’éclairage de la carte.

LineLayerOptions

Options utilisées lors du rendu des objets SimpleLine, SimplePolygon, CirclePolygon, LineString, MultiLineString, Polygon et MultiPolygon dans une couche de traits.

MapConfiguration

Représente le contenu de la configuration de carte contenant une liste de styles disponibles.

MapConfigurationStyle

Représente les informations d’un style unique.

MapDataEvent

Objet d’événement retourné par les mappages lorsqu’un événement de données se produit.

MapErrorEvent

Objet d’événement retourné par les mappages lorsqu’un événement d’erreur se produit.

MapEvent

Objet d’événement retourné par les mappages lorsqu’un événement de base se produit.

MapMouseEvent

Objet d’événement retourné par les mappages lorsqu’un événement de souris se produit.

MapMouseWheelEvent

Objet d’événement retourné par les mappages lorsqu’un événement de roue se produit.

MapTouchEvent

Objet d’événement retourné par les mappages lorsqu’un événement tactile se produit.

MediaLayerOptions

Options utilisées lors du rendu du canevas, de l’image, de la vignette raster et des couches vidéo

Options
Padding

Représente la quantité de remplissage en pixels à ajouter au côté d’un BoundingBox lors de la définition de l’appareil photo d’une carte.

PitchControlOptions

Options d’un objet PitchControl.

PolygonExtrusionLayerOptions

Options utilisées lors du rendu des objets Polygon et MultiPolygon dans un PolygonExtrusionLayer.

PolygonLayerOptions

Options utilisées lors du rendu d’objets Polygon et MultiPolygon dans un PolygonLayer.

PopupEvents
PopupManager

Gestionnaire des fenêtres contextuelles du contrôle de carte. Exposé par le biais de la propriété popups de la classe atlas.Map. Impossible d’instancier l’utilisateur.

PopupOptions

Options d’une fenêtre contextuelle.

Properties

Ensemble de propriétés qui peuvent être utilisées avec un PopupTemplate

PropertyInfo

Détails sur la façon dont une propriété doit être affichée.

RasterTileSourceOptions
RequestParameters

Il s’agit du type d’objet attendu pour être retourné par le rappel transformRequest.

ScaleControlOptions

Options d’un objet ScaleControl.

ServiceOptions

Propriétés globales utilisées dans toutes les demandes de service Atlas.

ShapeEvents
SourceManager

Gestionnaire des sources du contrôle de carte. Exposé par le biais de la propriété sources de l’atlas. Classe Map. Impossible d’instancier l’utilisateur.

StyleChangedEvent

Objet d’événement retourné par la carte après le chargement d’un nouveau style.

StyleControlOptions

Options d’un objet StyleControl.

StyleOptions

Options pour le style de la carte.

SymbolLayerOptions

Options utilisées lors du rendu des géométries dans un SymbolLayer.

TargetedEvent
TextOptions

Options utilisées pour personnaliser le texte dans un SymbolLayer

Tile

Objet de vignette retourné par la carte lorsqu’un événement de données source se produit.

TileId
TileLayerOptions

Options utilisées lors du rendu d’images en mosaïques raster dans un TileLayer.

TrafficControlOptions
TrafficOptions

Options de définition du trafic sur la carte.

UserInteractionOptions

Options d’activation/désactivation de l’interaction utilisateur avec la carte.

VectorTileSourceOptions

Source de données pour la gestion des données de forme qui seront affichées sur la carte. Une source de données doit être ajoutée à une couche avant d’être visible sur la carte. Options d’un VectorTileSource.

WebGLLayerOptions

Options utilisées pour restituer des graphiques dans un WebGLLayer.

WebGLRenderer

Interface pour le rendu de graphiques WebGL dans un WebGLLayer.

ZoomControlOptions

Options d’un objet ZoomControl.

Alias de type

Expression

Peut être spécifié comme valeur de filtre ou de certaines options de couche. Une expression définit une formule pour calculer la valeur de la propriété. Les expressions sont représentées sous forme de tableaux JSON. Le premier élément d’une expression est une chaîne qui nomme l’opérateur d’expression.

getAuthTokenCallback

Fonction de rappel utilisée pour acquérir un jeton d’authentification en mode d’authentification anonyme. Résolvez avec le jeton d’authentification ou rejetez les erreurs.

ResourceType
StyleImageMetadata

Signature du paramètre options passé à ImageSpriteManager.add.

Énumérations

AuthenticationType

Énumération utilisée pour spécifier le type de mécanisme d’authentification à utiliser.

ControlPosition

Positions où le contrôle peut être placé sur la carte.

ControlStyle

Styles disponibles pour un contrôle.

Functions

addImageTemplate(string, string, boolean)

Ajoute un modèle d’image à l’espace de noms atlas.

addProtocol(string, (args: any[]) => Promise<any>)

Ajoute une fonction de ressource de charge personnalisée qui sera appelée lors de l’utilisation d’une URL qui commence par un schéma d’URL personnalisé.

clearPrewarmedResources()

Efface les ressources qui ont été créées précédemment par atlas.prewarm(). Notez que cela n’est généralement pas nécessaire. Vous devez appeler cette fonction uniquement si vous attendez que l’utilisateur de votre application ne retourne pas à un affichage Map à un moment quelconque dans votre application.

getAllImageTemplateNames()

Récupère un tableau de noms pour tous les modèles d’image disponibles dans l’espace de noms atlas.

getAuthenticationOptions()

Obtient les options d’authentification par défaut fournies. Si toutes les propriétés ne sont pas définies précédemment, elles ne sont pas définies.

getDomain()

Obtient le domaine par défaut fourni. Si la valeur par défaut n’est pas définie précédemment, "atlas.microsoft.com".

getImageTemplate(string, number)

Récupère un modèle SVG par nom.

getLanguage()

Obtient la langue par défaut fournie. Si la valeur par défaut n’est pas définie précédemment, "NGT".

getMaxParallelImageRequests()

Obtient le nombre maximal d’images (vignettes raster, sprites, icônes) à charger en parallèle

getSessionId()

Obtient l’ID de session par défaut fourni. Si la valeur par défaut n’est pas définie précédemment est un UUID aléatoire.

getSubscriptionKey()

Obtient la clé d’abonnement Azure Maps par défaut fournie.

getUserRegion()
getVersion()

Numéro de version de l’API actuel basé sur le numéro de build.

getView()

Obtient le paramètre d’affichage par défaut du contrôle de carte. Si la valeur par défaut n’est pas définie précédemment, undefined.

getWorkerCount()

Obtient le nombre de workers qui sera créé.

isSupported(boolean)

Vérifie si le navigateur de l’utilisateur est pris en charge par le contrôle de carte.

prewarm()

Initialise des ressources telles que WebWorkers qui peuvent être partagées entre des mappages afin de réduire les temps de chargement dans certaines situations. atlas.setWorkerCount, si elle est utilisée, doit être définie avant que prewarm() soit appelée pour avoir un effet. Par défaut, le cycle de vie de ces ressources est géré automatiquement et ils sont initialisés de manière différée lorsqu’une carte est créée pour la première fois. En appelant prewarm(), ces ressources seront créées à l’avance et ne seront pas effacées lorsque la dernière carte est supprimée de la page. Cela leur permet de les réutiliser par de nouvelles instances mappées qui sont créées ultérieurement. Ils peuvent être effacés manuellement en appelant atlas.clearPrewarmedResources(). Cela n’est nécessaire que si votre page web reste active, mais cesse d’utiliser complètement des cartes.

Cela est principalement utile lors de l’utilisation de cartes GL-JS dans une application de page unique, où un utilisateur naviguerait entre différentes vues qui peuvent entraîner la création et la destruction constante d’instances map.

removeProtocol(string)

Supprime un protocole précédemment ajouté dans le thread principal.

setAuthenticationOptions(AuthenticationOptions)

Définit vos options d’authentification comme options par défaut dans l’espace de noms atlas qui est utilisé par le contrôle de carte et tous les modules qui effectuent des demandes aux services Azure Maps. Si une carte est initialisée avec les options d’authentification explicitement définies et que setAuthenticationOptions n’a pas été appelée précédemment, elle sera automatiquement appelée par le constructeur map.

setDomain(string)

Définit le domaine par défaut utilisé par les modules de carte et de service, sauf si le domaine est explicitement spécifié lors de l’utilisation de ces parties de l’API. Si une carte est initialisée avec le domaine explicitement défini et que setDomain n’a pas été appelé précédemment, il sera automatiquement appelé par le constructeur map. Si le protocole n’est pas spécifié https est supposé.

setLanguage(string)

Définit la langue par défaut utilisée par les modules de carte et de service, sauf si la langue est explicitement spécifiée lors de l’utilisation de ces parties de l’API. Si une carte est initialisée avec le langage défini explicitement et que setLanguage n’a pas été appelé précédemment, il sera automatiquement appelé par le constructeur map.

setMaxParallelImageRequests(number)

Définit le nombre maximal d’images (mosaïques raster, sprites, icônes) à charger en parallèle, ce qui affecte les performances dans les cartes lourdes de raster. 16 par défaut.

setSessionId(string)

Définit l’ID de session par défaut utilisé par les modules de carte et de service, sauf si l’ID de session est spécifié explicitement lors de l’utilisation de ces parties de l’API. Si une carte est initialisée avec l’ID de session défini explicitement et que setSessionId n’a pas été appelé précédemment, il sera automatiquement appelé par le constructeur map.

setSubscriptionKey(string)

Définit votre clé d’abonnement Azure Maps comme clé d’abonnement par défaut dans l’espace de noms atlas qui est utilisée par le contrôle de carte et tous les modules qui effectuent des demandes aux services Azure Maps. Si une carte est initialisée avec la clé d’abonnement explicitement définie et que setSubscriptionKey n’a pas été appelée précédemment, elle sera automatiquement appelée par le constructeur map.

setUserRegion(string)
setView(string)

Spécifie quel ensemble de bordures et étiquettes géopolitiquement contestées sont affichés sur la carte. Le paramètre View (également appelé « paramètre de région utilisateur ») est un code de pays ISO-3166 de 2 lettres qui affiche les cartes correctes pour ce pays/région. Pays/régions qui ne figurent pas dans la liste d’affichages ou si elles ne sont pas spécifiées sont par défaut en mode « Unifié ». Consultez les [vues]{@link https://aka.ms/AzureMapsLocalizationViews }. Il vous incombe de déterminer l’emplacement de vos utilisateurs, puis de définir le paramètre View correctement pour cet emplacement. Le paramètre View dans Azure Maps doit être utilisé conformément aux lois applicables, y compris celles relatives au mappage, du pays/région où les cartes, les images et d’autres données et le contenu tiers que vous êtes autorisé à accéder via Azure Maps sont mis à disposition.

setWorkerCount(number)

Définit le nombre de workers web instanciés sur une page. Par défaut, il est défini sur la moitié du nombre de cœurs d’UC (limité à 6).

Informations relatives à la fonction

addImageTemplate(string, string, boolean)

Ajoute un modèle d’image à l’espace de noms atlas.

function addImageTemplate(templateName: string, template: string, override: boolean)

Paramètres

templateName

string

Nom du modèle.

template

string

Modèle SVG à ajouter. Prend en charge {color}, {secondaryColor}, {scale}, {text}.

override

boolean

Spécifie s’il doit remplacer les modèles existants s’il existe déjà un modèle portant le même nom.

addProtocol(string, (args: any[]) => Promise<any>)

Ajoute une fonction de ressource de charge personnalisée qui sera appelée lors de l’utilisation d’une URL qui commence par un schéma d’URL personnalisé.

function addProtocol(customProtocol: string, loadFn: (args: any[]) => Promise<any>)

Paramètres

customProtocol

string

le protocole à raccorder, par exemple « personnalisé »

loadFn

(args: any[]) => Promise<any>

fonction à utiliser lors de la tentative d’extraction d’une vignette spécifiée par le customProtocol

clearPrewarmedResources()

Efface les ressources qui ont été créées précédemment par atlas.prewarm(). Notez que cela n’est généralement pas nécessaire. Vous devez appeler cette fonction uniquement si vous attendez que l’utilisateur de votre application ne retourne pas à un affichage Map à un moment quelconque dans votre application.

function clearPrewarmedResources()

getAllImageTemplateNames()

Récupère un tableau de noms pour tous les modèles d’image disponibles dans l’espace de noms atlas.

function getAllImageTemplateNames(): string[]

Retours

string[]

getAuthenticationOptions()

Obtient les options d’authentification par défaut fournies. Si toutes les propriétés ne sont pas définies précédemment, elles ne sont pas définies.

function getAuthenticationOptions(): AuthenticationOptions

Retours

getDomain()

Obtient le domaine par défaut fourni. Si la valeur par défaut n’est pas définie précédemment, "atlas.microsoft.com".

function getDomain(): string

Retours

string

getImageTemplate(string, number)

Récupère un modèle SVG par nom.

function getImageTemplate(templateName: string, scale?: number): string

Paramètres

templateName

string

Nom du modèle à récupérer.

scale

number

Spécifie la quantité à mettre à l’échelle le modèle. Pour obtenir de meilleurs résultats, mettez à l’échelle l’icône sur la taille maximale que vous souhaitez afficher sur la carte, puis utilisez l’option de taille d’icône de couches de symboles pour effectuer un scale-down si nécessaire. Cela réduit le flou en raison de la mise à l’échelle. Valeur par défaut : 1

Retours

string

getLanguage()

Obtient la langue par défaut fournie. Si la valeur par défaut n’est pas définie précédemment, "NGT".

function getLanguage(): string

Retours

string

getMaxParallelImageRequests()

Obtient le nombre maximal d’images (vignettes raster, sprites, icônes) à charger en parallèle

function getMaxParallelImageRequests(): number

Retours

number

getSessionId()

Obtient l’ID de session par défaut fourni. Si la valeur par défaut n’est pas définie précédemment est un UUID aléatoire.

function getSessionId(): string

Retours

string

getSubscriptionKey()

Obtient la clé d’abonnement Azure Maps par défaut fournie.

function getSubscriptionKey(): string

Retours

string

getUserRegion()

Avertissement

Cette API est à présent déconseillée.

use atlas.getView() instead

function getUserRegion(): string

Retours

string

getVersion()

Numéro de version de l’API actuel basé sur le numéro de build.

function getVersion(): string

Retours

string

getView()

Obtient le paramètre d’affichage par défaut du contrôle de carte. Si la valeur par défaut n’est pas définie précédemment, undefined.

function getView(): string

Retours

string

getWorkerCount()

Obtient le nombre de workers qui sera créé.

function getWorkerCount(): number

Retours

number

isSupported(boolean)

Vérifie si le navigateur de l’utilisateur est pris en charge par le contrôle de carte.

function isSupported(failIfMajorPerformanceCaveat?: boolean): boolean

Paramètres

failIfMajorPerformanceCaveat

boolean

Si true, la fonction retourne false si les performances du contrôle de carte seraient nettement pires que prévu (par exemple, un renderer WebGL logiciel serait utilisé).

Retours

boolean

prewarm()

Initialise des ressources telles que WebWorkers qui peuvent être partagées entre des mappages afin de réduire les temps de chargement dans certaines situations. atlas.setWorkerCount, si elle est utilisée, doit être définie avant que prewarm() soit appelée pour avoir un effet. Par défaut, le cycle de vie de ces ressources est géré automatiquement et ils sont initialisés de manière différée lorsqu’une carte est créée pour la première fois. En appelant prewarm(), ces ressources seront créées à l’avance et ne seront pas effacées lorsque la dernière carte est supprimée de la page. Cela leur permet de les réutiliser par de nouvelles instances mappées qui sont créées ultérieurement. Ils peuvent être effacés manuellement en appelant atlas.clearPrewarmedResources(). Cela n’est nécessaire que si votre page web reste active, mais cesse d’utiliser complètement des cartes.

Cela est principalement utile lors de l’utilisation de cartes GL-JS dans une application de page unique, où un utilisateur naviguerait entre différentes vues qui peuvent entraîner la création et la destruction constante d’instances map.

function prewarm()

removeProtocol(string)

Supprime un protocole précédemment ajouté dans le thread principal.

function removeProtocol(customProtocol: string)

Paramètres

customProtocol

string

protocole personnalisé pour supprimer l’inscription pour

setAuthenticationOptions(AuthenticationOptions)

Définit vos options d’authentification comme options par défaut dans l’espace de noms atlas qui est utilisé par le contrôle de carte et tous les modules qui effectuent des demandes aux services Azure Maps. Si une carte est initialisée avec les options d’authentification explicitement définies et que setAuthenticationOptions n’a pas été appelée précédemment, elle sera automatiquement appelée par le constructeur map.

function setAuthenticationOptions(options: AuthenticationOptions)

Paramètres

options
AuthenticationOptions

Nouvelles options d’authentification par défaut.

setDomain(string)

Définit le domaine par défaut utilisé par les modules de carte et de service, sauf si le domaine est explicitement spécifié lors de l’utilisation de ces parties de l’API. Si une carte est initialisée avec le domaine explicitement défini et que setDomain n’a pas été appelé précédemment, il sera automatiquement appelé par le constructeur map. Si le protocole n’est pas spécifié https est supposé.

function setDomain(domain: string)

Paramètres

domain

string

Nouveau domaine par défaut.

setLanguage(string)

Définit la langue par défaut utilisée par les modules de carte et de service, sauf si la langue est explicitement spécifiée lors de l’utilisation de ces parties de l’API. Si une carte est initialisée avec le langage défini explicitement et que setLanguage n’a pas été appelé précédemment, il sera automatiquement appelé par le constructeur map.

function setLanguage(language: string)

Paramètres

language

string

Nouvelle langue par défaut.

setMaxParallelImageRequests(number)

Définit le nombre maximal d’images (mosaïques raster, sprites, icônes) à charger en parallèle, ce qui affecte les performances dans les cartes lourdes de raster. 16 par défaut.

function setMaxParallelImageRequests(maxParallelImageRequests: number)

Paramètres

maxParallelImageRequests

number

Nombre maximal d’images à charger en parallèle.

setSessionId(string)

Définit l’ID de session par défaut utilisé par les modules de carte et de service, sauf si l’ID de session est spécifié explicitement lors de l’utilisation de ces parties de l’API. Si une carte est initialisée avec l’ID de session défini explicitement et que setSessionId n’a pas été appelé précédemment, il sera automatiquement appelé par le constructeur map.

function setSessionId(id: string)

Paramètres

id

string

Nouvel ID de session par défaut.

setSubscriptionKey(string)

Définit votre clé d’abonnement Azure Maps comme clé d’abonnement par défaut dans l’espace de noms atlas qui est utilisée par le contrôle de carte et tous les modules qui effectuent des demandes aux services Azure Maps. Si une carte est initialisée avec la clé d’abonnement explicitement définie et que setSubscriptionKey n’a pas été appelée précédemment, elle sera automatiquement appelée par le constructeur map.

function setSubscriptionKey(key: string)

Paramètres

key

string

Nouvelle clé d’abonnement par défaut.

setUserRegion(string)

Avertissement

Cette API est à présent déconseillée.

use atlas.setView(view: string) instead.

function setUserRegion(userRegion: string)

Paramètres

userRegion

string

setView(string)

Spécifie quel ensemble de bordures et étiquettes géopolitiquement contestées sont affichés sur la carte. Le paramètre View (également appelé « paramètre de région utilisateur ») est un code de pays ISO-3166 de 2 lettres qui affiche les cartes correctes pour ce pays/région. Pays/régions qui ne figurent pas dans la liste d’affichages ou si elles ne sont pas spécifiées sont par défaut en mode « Unifié ». Consultez les [vues]{@link https://aka.ms/AzureMapsLocalizationViews }. Il vous incombe de déterminer l’emplacement de vos utilisateurs, puis de définir le paramètre View correctement pour cet emplacement. Le paramètre View dans Azure Maps doit être utilisé conformément aux lois applicables, y compris celles relatives au mappage, du pays/région où les cartes, les images et d’autres données et le contenu tiers que vous êtes autorisé à accéder via Azure Maps sont mis à disposition.

function setView(view: string)

Paramètres

view

string

Nouvelle vue par défaut

setWorkerCount(number)

Définit le nombre de workers web instanciés sur une page. Par défaut, il est défini sur la moitié du nombre de cœurs d’UC (limité à 6).

function setWorkerCount(workerCount: number)

Paramètres

workerCount

number

nombre de workers.