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 New York City Theatre. y compris les gares à proximité, puis affichez-les dans une simple application Web.

// 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

Méthodes

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

Documentation détaillée

addAddress(address)

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

// 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

NomTypeDescription
addressStringAdresse à ajouter.

Renvois

StaticMap : instance de mappage, pour le chaînage.


addMarker(latitude, longitude)

Ajoute un repère sur la carte en utilisant 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

NomTypeDescription
latitudeNumberLatitude du nouveau repère.
longitudeNumberLongitude du nouveau repère.

Renvois

StaticMap : instance de mappage, pour le chaînage.

Voir aussi


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

NomTypeDescription
addressStringAdresse à laquelle placer le nouveau repère.

Renvois

StaticMap : instance de mappage, pour le chaînage.

Voir aussi


addPath(points)

Ajoute un tracé à la carte en utilisant 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

NomTypeDescription
pointsNumber[]Tableau de paires latitude/longitude définissant le trajet.

Renvois

StaticMap : instance de mappage, 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

NomTypeDescription
polylineStringPolyligne encodée.

Renvois

StaticMap : instance de mappage, 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

NomTypeDescription
latitudeNumberLatitude du point.
longitudeNumberLongitude du point.

Renvois

StaticMap : instance de mappage, 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

NomTypeDescription
latitudeNumberLatitude du point.
longitudeNumberLongitude du point.

Renvois

StaticMap : instance de mappage, pour le chaînage.

Voir aussi


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

NomTypeDescription
addressStringAdresse qui doit être visible sur la carte.

Renvois

StaticMap : instance de mappage, pour le chaînage.

Voir aussi


beginPath()

Démarre une nouvelle définition de chemin. Les appels à addAddress() et addPoint() définissent chacun un nouveau sommet dans le 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 mappage, pour le chaînage.


clearMarkers()

Efface l'ensemble actuel de repères.

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

Renvois

StaticMap : instance de mappage, pour le chaînage.


clearPaths()

Effacer l'ensemble de chemins actuel.

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

Renvois

StaticMap : instance de mappage, pour le chaînage.


clearVisibles()

Efface l'ensemble des lieux visibles actuels.

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

Renvois

StaticMap : instance de mappage, pour le chaînage.


endPath()

Achèvement une définition de chemin démarré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 mappage, pour le chaînage.


getAs(contentType)

Renvoyez les données contenues dans cet objet sous la forme d'un blob converti dans le type de contenu spécifié. Ce ajoute l'extension appropriée au nom du fichier (par exemple, "myfile.pdf"). Cependant, il suppose que la partie du nom de fichier qui suit le dernier point (le cas échéant) est une à remplacer. Par conséquent, "ShoppingList.12.25.2014" devient "ShoppingList.12.25.pdf".

Pour connaître les quotas quotidiens de conversion, consultez la page Quotas Services. Les domaines Google Workspace nouvellement créés peuvent être temporairement soumis à des règles des quotas.

Paramètres

NomTypeDescription
contentTypeStringType MIME vers lequel effectuer la conversion. Pour la plupart des blobs, 'application/pdf' correspond à 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' le sont également. valide. 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 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 sélectionné.


getMapImage()

Récupère les données brutes de l'image sous la forme d'un 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 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

NomTypeDescription
latitudeNumberLatitude du centre.
longitudeNumberLongitude du centre.

Renvois

StaticMap : instance de mappage, pour le chaînage.

Voir aussi


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

NomTypeDescription
addressStringAdresse du centre.

Renvois

StaticMap : instance de mappage, pour le chaînage.

Voir aussi


setCustomMarkerStyle(imageUrl, useShadow)

Définit l'image du repère personnalisé à utiliser lors de la création de repères. Les repères qui ont déjà été ne sont pas concernées.

// 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

NomTypeDescription
imageUrlStringSpécifie une URL à utiliser comme icône personnalisée du repère. Les images peuvent être au format PNG ou JPEG. ou GIF, mais le format PNG est recommandé.
useShadowBooleanIndique que le repère doit avoir une ombre générée en fonction de l'image visible et son opacité/transparence.

Renvois

StaticMap : instance de mappage, pour le chaînage.

Voir aussi


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

NomTypeDescription
formatStringValeur constante de Format.

Renvois

StaticMap : instance de mappage, pour le chaînage.

Voir aussi


setLanguage(language)

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

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

Paramètres

NomTypeDescription
languageStringIdentifiant de langue BCP-47.

Renvois

StaticMap : instance de mappage, pour le chaînage.

Voir aussi


setMapType(mapType)

Définit le type de carte à afficher.

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

Paramètres

NomTypeDescription
mapTypeStringValeur constante de Type.

Renvois

StaticMap : instance de mappage, pour le chaînage.

Voir aussi


setMarkerStyle(size, color, label)

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

// 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

NomTypeDescription
sizeStringValeur constante de MarkerSize.
colorStringUne chaîne au format "0xrrggbb" ou une valeur constante de Color.
labelStringChaîne qui ne contient qu'un seul caractère (A-Z ou 0-9).

Renvois

StaticMap : instance de mappage, pour le chaînage.

Voir aussi


setMobile(useMobileTiles)

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

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

Paramètres

NomTypeDescription
useMobileTilesBooleanUtiliser ou non des tuiles mobiles.

Renvois

StaticMap : instance de mappage, pour le chaînage.


setPathStyle(weight, color, fillColor)

Définit le style de tracé à utiliser lors de la création des tracés. Les chemins d'accès qui ont déjà été ajoutés ne sont pas concerné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

NomTypeDescription
weightIntegerLargeur des lignes, en pixels.
colorStringCouleur de la ligne, sous forme de chaîne au format "0xrrggbb" ou une valeur constante Color
fillColorStringCouleur de remplissage, une chaîne au format "0xrrggbb" ou une valeur constante Color

Renvois

StaticMap : instance de mappage, pour le chaînage.

Voir aussi


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

NomTypeDescription
widthIntegerLargeur de l'image en pixels.
heightIntegerHauteur de l'image en pixels.

Renvois

StaticMap : instance de mappage, pour le chaînage.

Voir aussi


setZoom(zoom)

Définit le facteur de zoom, ou niveau de grossissement, utilisé pour la carte.

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

Paramètres

NomTypeDescription
zoomIntegerValeur comprise entre 0 et 21 inclus.

Renvois

StaticMap : instance de mappage, pour le chaînage.

Voir aussi