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 de New York, y compris les gares à proximité, et l'afficher dans une application Web simple.

// Create a map centered on Times Square.
const 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.
const 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 (let i = 0; i < corners.length; i++) {
  map.addAddress(corners[i]);
}
// All static map URLs require an API key.
const 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 du chemin actuel.
addMarker(latitude, longitude)	StaticMap	Ajoute un repère à la carte à l'aide d'un point (lat/lng).
addMarker(address)	StaticMap	Ajoute un repère à la carte à l'aide d'une adresse.
addPath(points)	StaticMap	Ajoute un tracé à la carte à l'aide d'un tableau de points.
addPath(polyline)	StaticMap	Ajoute un chemin à la carte à l'aide d'une polyligne encodée.
addPoint(latitude, longitude)	StaticMap	Ajoute un nouveau point (lat/lng) à la définition du parcours actuel.
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 actuel de repères.
clearPaths()	StaticMap	Efface l'ensemble de chemins actuel.
clearVisibles()	StaticMap	Efface l'ensemble actuel des lieux visibles.
endPath()	StaticMap	Termine une définition de tracé commencée avec beginPath().
getAs(contentType)	Blob	Renvoie les données de cet objet sous forme de blob converti au type de contenu spécifié.
getBlob()	Blob	Récupère les données d'image en tant que Blob.
getMapImage()	Byte[]	Récupère les données d'image brutes sous la forme d'un 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 (latitude/longitude).
setCenter(address)	StaticMap	Définit le centre de la carte à l'aide d'une adresse.
setCustomMarkerStyle(imageUrl, useShadow)	StaticMap	Définit l'image de repère personnalisée à utiliser lors de la création de 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 (le cas échéant).
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	Indique si des ensembles de cartes spécialisés doivent être utilisés pour les appareils mobiles.
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 du chemin actuel.

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

Paramètres

Nom	Type	Description
address	String	Une adresse à ajouter.

Renvois

StaticMap : cette instance de carte, pour le chaînage.

---

addMarker(latitude, longitude)

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

// Creates a map and adds a marker at the specified coordinates.
const 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 : cette instance de carte, pour le chaînage.

Voir aussi

• API Google Static Maps

---

addMarker(address)

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

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

Paramètres

Nom	Type	Description
address	String	Adresse à laquelle placer le nouveau repère.

Renvois

StaticMap : cette instance de carte, pour le chaînage.

Voir aussi

• API Google Static Maps

---

addPath(points)

Ajoute un tracé à la carte à l'aide d'un tableau de points.

// Creates a map and adds a path from New York to Boston.
const 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 : cette instance de carte, pour le chaînage.

---

addPath(polyline)

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

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

Paramètres

Nom	Type	Description
polyline	String	Polyligne encodée.

Renvois

StaticMap : cette instance de carte, pour le chaînage.

---

addPoint(latitude, longitude)

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

// Creates a map and adds a path from New York to Boston.
const 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 : cette instance de carte, 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.
const 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 : cette instance de carte, 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.
const 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 : cette instance de carte, 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 est terminé lorsque endPath() est appelé.

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

Renvois

StaticMap : cette instance de carte, pour le chaînage.

---

clearMarkers()

Efface l'ensemble actuel de repères.

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

Renvois

StaticMap : cette instance de carte, pour le chaînage.

---

clearPaths()

Efface l'ensemble de chemins actuel.

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

Renvois

StaticMap : cette instance de carte, pour le chaînage.

---

clearVisibles()

Efface l'ensemble actuel des lieux visibles.

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

Renvois

StaticMap : cette instance de carte, pour le chaînage.

---

endPath()

Termine une définition de tracé commencée avec beginPath().

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

Renvois

StaticMap : cette instance de carte, pour le chaînage.

---

getAs(contentType)

Renvoie les données de cet objet sous forme de blob converti au type de contenu spécifié. Cette méthode ajoute l'extension appropriée au nom de fichier (par exemple, "monfichier.pdf"). Toutefois, il suppose 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 afficher les quotas quotidiens pour les conversions, consultez la section Quotas pour les services Google. Les nouveaux domaines Google Workspace 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, les valeurs 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' sont également valides. Pour un document Google Docs, 'text/markdown' est également valide.

Renvois

Blob : données sous forme de blob.

---

getBlob()

Récupère les données d'image en tant que Blob.

// Creates a map centered on Times Square and saves it to Google Drive.
const map = Maps.newStaticMap().setCenter('Times Square, New York, NY');
DriveApp.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 la forme d'un tableau d'octets.

En général, privilégiez getBlob(), qui permet des interactions plus simples avec d'autres services.

// Creates a map centered on Times Square and saves it to Google Drive.
const map = Maps.newStaticMap().setCenter('Times Square, New York, NY');
DriveApp.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.
const 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 (latitude/longitude).

// Creates a map centered on Times Square, using its coordinates.
const 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 : cette instance de carte, 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.
const map = Maps.newStaticMap().setCenter('Times Square, New York, NY');

Paramètres

Nom	Type	Description
address	String	Adresse du centre.

Renvois

StaticMap : cette instance de carte, pour le chaînage.

Voir aussi

• API Google Static Maps

---

setCustomMarkerStyle(imageUrl, useShadow)

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

// Creates a map with markers set to be medium sized, black, and labeled with
// the number "1".
const 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 qu'une ombre doit être générée pour le repère, en fonction de la région visible de l'image et de son opacité/transparence.

Renvois

StaticMap : cette instance de carte, 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.
const map = Maps.newStaticMap().setFormat(Maps.StaticMap.Format.PNG);

Paramètres

Nom	Type	Description
format	String	Valeur constante de Format.

Renvois

StaticMap : cette instance de carte, pour le chaînage.

Voir aussi

• API Google Static Maps

---

setLanguage(language)

Définit la langue à utiliser pour le texte sur la carte (le cas échéant).

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

Paramètres

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

Renvois

StaticMap : cette instance de carte, pour le chaînage.

Voir aussi

• Compatibilité des API Google Maps avec les langues

---

setMapType(mapType)

Définit le type de carte à afficher.

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

Paramètres

Nom	Type	Description
mapType	String	Valeur constante de Type.

Renvois

StaticMap : cette instance de carte, 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 concernés.

// Creates a map with markers set to be medium sized, black, and labeled with
// the number "1".
const 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 à partir de Color.
label	String	Chaîne contenant un seul caractère de A à Z ou de 0 à 9.

Renvois

StaticMap : cette instance de carte, pour le chaînage.

Voir aussi

• API Google Static Maps

---

setMobile(useMobileTiles)

Indique si des ensembles de cartes spécialisés doivent être utilisés pour les appareils mobiles.

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

Paramètres

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

Renvois

StaticMap : cette instance de carte, 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é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.
const map = Maps.newStaticMap().setPathStyle(
    1,
    Maps.StaticMap.Color.BLACK,
    'red',
);

Paramètres

Nom	Type	Description
weight	Integer	Largeur des lignes en pixels.
color	String	Couleur de la ligne, au format chaîne "0xrrggbb" ou valeur constante à partir de Color.
fillColor	String	Couleur de remplissage, chaîne au format "0xrrggbb" ou valeur constante de Color.

Renvois

StaticMap : cette instance de carte, 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.
const 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 : cette instance de carte, 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.
const map = Maps.newStaticMap().setZoom(10);

Paramètres

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

Renvois

StaticMap : cette instance de carte, pour le chaînage.

Voir aussi

• API Google Static Maps