Class StaticMap

StaticMap

Permet de créer et de décorer des images de carte statiques.

L'exemple ci-dessous montre comment utiliser cette classe pour créer une carte du quartier des théâtres à New York, y compris les gares à proximité, et l'afficher dans une application Web simple.

// Create a map centered on Times Square.
var map = Maps.newStaticMap()
    .setSize(600, 600)
    .setCenter('Times Square, New York, NY');

// Add markers for the nearbye train stations.
map.setMarkerStyle(Maps.StaticMap.MarkerSize.MID, Maps.StaticMap.Color.RED, 'T');
map.addMarker('Grand Central Station, New York, NY');
map.addMarker('Penn Station, New York, NY');

// Show the boundaries of the Theatre District.
var corners = [
  '8th Ave & 53rd St, New York, NY',
  '6th Ave & 53rd St, New York, NY',
  '6th Ave & 40th St, New York, NY',
  '8th Ave & 40th St, New York, NY'
];
map.setPathStyle(4, Maps.StaticMap.Color.BLACK, Maps.StaticMap.Color.BLUE);
map.beginPath();
for (var i = 0; i < corners.length; i++) {
  map.addAddress(corners[i]);
}
// All static map URLs require an API key.
var url = map.getMapUrl() + "&key=YOUR_API_KEY";

Voir aussi

• API Google Static Maps

Méthodes

Méthode	Type renvoyé	Brève description
addAddress(address)	StaticMap	Ajoute une adresse à la définition actuelle du chemin.
addMarker(latitude, longitude)	StaticMap	Ajoute un repère sur la carte à l'aide d'un point (lat/lng).
addMarker(address)	StaticMap	Ajoute un repère sur la carte à l'aide d'une adresse.
addPath(points)	StaticMap	Ajoute un trajet sur la carte à l'aide d'un tableau de points.
addPath(polyline)	StaticMap	Ajoute un tracé à la carte à l'aide d'une polyligne encodée.
addPoint(latitude, longitude)	StaticMap	Ajoute un nouveau point (lat/lng) à la définition actuelle du tracé.
addVisible(latitude, longitude)	StaticMap	Ajoute un point (lat/lng) qui doit être visible sur la carte.
addVisible(address)	StaticMap	Ajoute une adresse qui doit être visible sur la carte.
beginPath()	StaticMap	Démarre une nouvelle définition de chemin.
clearMarkers()	StaticMap	Efface l'ensemble de repères actuel.
clearPaths()	StaticMap	Effacez l'ensemble actuel de chemins d'accès.
clearVisibles()	StaticMap	Efface l'ensemble actuel de lieux visibles.
endPath()	StaticMap	Termine une définition de chemin commencée parbeginPath().
getAs(contentType)	Blob	Renvoie les données contenues dans cet objet sous forme d'objet blob converti dans le type de contenu spécifié.
getBlob()	Blob	Récupère les données d'image sous forme de Blob.
getMapImage()	Byte[]	Récupère les données d'image brutes sous forme de tableau d'octets.
getMapUrl()	String	Récupère l'URL de l'image de la carte.
setCenter(latitude, longitude)	StaticMap	Définit le centre de la carte à l'aide d'un point (lat/lng).
setCenter(address)	StaticMap	Définit le centre de la carte à l'aide d'une adresse.
setCustomMarkerStyle(imageUrl, useShadow)	StaticMap	Définit l'image du repère personnalisé à utiliser lors de la création de nouveaux repères.
setFormat(format)	StaticMap	Définit le format de l'image de la carte.
setLanguage(language)	StaticMap	Définit la langue à utiliser pour le texte sur la carte (si disponible).
setMapType(mapType)	StaticMap	Définit le type de carte à afficher.
setMarkerStyle(size, color, label)	StaticMap	Définit le style de repère à utiliser lors de la création de repères.
setMobile(useMobileTiles)	StaticMap	Détermine si des ensembles de tuiles spécialisés pour les appareils mobiles doivent être utilisés.
setPathStyle(weight, color, fillColor)	StaticMap	Définit le style de tracé à utiliser lors de la création de tracés.
setSize(width, height)	StaticMap	Définit la largeur et la hauteur de l'image de la carte en pixels.
setZoom(zoom)	StaticMap	Définit le facteur de zoom ou le niveau d'agrandissement utilisé pour la carte.

Documentation détaillée

addAddress(address)

Ajoute une adresse à la définition actuelle du chemin.

// Creates a map and adds a path from New York to Boston.
var map = Maps.newStaticMap()
    .beginPath()
    .addAddress('New York, NY')
    .addAddress('Boston, MA')
    .endPath();

Paramètres

Nom	Type	Description
address	String	Adresse à ajouter.

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

---

addMarker(latitude, longitude)

Ajoute un repère sur la carte à l'aide d'un point (lat/lng).

// Creates a map and adds a marker at the specified coordinates.
var map = Maps.newStaticMap().addMarker(40.741799, -74.004207);

Paramètres

Nom	Type	Description
latitude	Number	Latitude du nouveau repère.
longitude	Number	Longitude du nouveau repère.

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

Voir aussi

• API Google Static Maps

---

addMarker(address)

Ajoute un repère sur la carte à l'aide d'une adresse.

// Creates a map and adds a marker at the specified address.
var map = Maps.newStaticMap().addMarker('76 9th Ave, New York NY');

Paramètres

Nom	Type	Description
address	String	Adresse où placer le nouveau repère.

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

Voir aussi

• API Google Static Maps

---

addPath(points)

Ajoute un trajet sur la carte à l'aide d'un tableau de points.

// Creates a map and adds a path from New York to Boston.
var map = Maps.newStaticMap()
    .addPath([40.714353, -74.005973, 42.358431, -71.059773]);

Paramètres

Nom	Type	Description
points	Number[]	Tableau de paires latitude/longitude qui définissent le tracé.

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

---

addPath(polyline)

Ajoute un tracé à la carte à l'aide d'une polyligne encodée.

// Creates a map and adds a path from New York to Boston.
var polyline = Maps.encodePolyline([40.714353, -74.005973, 42.358431, -71.059773]);
var map = Maps.newStaticMap().addPath(polyline);

Paramètres

Nom	Type	Description
polyline	String	Polyligne encodée.

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

---

addPoint(latitude, longitude)

Ajoute un nouveau point (lat/lng) à la définition actuelle du tracé.

// Creates a map and adds a path from New York to Boston.
var map = Maps.newStaticMap()
    .beginPath()
    .addPoint(40.714353, -74.005973)
    .addPoint(42.358431, -71.059773)
    .endPath();

Paramètres

Nom	Type	Description
latitude	Number	Latitude du point.
longitude	Number	Longitude du point.

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

---

addVisible(latitude, longitude)

Ajoute un point (lat/lng) qui doit être visible sur la carte.

// Creates a map where New York and Boston are visible.
var map = Maps.newStaticMap()
    .addVisible(40.714353, -74.005973);
    .addVisible(42.358431, -71.059773)

Paramètres

Nom	Type	Description
latitude	Number	Latitude du point.
longitude	Number	Longitude du point.

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

Voir aussi

• API Google Static Maps

---

addVisible(address)

Ajoute une adresse qui doit être visible sur la carte.

// Creates a map where New York and Boston are visible.
var map = Maps.newStaticMap()
    .addVisible('New York, NY')
    .addVisible('Boston, MA');

Paramètres

Nom	Type	Description
address	String	Adresse qui doit être visible sur la carte.

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

Voir aussi

• API Google Static Maps

---

beginPath()

Démarre une nouvelle définition de chemin. Les appels à addAddress() et addPoint() définissent chaque nouveau sommet du chemin. Le chemin d'accès est terminé lorsque endPath() est appelé.

// Creates a map and adds a path from New York to Boston.
var map = Maps.newStaticMap()
    .beginPath()
    .addAddress('New York, NY')
    .addAddress('Boston, MA')
    .endPath();

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

---

clearMarkers()

Efface l'ensemble de repères actuel.

var map = Maps.newStaticMap();
// ...
// Do something interesting here ...
// ...
// Remove all markers on the map.
map.clearMarkers();

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

---

clearPaths()

Effacez l'ensemble actuel de chemins d'accès.

var map = Maps.newStaticMap();
// ...
// Do something interesting here ...
// ...
// Remove all paths on the map.
map.clearPaths();

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

---

clearVisibles()

Efface l'ensemble actuel de lieux visibles.

var map = Maps.newStaticMap();
// ...
// Do something interesting here ...
// ...
// Remove all visible locations created with addVisible().
map.clearVisibles();

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

---

endPath()

Termine une définition de chemin commencée parbeginPath().

// Creates a map and adds a path from New York to Boston.
var map = Maps.newStaticMap()
    .beginPath()
    .addAddress('New York, NY')
    .addAddress('Boston, MA')
    .endPath();

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

---

getAs(contentType)

Renvoie les données contenues dans cet objet sous forme d'objet blob converti dans le type de contenu spécifié. Cette méthode ajoute l'extension appropriée au nom de fichier (par exemple, "myfile.pdf"). Cependant, nous supposons que la partie du nom de fichier qui suit le dernier point (le cas échéant) est une extension existante qui doit être remplacée. Par conséquent, "ShoppingList.12.25.2014" devient "ShoppingList.12.25.pdf".

Pour connaître les quotas quotidiens de conversions, consultez la page Quotas pour les services Google. Les domaines Google Workspace nouvellement créés peuvent être temporairement soumis à des quotas plus stricts.

Paramètres

Nom	Type	Description
contentType	String	Type MIME vers lequel effectuer la conversion. Pour la plupart des blobs, 'application/pdf' est la seule option valide. Pour les images au format BMP, GIF, JPEG ou PNG, 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' sont également valides.

Renvois

Blob : données sous forme de blob.

---

getBlob()

Récupère les données d'image sous forme de Blob.

// Creates a map centered on Times Square and saves it to Google Drive.
var map = Maps.newStaticMap().setCenter('Times Square, New York, NY');
DocsList.createFile(map);  // You can call map.getBlob() explicitly or use it
                           // implicitly by passing the map where a blob is expected.

Renvois

Blob : image de la carte au format d'image sélectionné.

---

getMapImage()

Récupère les données d'image brutes sous forme de tableau d'octets.

En général, il est préférable d'utiliser getBlob(), qui permet des interactions plus simples avec d'autres services.

// Creates a map centered on Times Square and saves it to Google Drive.
var map = Maps.newStaticMap().setCenter('Times Square, New York, NY');
DocsList.createFile(Utilities.newBlob(map.getMapImage(), 'image/png', 'map.png'));

Renvois

Byte[] : image de la carte au format d'image sélectionné.

---

getMapUrl()

Récupère l'URL de l'image de la carte.

// Creates a map centered on Times Square and gets the URL.
var map = Maps.newStaticMap().setCenter('Times Square, New York, NY');
// All static map URLs require an API key.
Logger.log(map.getMapUrl() + "&key=YOUR_API_KEY");

Renvois

String : URL : URL de l'image de la carte.

---

setCenter(latitude, longitude)

Définit le centre de la carte à l'aide d'un point (lat/lng).

// Creates a map centered on Times Square, using its coordinates.
var map = Maps.newStaticMap().setCenter(40.759011, -73.984472);

Paramètres

Nom	Type	Description
latitude	Number	Latitude du centre.
longitude	Number	Longitude du centre.

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

Voir aussi

• API Google Static Maps

---

setCenter(address)

Définit le centre de la carte à l'aide d'une adresse.

// Creates a map centered on Times Square, using its address.
var map = Maps.newStaticMap().setCenter('Times Square, New York, NY');

Paramètres

Nom	Type	Description
address	String	Adresse du centre.

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

Voir aussi

• API Google Static Maps

---

setCustomMarkerStyle(imageUrl, useShadow)

Définit l'image du repère personnalisé à utiliser lors de la création de nouveaux repères. Les repères déjà ajoutés ne sont pas affectés.

// Creates a map with markers set to be medium sized, black, and labeled with the number "1".
var map = Maps.newStaticMap()
    .setCustomMarkerStyle('http://www.example.com/marker.png', false);

Paramètres

Nom	Type	Description
imageUrl	String	Spécifie une URL à utiliser comme icône personnalisée du repère. Les images peuvent être au format PNG, JPEG ou GIF, mais le format PNG est recommandé.
useShadow	Boolean	Indique que le repère doit générer une ombre, en fonction de la zone visible de l'image et de son opacité/transparence.

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

Voir aussi

• API Google Static Maps

---

setFormat(format)

Définit le format de l'image de la carte.

// Creates a map with the image format set to PNG.
var map = Maps.newStaticMap().setFormat(Maps.StaticMap.Format.PNG);

Paramètres

Nom	Type	Description
format	String	Valeur constante de Format.

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

Voir aussi

• API Google Static Maps

---

setLanguage(language)

Définit la langue à utiliser pour le texte sur la carte (si disponible).

// Creates a map with the language set to French.
var map = Maps.newStaticMap().setLanguage('fr');

Paramètres

Nom	Type	Description
language	String	Identifiant de langue BCP-47.

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

Voir aussi

• Langues acceptées dans les API Google Maps

---

setMapType(mapType)

Définit le type de carte à afficher.

// Creates a satellite map.
var map = Maps.newStaticMap().setMapType(Maps.StaticMap.Type.SATELLITE);

Paramètres

Nom	Type	Description
mapType	String	Valeur constante de Type.

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

Voir aussi

• API Google Static Maps

---

setMarkerStyle(size, color, label)

Définit le style de repère à utiliser lors de la création de repères. Les repères déjà ajoutés ne sont pas affectés.

// Creates a map with markers set to be medium sized, black, and labeled with the number "1".
var map = Maps.newStaticMap()
    .setMarkerStyle(Maps.StaticMap.MarkerSize.MID, Maps.StaticMap.Color.BLACK , '1');

Paramètres

Nom	Type	Description
size	String	Valeur constante de MarkerSize.
color	String	Chaîne au format "0xrrggbb" ou valeur constante de Color.
label	String	Chaîne ne contenant qu'un seul caractère de A à Z ou de 0 à 9.

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

Voir aussi

• API Google Static Maps

---

setMobile(useMobileTiles)

Détermine si des ensembles de tuiles spécialisés pour les appareils mobiles doivent être utilisés.

// Creates a map that uses mobile-friendly tiles.
var map = Maps.newStaticMap().setMobile(true);

Paramètres

Nom	Type	Description
useMobileTiles	Boolean	Indique si les tuiles mobiles doivent être utilisées.

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

---

setPathStyle(weight, color, fillColor)

Définit le style de tracé à utiliser lors de la création de tracés. Les chemins d'accès déjà ajoutés ne sont pas affectés.

// Creates a map with paths set to be 1 pixel wide with a black line and a white fill.
var map = Maps.newStaticMap()
    .setPathStyle(1, Maps.StaticMap.Color.BLACK , 'red');

Paramètres

Nom	Type	Description
weight	Integer	L'épaisseur des lignes en pixels.
color	String	Couleur de la ligne, sous forme de chaîne au format "0xrrggbb" ou d'une valeur constante de Color.
fillColor	String	Couleur de remplissage, une chaîne au format "0xrrggbb" ou une valeur constante de Color.

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

Voir aussi

• API Google Static Maps

---

setSize(width, height)

Définit la largeur et la hauteur de l'image de la carte en pixels.

// Creates a map 400px wide by 300px high.
var map = Maps.newStaticMap().setSize(400, 300);

Paramètres

Nom	Type	Description
width	Integer	Largeur de l'image en pixels.
height	Integer	Hauteur de l'image en pixels.

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

Voir aussi

• API Google Static Maps

---

setZoom(zoom)

Définit le facteur de zoom ou le niveau d'agrandissement utilisé pour la carte.

// Creates a map with a zoom factor of 10.
var map = Maps.newStaticMap().setZoom(10);

Paramètres

Nom	Type	Description
zoom	Integer	Une valeur comprise entre 0 et 21 inclus.

Renvois

StaticMap : instance de carte utilisée pour le chaînage.

Voir aussi

• API Google Static Maps