RenderGetMapStaticImageQueryParamProperties interface

Un cadre englobant est défini par deux latitudes et deux longitudes qui représentent les quatre côtés d’une zone rectangulaire sur la Terre. Format : 'minLon, minLat, maxLon, maxLat' (en double).

Remarque : bbox ou centre sont des paramètres obligatoires. Elles s’excluent mutuellement. bbox ne doit pas être utilisé avec la hauteur ou la largeur.

Les plages maximales et minimales autorisées pour Lat et Lon sont définies pour chaque niveau de zoom dans le tableau en haut de cette page.

bbox?: number[]

Valeur de propriété

Coordonnées du point central en double. Format : 'lon,lat'. Plage de longitude : -180 à 180. Plage de latitude : -90 à 90.

Remarque : les paramètres centre ou bbox sont obligatoires. Elles s’excluent mutuellement.

center?: number[]

Valeur de propriété

Hauteur de l’image résultante en pixels. Comprise entre 80 et 1500. La valeur par défaut est 512. Il ne doit pas être utilisé avec la boîte de réception.

height?: number

Valeur de propriété

Langue dans laquelle les résultats de recherche doivent être retournés. Doit être l’une des balises de langage IETF prises en charge, sans respect de 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é

Style de chemin d’accès et emplacements (en double). Utilisez ce paramètre pour ajouter éventuellement des lignes, des polygones ou des cercles à l’image. Le style de chemin décrit l’apparence de la ligne et du remplissage. (Veillez à encoder correctement les valeurs d’URL de ce paramètre, car il contiendra des caractères réservés tels que les canaux et la ponctuation.)

Le paramètre de chemin d’accès est pris en charge dans la référence SKU du compte Azure Maps à partir de S1. Plusieurs instances du paramètre path permettent de spécifier plusieurs géométries avec leurs styles. Le nombre de paramètres par requête est limité à 10 et le nombre d’emplacements est limité à 100 par chemin.

Pour afficher un cercle avec un rayon de 100 mètres et un point central à latitude 45°N et longitude 122°W à l’aide du style par défaut, ajoutez le paramètre querystring

path=ra100||-122 45

Notez que la longitude est antérieure à la latitude. Après l’encodage d’URL, cela ressemble à

path=ra100%7C%7C-122+45

Tous les exemples montrent ici le paramètre de chemin d’accès sans encodage d’URL, pour plus de clarté.

Pour afficher une ligne, séparez chaque emplacement par un caractère de canal. Par exemple, utiliser

path=||-122 45|-119.5 43.2|-121.67 47.12

Un polygone est spécifié avec un chemin fermé, où les premiers et derniers points sont égaux. Par exemple, utiliser

path=||-122 45|-119.5 43.2|-121.67 47.12|-122 45

La valeur de longitude pour les emplacements des lignes et des polygones peut être comprise entre -360 et 360 afin de permettre le rendu des géométries qui traversent le méridien.

Modificateurs de style

Vous pouvez modifier l’apparence du chemin en ajoutant des modificateurs de style. Celles-ci sont ajoutées avant les emplacements. Les modificateurs de style ont chacun un nom à deux lettres. Ces noms abrégés sont utilisés pour réduire la longueur de l’URL.

Pour modifier la couleur du contour, utilisez le modificateur de style « lc » et spécifiez la couleur au format de couleur RVB HTML/CSS, qui est un nombre hexadécimal à six chiffres (le formulaire à trois chiffres n’est pas pris en charge). Par exemple, pour utiliser une couleur rose profonde que vous spécifiez comme #FF1493 dans CSS, utilisez

path=lcFF1493||-122 45|-119.5 43.2

Plusieurs modificateurs de style peuvent être combinés pour créer un style visuel plus complexe.

lc0000FF|lw3|la0.60|fa0.50||-122.2 47.6|-122.2 47.7|-122.3 47.7|-122.3 47.6|-122.2 47.6

Résumé du modificateur de style

path?: string

Valeur de propriété

Style et instances pushpin. Utilisez ce paramètre pour ajouter éventuellement des punaises à l’image. Le style pushpin décrit l’apparence des punaises, et les instances spécifient les coordonnées des punaises (en double) et des étiquettes facultatives pour chaque broche. (Veillez à encoder correctement les valeurs d’URL de ce paramètre, car il contiendra des caractères réservés tels que les canaux et la ponctuation.)

La référence SKU S0 du compte Azure Maps prend uniquement en charge une seule instance du paramètre épingle et le nombre d’emplacements est limité à 5 par broche. D’autres références SKU autorisent jusqu’à 25 instances du paramètre de broches à spécifier plusieurs styles de broche, et le nombre d’emplacements est limité à 50 par broche.

Pour afficher une punaise à la latitude 45°N et longitude 122°W à l’aide du style pushpin intégré par défaut, ajoutez le paramètre querystring

pins=default||-122 45

Notez que la longitude est antérieure à la latitude. Après l’encodage d’URL, cela ressemble à

pins=default%7C%7C-122+45

Tous les exemples montrent ici le paramètre épingle sans encodage d’URL, pour plus de clarté.

Pour afficher une broche à plusieurs emplacements, séparez chaque emplacement par un caractère de canal. Par exemple, utiliser

pins=default||-122 45|-119.5 43.2|-121.67 47.12

La référence SKU du compte Azure Maps autorise uniquement cinq broches. Les autres références SKU de compte n’ont pas cette limitation.

Modificateurs de style

Vous pouvez modifier l’apparence des broches en ajoutant des modificateurs de style. Celles-ci sont ajoutées après le style, mais avant les emplacements et les étiquettes. Les modificateurs de style ont chacun un nom à deux lettres. Ces noms abrégés sont utilisés pour réduire la longueur de l’URL.

Pour modifier la couleur de la punaise, utilisez le modificateur de style « co » et spécifiez la couleur à l’aide du format de couleur RVB HTML/CSS, qui est un nombre hexadécimal à six chiffres (le formulaire à trois chiffres n’est pas pris en charge). Par exemple, pour utiliser une couleur rose profonde que vous spécifiez comme #FF1493 dans CSS, utilisez

pins=default|coFF1493||-122 45

Étiquettes pushpin

Pour ajouter une étiquette aux broches, placez l’étiquette entre guillemets simples juste avant les coordonnées. Évitez d’utiliser un caractère spécial tel que | ou || dans l’étiquette. Par exemple, pour étiqueter trois broches avec les valeurs « 1 », « 2 » et « 3 », utilisez

pins=default||'1'-122 45|'2'-119.5 43.2|'3'-121.67 47.12

Il existe un style pushpin intégré appelé « none » qui n’affiche pas d’image pushpin. Vous pouvez l’utiliser si vous souhaitez afficher des étiquettes sans image d’épingle. Par exemple

pins=none||'A'-122 45|'B'-119.5 43.2

Pour modifier la couleur des étiquettes pushpin, utilisez le modificateur de style de couleur d’étiquette « lc ». Par exemple, pour utiliser des punaises roses avec des étiquettes noires, utilisez

pins=default|coFF1493|lc000000||-122 45

Pour modifier la taille des étiquettes, utilisez le modificateur de style de taille d’étiquette « ls ». La taille de l’étiquette représente la hauteur approximative du texte de l’étiquette en pixels. Par exemple, pour augmenter la taille de l’étiquette à 12, utilisez

pins=default|ls12||'A'-122 45|'B'-119 43

Les étiquettes sont centrées au niveau de l’ancre d’étiquette de l’épingle. L’emplacement d’ancrage est prédéfini pour les punaises intégrées et se trouve en haut du centre des punaises personnalisées (voir ci-dessous). Pour remplacer l’ancre d’étiquette, utilisez le modificateur de style « la » et fournissez des coordonnées X et Y pixels pour l’ancre. Ces coordonnées sont relatives au coin supérieur gauche de l’image pushpin. Les valeurs X positives déplacent l’ancre à droite, et les valeurs Y positives déplacent l’ancre vers le bas. Par exemple, pour positionner l’ancre d’étiquette 10 pixels à droite et 4 pixels au-dessus du coin supérieur gauche de l’image de punaise, utilisez

pins=default|la10 -4||'A'-122 45|'B'-119 43

Épingles personnalisées

Pour utiliser une image pushpin personnalisée, utilisez le mot « personnalisé » comme nom de style d’épingle, puis spécifiez une URL après l’emplacement et les informations d’étiquette. La taille maximale autorisée pour une image d’étiquette personnalisée est de 65 536 pixels. Utilisez deux caractères de canal pour indiquer que vous avez terminé de spécifier des emplacements et démarrez l’URL. Par exemple

pins=custom||-122 45||http://contoso.com/pushpins/red.png

Après l’encodage d’URL, cela ressemblerait à

pins=custom%7C%7C-122+45%7C%7Chttp%3A%2F%2Fcontoso.com%2Fpushpins%2Fred.png

Par défaut, les images pushpin personnalisées sont dessinées centrées sur les coordonnées de broche. Cela n’est généralement pas idéal car il masque l’emplacement que vous essayez de mettre en surbrillance. Pour remplacer l’emplacement d’ancrage de l’image de broche, utilisez le modificateur de style « an ». Cela utilise le même format que le modificateur de style d’ancrage de l’étiquette « la ». Par exemple, si votre image d’épingle personnalisée a la pointe de la broche en haut à gauche de l’image, vous pouvez définir l’ancrage sur cet emplacement à l’aide de

pins=custom|an0 0||-122 45||http://contoso.com/pushpins/red.png

Remarque : Si vous utilisez le modificateur de couleur « co » avec une image pushpin personnalisée, la couleur spécifiée remplace les canaux RVB des pixels de l’image, mais laisse le canal alpha (opacité) inchangé. Cela ne serait généralement effectué qu’avec une image personnalisée de couleur unie.

Mise à l’échelle, rotation et opacité

Vous pouvez rendre les punaises et leurs étiquettes plus grandes ou plus petites à l’aide du modificateur de style d’échelle « sc ». Il s’agit d’une valeur supérieure à zéro. La valeur 1 correspond à l’échelle standard. Les valeurs supérieures à 1 rendent les broches plus grandes et les valeurs inférieures à 1 les rendent plus petites. Par exemple, pour dessiner les punaises 50% supérieures à la normale, utilisez

pins=default|sc1.5||-122 45

Vous pouvez faire pivoter les punaises et leurs étiquettes à l’aide du modificateur de style de rotation « ro ». Il s’agit d’un certain nombre de degrés de rotation dans le sens des aiguilles d’une montre. Utilisez un nombre négatif pour faire pivoter le sens inverse des aiguilles d’une montre. Par exemple, pour faire pivoter les punaises de 90 degrés dans le sens des aiguilles d’une montre et doubler leur taille, utilisez

pins=default|ro90|sc2||-122 45

Vous pouvez rendre les punaises et leurs étiquettes partiellement transparentes en spécifiant le modificateur de style alpha « al ». Il s’agit d’un nombre compris entre 0 et 1 indiquant l’opacité des punaises. Zéro les rend complètement transparents (et non visibles) et 1 les rend complètement opaques (ce qui est la valeur par défaut). Par exemple, pour faire des punaises et leurs étiquettes seulement 67% opaques, utilisez

pins=default|al.67||-122 45

Résumé du modificateur de style

• Les coordonnées X et Y peuvent être n’importe où dans l’image d’épingle ou une marge autour de celle-ci. La taille de marge est le minimum de la largeur et de la hauteur des broches.

pins?: string

Valeur de propriété

Style de carte à renvoyer. Les valeurs possibles sont microsoft.base.road, microsoft.base.darkgrey et microsoft.imagery. La valeur par défaut est définie sur microsoft.base.road. Pour plus d’informations, consultez Render TilesetId.

tilesetId?: "microsoft.base" | "microsoft.base.labels" | "microsoft.base.hybrid" | "microsoft.terra.main" | "microsoft.base.road" | "microsoft.base.darkgrey" | "microsoft.base.labels.road" | "microsoft.base.labels.darkgrey" | "microsoft.base.hybrid.road" | "microsoft.base.hybrid.darkgrey" | "microsoft.imagery" | "microsoft.weather.radar.main" | "microsoft.weather.infrared.main" | "microsoft.traffic.absolute" | "microsoft.traffic.absolute.main" | "microsoft.traffic.relative" | "microsoft.traffic.relative.main" | "microsoft.traffic.relative.dark" | "microsoft.traffic.delay" | "microsoft.traffic.delay.main" | "microsoft.traffic.reduced.main" | "microsoft.traffic.incident"

Valeur de propriété

Valeur facultative, indiquant qu’aucun flux de trafic n’est superposé sur le résultat de l’image. Les valeurs possibles sont microsoft.traffic.relative.main et aucune. La valeur par défaut n’est aucune, indiquant qu’aucun flux de trafic n’est retourné. Si le tilesetId associé au trafic est fourni, retourne l’image de carte avec la couche de trafic correspondante. Pour plus d’informations, consultez Render TilesetId.

trafficLayer?: "microsoft.traffic.relative.main" | "none"

Valeur de propriété

Le paramètre View (également appelé paramètre « région utilisateur ») vous permet d’afficher les cartes appropriées pour un certain pays/région pour les régions géopolitiquement contestées. Différents pays/régions ont des vues différentes de ces régions, et le paramètre View permet à votre application de se conformer à la vue requise par le pays/région que votre application servira. Par défaut, le paramètre View est défini sur « Unifié », 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 le paramètre View correctement pour cet emplacement. Vous avez également la possibilité de définir « View=Auto », qui retourne les données cartographiques en fonction de 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/de la 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. Exemple : view=IN.

Reportez-vous à vues prises en charge pour plus d’informations et pour afficher les vues disponibles.

view?: "AE" | "AR" | "BH" | "IN" | "IQ" | "JO" | "KW" | "LB" | "MA" | "OM" | "PK" | "PS" | "QA" | "SA" | "SY" | "YE" | "Auto" | "Unified"

Valeur de propriété

Largeur de l’image résultante en pixels. Comprise entre 80 et 2000. La valeur par défaut est 512. Il ne doit pas être utilisé avec la boîte de réception.

width?: number

Valeur de propriété

Niveau de zoom souhaité de la carte. Prise en charge de la plage de valeurs de zoom comprise entre 0 et 20 (inclus) pour tilesetId étant microsoft.base.road ou microsoft.base.darkgrey. Prise en charge de la plage de valeurs de zoom comprise entre 0 et 19 (inclus) pour tilesetId étant microsoft.imagery. La valeur par défaut est 12.

Pour plus d’informations, consultez Niveaux de zoom et grille de vignettes.

zoom?: number

Valeur de propriété