atlas module
Classes
EventManager |
Un gestionnaire pour les événements du contrôle de carte. Exposé via la propriété events 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 pixels. É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 sa mise à jour et sa maintenance. |
Interfaces
AggregateExpression |
Une expression d’agrégation définit un calcul qui est traité sur un ensemble de données.
Schéma : [opérateur : string, initialValue ?: boolean | number, mapExpression : Expression] opérateur : fonction d’expression qui est ensuite appliquée à toutes les valeurs calculées par pour |
AnimationOptions |
Options d’animation des modifications apportées à la caméra du contrôle de carte. |
AuthenticationManager |
Un gestionnaire pour l’authentification du contrôle de carte. Exposé via la propriété d’authentification de l’atlas. Classe Map. Impossible d’instancier l’utilisateur. |
AuthenticationOptions |
Options permettant de spécifier 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 permettant de définir les limites de la caméra du contrôle de carte. |
CameraOptions |
Options permettant de définir la caméra du contrôle de carte. |
ClusteredProperties |
Propriétés qui existeront pour ClusteredProperties |
CompassControlOptions |
Options d’un objet CompassControl. |
Control |
Interface permettant de définir un contrôle de la carte. |
ControlManager |
Un gestionnaire pour les contrôles du contrôle de carte. Exposé via la propriété controls de l’atlas. Classe Map. Impossible d’instancier l’utilisateur. |
ControlOptions |
Options permettant d’ajouter 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 pour un |
ElevationTileSourceOptions | |
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é via la propriété marqueurs de l’atlas. Classe Map. Impossible d’instancier l’utilisateur. |
HtmlMarkerOptions |
Options de rendu d’un objet HtmlMarker |
HyperLinkFormatOptions |
Option de 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 pour le sprite d’image du contrôle de carte. Exposé via la propriété imageSprite de l’atlas. Classe Map. Impossible d’instancier l’utilisateur. |
LayerManager |
Un gestionnaire pour les couches du contrôle de carte. Exposé à travers la propriété calques de l’atlas. Classe Map. Impossible d’instancier l’utilisateur. |
LayerOptions |
Classe de base dont toutes les autres options de couche héritent. |
LightOptions |
Options pour l’éclairage de la carte. |
LineLayerOptions |
Options utilisées lors du rendu des objets SimpleLine, SimplePolygon, CirclePolygon, LineString, MultiLineString, Polygone et MultiPolygon dans une couche de lignes. |
MapConfiguration |
Représente le contenu de la configuration de la 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 pour le rendu des calques de canevas, d’image, de mosaïque raster et de vidéo |
Options | |
Padding |
Représente la quantité de remplissage en pixels à ajouter sur le 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 |
PolygonLayerOptions |
Options utilisées lors du rendu d’objets Polygon et MultiPolygon dans un PolygonLayer. |
PopupEvents | |
PopupManager |
Un gestionnaire pour les fenêtres contextuelles du contrôle de carte.
Exposé via la |
PopupOptions |
Options d’une fenêtre contextuelle. |
Properties |
Ensemble de propriétés qui peuvent être utilisées avec un |
PropertyInfo |
Détails de l’espèce sur la façon dont une propriété doit être affichée. |
RasterTileSourceOptions | |
RequestParameters |
Il s’agit du type d’objet qui doit ê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 |
Un gestionnaire pour les sources du contrôle de carte. Exposé via 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 du 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 mosaïque 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ïque raster dans un TileLayer. |
TrafficControlOptions | |
TrafficOptions |
Options permettant de définir le trafic sur la carte. |
UserInteractionOptions |
Options permettant d’activer/désactiver 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 pour un |
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 le calcul de 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 nommant 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 refusez avec des erreurs. |
ResourceType | |
StyleImageMetadata |
Signature du |
É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. |
Fonctions
add |
Ajoute un modèle d’image à l’espace de noms atlas. |
clear |
Efface les ressources qui ont été créées précédemment par |
get |
Récupère un tableau de noms pour tous les modèles d’image disponibles dans l’espace de noms atlas. |
get |
Obtient les options d’authentification par défaut qui ont été fournies. Si ce n’est pas le cas, toutes les propriétés ne sont pas définies. |
get |
Obtient le domaine par défaut fourni.
Si ce n’est pas le cas précédemment, la valeur par défaut est |
get |
Récupère un modèle SVG par son nom. |
get |
Obtient la langue par défaut qui a été fournie.
Si ce n’est pas le cas précédemment, la valeur par défaut est |
get |
Obtient le nombre maximal d’images (vignettes raster, sprites, icônes) à charger en parallèle |
get |
Obtient l’ID de session par défaut qui a été fourni. Si ce n’est pas le cas précédemment, la valeur par défaut est un UUID aléatoire. |
get |
Obtient la clé d’abonnement Azure Maps par défaut qui a été fournie. |
get |
|
get |
Numéro de version de l’API actuel en fonction du numéro de build. |
get |
Obtient le paramètre d’affichage par défaut du contrôle de carte.
Si ce n’est pas le cas précédemment, la valeur par défaut est |
get |
Obtient le nombre de workers qui seront créés. |
is |
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 pour réduire les temps de chargement dans certaines situations. Cela est principalement utile lors de l’utilisation de cartes GL-JS dans une application à page unique, où un utilisateur navigue entre différentes vues qui peuvent entraîner la création et la destruction constantes d’instances map. |
set |
Définit vos options d’authentification comme options par défaut dans l’espace de noms atlas utilisé par le contrôle de carte et tous les modules qui effectuent des requêtes aux services Azure Maps. Si un mappage est initialisé avec les options d’authentification définies explicitement et que setAuthenticationOptions n’a pas été appelé précédemment, il est automatiquement appelé par le constructeur Map. |
set |
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 un mappage est initialisé avec le domaine explicitement défini et que setDomain n’a pas été appelé précédemment, il est automatiquement appelé par le constructeur Map.
Si le protocole n’est pas spécifié est supposé |
set |
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 un mappage est initialisé avec le langage explicitement défini et que setLanguage n’a pas été appelé précédemment, il est automatiquement appelé par le constructeur Map. |
set |
Définit le nombre maximal d’images (vignettes raster, sprites, icônes) à charger en parallèle, ce qui affecte les performances dans les cartes avec une forte trame. 16 par défaut. |
set |
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 explicitement spécifié lors de l’utilisation de ces parties de l’API. Si un mappage est initialisé avec l’ID de session explicitement défini et que setSessionId n’a pas été appelé précédemment, il est automatiquement appelé par le constructeur Map. |
set |
Définit votre clé d’abonnement Azure Maps comme clé d’abonnement 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 requêtes aux services Azure Maps. Si un mappage est initialisé avec la clé d’abonnement explicitement définie et que setSubscriptionKey n’a pas été appelé précédemment, il est automatiquement appelé par le constructeur Map. |
set |
|
set |
Spécifie l’ensemble de bordures et d’étiquettes géopolitiquement contestées qui sont affichées sur la carte. Le paramètre View (également appelé « paramètre de région utilisateur ») est un code pays ISO-3166 à 2 lettres qui affiche les cartes correctes pour ce pays/région. Les pays/régions qui ne figurent pas dans la liste Affichage ou s’ils ne sont pas spécifiés sont l’affichage « Unifié » par défaut. Consultez les [Vues]{@link https://aka.ms/AzureMapsLocalizationViews }prises en charge. Il vous incombe de déterminer l'emplacement de vos utilisateurs, puis de définir correctement le paramètre Affichage correspondant à 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 ou de la région où les cartes, images et autres données et le contenu tiers auquel vous êtes autorisé à accéder via Azure Maps est mis à disposition. |
set |
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.
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 ne devez appeler cette fonction que si vous vous attendez à ce que l’utilisateur de votre application ne retourne pas à une vue Cartographique à un point quelconque de 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 qui ont été fournies. Si ce n’est pas le cas, toutes les propriétés ne sont pas définies.
function getAuthenticationOptions(): AuthenticationOptions
Retours
getDomain()
Obtient le domaine par défaut fourni.
Si ce n’est pas le cas précédemment, la valeur par défaut est "atlas.microsoft.com"
.
function getDomain(): string
Retours
string
getImageTemplate(string, number)
Récupère un modèle SVG par son 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 de meilleurs résultats, mettez à l’échelle l’icône à la taille maximale que vous souhaitez afficher sur la carte, puis utilisez l’option de taille de l’icône couches de symboles pour effectuer un scale-down si nécessaire. Cela réduira le flou dû à la mise à l’échelle. Valeur par défaut : 1
Retours
string
getLanguage()
Obtient la langue par défaut qui a été fournie.
Si ce n’est pas le cas précédemment, la valeur par défaut est "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 qui a été fourni. Si ce n’est pas le cas précédemment, la valeur par défaut est un UUID aléatoire.
function getSessionId(): string
Retours
string
getSubscriptionKey()
Obtient la clé d’abonnement Azure Maps par défaut qui a été 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 en fonction du 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 ce n’est pas le cas précédemment, la valeur par défaut est undefined
.
function getView(): string
Retours
string
getWorkerCount()
Obtient le nombre de workers qui seront créés.
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 la valeur est true, la fonction retourne false si les performances du contrôle de carte sont nettement pires que prévu (par exemple, un convertisseur WebGL logiciel est utilisé).
Retours
boolean
prewarm()
Initialise des ressources telles que WebWorkers qui peuvent être partagées entre des mappages pour réduire les temps de chargement dans certaines situations. atlas.setWorkerCount
, s’il est utilisé, doit être défini avant prewarm()
que ne soit appelé pour avoir un effet.
Par défaut, le cycle de vie de ces ressources est géré automatiquement et elles sont initialisées tardivement lors de la création d’une carte. En appelant prewarm()
, ces ressources sont créées à l’avance et ne sont pas effacées lorsque la dernière carte est supprimée de la page. Cela leur permet d’être réutilisés par les nouvelles instances map 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 à page unique, où un utilisateur navigue entre différentes vues qui peuvent entraîner la création et la destruction constantes d’instances map.
function prewarm()
setAuthenticationOptions(AuthenticationOptions)
Définit vos options d’authentification comme options par défaut dans l’espace de noms atlas utilisé par le contrôle de carte et tous les modules qui effectuent des requêtes aux services Azure Maps. Si un mappage est initialisé avec les options d’authentification définies explicitement et que setAuthenticationOptions n’a pas été appelé précédemment, il est automatiquement appelé 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 un mappage est initialisé avec le domaine explicitement défini et que setDomain n’a pas été appelé précédemment, il est automatiquement appelé par le constructeur Map.
Si le protocole n’est pas spécifié est supposé https
.
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 un mappage est initialisé avec le langage explicitement défini et que setLanguage n’a pas été appelé précédemment, il est 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 (vignettes raster, sprites, icônes) à charger en parallèle, ce qui affecte les performances dans les cartes avec une forte trame. 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 explicitement spécifié lors de l’utilisation de ces parties de l’API. Si un mappage est initialisé avec l’ID de session explicitement défini et que setSessionId n’a pas été appelé précédemment, il est 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é par le contrôle de carte et tous les modules qui effectuent des requêtes aux services Azure Maps. Si un mappage est initialisé avec la clé d’abonnement explicitement définie et que setSubscriptionKey n’a pas été appelé précédemment, il est automatiquement appelé 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 l’ensemble de bordures et d’étiquettes géopolitiquement contestées qui sont affichées sur la carte. Le paramètre View (également appelé « paramètre de région utilisateur ») est un code pays ISO-3166 à 2 lettres qui affiche les cartes correctes pour ce pays/région. Les pays/régions qui ne figurent pas dans la liste Affichage ou s’ils ne sont pas spécifiés sont l’affichage « Unifié » par défaut. Consultez les [Vues]{@link https://aka.ms/AzureMapsLocalizationViews }prises en charge. Il vous incombe de déterminer l'emplacement de vos utilisateurs, puis de définir correctement le paramètre Affichage correspondant à 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 ou de la région où les cartes, images et autres données et le contenu tiers auquel vous êtes autorisé à accéder via Azure Maps est 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.