Class StaticMap

StaticMap

Permite a criação e a decoração de imagens estáticas de mapas.

O exemplo abaixo mostra como você pode usar essa classe para criar um mapa do New York City's Theatre Distrito, incluindo estações de trem próximas, e mostrar as informações em um app da Web simples.

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

Consulte também

• API Google Static Maps

Métodos

Método	Tipo de retorno	Breve descrição
addAddress(address)	StaticMap	Adiciona um novo endereço à definição de caminho atual.
addMarker(latitude, longitude)	StaticMap	Adiciona um marcador ao mapa usando um ponto (lat/lng).
addMarker(address)	StaticMap	Adiciona um marcador ao mapa usando um endereço.
addPath(points)	StaticMap	Adiciona um caminho ao mapa usando uma matriz de pontos.
addPath(polyline)	StaticMap	Adiciona um caminho ao mapa usando uma polilinha codificada.
addPoint(latitude, longitude)	StaticMap	Adiciona um novo ponto (lat/lng) à definição do caminho atual.
addVisible(latitude, longitude)	StaticMap	Adiciona um local de ponto (lat/lng) que deve estar visível no mapa.
addVisible(address)	StaticMap	Adiciona um local de endereço que precisa estar visível no mapa.
beginPath()	StaticMap	Inicia uma nova definição de caminho.
clearMarkers()	StaticMap	Limpa o conjunto atual de marcadores.
clearPaths()	StaticMap	Limpa o conjunto atual de caminhos.
clearVisibles()	StaticMap	Limpa o conjunto atual de locais visíveis.
endPath()	StaticMap	Completa uma definição de caminho iniciada com beginPath().
getAs(contentType)	Blob	Retorna os dados dentro desse objeto como um blob convertido no tipo de conteúdo especificado.
getBlob()	Blob	Recebe os dados da imagem como um Blob.
getMapImage()	Byte[]	Recebe os dados brutos de imagem como uma matriz de bytes.
getMapUrl()	String	Extrai o URL da imagem do mapa.
setCenter(latitude, longitude)	StaticMap	Define o centro do mapa usando um ponto (lat/lng).
setCenter(address)	StaticMap	Define o centro do mapa usando um endereço.
setCustomMarkerStyle(imageUrl, useShadow)	StaticMap	Define a imagem do marcador personalizado a ser usada na criação de novos marcadores.
setFormat(format)	StaticMap	Define o formato da imagem do mapa.
setLanguage(language)	StaticMap	Define o idioma a ser usado para o texto no mapa (quando disponível).
setMapType(mapType)	StaticMap	Define o tipo de mapa a ser mostrado.
setMarkerStyle(size, color, label)	StaticMap	Define o estilo do marcador a ser usado na criação de novos marcadores.
setMobile(useMobileTiles)	StaticMap	Define se deve ou não usar conjuntos de blocos especializados para dispositivos móveis.
setPathStyle(weight, color, fillColor)	StaticMap	Define o estilo do caminho a ser usado na criação de novos caminhos.
setSize(width, height)	StaticMap	Define a largura e a altura da imagem do mapa em pixels.
setZoom(zoom)	StaticMap	Define o fator de zoom, ou nível de ampliação, usado para o mapa.

Documentação detalhada

addAddress(address)

Adiciona um novo endereço à definição de caminho atual.

// 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();

Parâmetros

Nome	Tipo	Descrição
address	String	Um endereço a ser adicionado.

Retornar

StaticMap: esta instância de mapa, para encadeamento.

---

addMarker(latitude, longitude)

Adiciona um marcador ao mapa usando um ponto (lat/lng).

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

Parâmetros

Nome	Tipo	Descrição
latitude	Number	A latitude do novo marcador.
longitude	Number	A longitude do novo marcador.

Retornar

StaticMap: esta instância de mapa, para encadeamento.

Consulte também

• API Google Static Maps

---

addMarker(address)

Adiciona um marcador ao mapa usando um endereço.

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

Parâmetros

Nome	Tipo	Descrição
address	String	O endereço em que o novo marcador será colocado.

Retornar

StaticMap: esta instância de mapa, para encadeamento.

Consulte também

• API Google Static Maps

---

addPath(points)

Adiciona um caminho ao mapa usando uma matriz de pontos.

// 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]);

Parâmetros

Nome	Tipo	Descrição
points	Number[]	Uma matriz de pares de latitude/longitude que definem o caminho.

Retornar

StaticMap: esta instância de mapa, para encadeamento.

---

addPath(polyline)

Adiciona um caminho ao mapa usando uma polilinha codificada.

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

Parâmetros

Nome	Tipo	Descrição
polyline	String	Uma polilinha codificada.

Retornar

StaticMap: esta instância de mapa, para encadeamento.

---

addPoint(latitude, longitude)

Adiciona um novo ponto (lat/lng) à definição do caminho atual.

// 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();

Parâmetros

Nome	Tipo	Descrição
latitude	Number	A latitude do ponto.
longitude	Number	A longitude do ponto.

Retornar

StaticMap: esta instância de mapa, para encadeamento.

---

addVisible(latitude, longitude)

Adiciona um local de ponto (lat/lng) que deve estar visível no mapa.

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

Parâmetros

Nome	Tipo	Descrição
latitude	Number	A latitude do ponto.
longitude	Number	A longitude do ponto.

Retornar

StaticMap: esta instância de mapa, para encadeamento.

Consulte também

• API Google Static Maps

---

addVisible(address)

Adiciona um local de endereço que precisa estar visível no mapa.

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

Parâmetros

Nome	Tipo	Descrição
address	String	Um endereço que precisa estar visível no mapa.

Retornar

StaticMap: esta instância de mapa, para encadeamento.

Consulte também

• API Google Static Maps

---

beginPath()

Inicia uma nova definição de caminho. As chamadas para addAddress() e addPoint() definem cada novo vértice no caminho. O caminho é concluído quando endPath() é chamado.

// 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();

Retornar

StaticMap: esta instância de mapa, para encadeamento.

---

clearMarkers()

Limpa o conjunto atual de marcadores.

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

Retornar

StaticMap: esta instância de mapa, para encadeamento.

---

clearPaths()

Limpa o conjunto atual de caminhos.

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

Retornar

StaticMap: esta instância de mapa, para encadeamento.

---

clearVisibles()

Limpa o conjunto atual de locais visíveis.

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

Retornar

StaticMap: esta instância de mapa, para encadeamento.

---

endPath()

Completa uma definição de caminho iniciada com beginPath().

// 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();

Retornar

StaticMap: esta instância de mapa, para encadeamento.

---

getAs(contentType)

Retorna os dados dentro desse objeto como um blob convertido no tipo de conteúdo especificado. Isso adiciona a extensão adequada ao nome do arquivo, por exemplo, "myfile.pdf". No entanto, pressupõe que a parte do nome do arquivo que segue o ponto final (se houver) é uma que deve ser substituída. Consequentemente, "ShoppingList.12.25.2014" se torna "ListaShopping.12.25.pdf".

Para acessar as cotas diárias para conversões, consulte Cotas do Google Serviços. Os domínios do Google Workspace recém-criados podem estar temporariamente sujeitos a medidas cotas.

Parâmetros

Nome	Tipo	Descrição
contentType	String	O tipo MIME em que a conversão será feita. Para a maioria dos blobs, 'application/pdf' é a única opção válida. Para imagens no formato BMP, GIF, JPEG ou PNG, qualquer um dos valores 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' também precisa ser válidos. Para um documento do Documentos Google, 'text/markdown' também é válido.

Retornar

Blob: os dados como um blob.

---

getBlob()

Recebe os dados da imagem como um 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.

Retornar

Blob: uma imagem do mapa no formato de imagem selecionado.

---

getMapImage()

Recebe os dados de imagem brutos como uma matriz de bytes.

Em geral, prefira usar getBlob(), que permite interações mais simples com outros serviços.

// 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'));

Retornar

Byte[]: uma imagem do mapa no formato de imagem selecionado.

---

getMapUrl()

Extrai o URL da imagem do mapa.

// 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");

Retornar

String: URL é o URL da imagem do mapa.

---

setCenter(latitude, longitude)

Define o centro do mapa usando um ponto (lat/lng).

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

Parâmetros

Nome	Tipo	Descrição
latitude	Number	A latitude do centro.
longitude	Number	A longitude do centro.

Retornar

StaticMap: esta instância de mapa, para encadeamento.

Consulte também

• API Google Static Maps

---

setCenter(address)

Define o centro do mapa usando um endereço.

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

Parâmetros

Nome	Tipo	Descrição
address	String	O endereço do centro.

Retornar

StaticMap: esta instância de mapa, para encadeamento.

Consulte também

• API Google Static Maps

---

setCustomMarkerStyle(imageUrl, useShadow)

Define a imagem do marcador personalizado a ser usada na criação de novos marcadores. Os marcadores que já foram adicionados não serão afetados.

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

Parâmetros

Nome	Tipo	Descrição
imageUrl	String	Especifica um URL a ser usado como o ícone personalizado do marcador. As imagens podem estar em PNG e JPEG ou GIF, embora PNG seja o recomendado.
useShadow	Boolean	Indica que o marcador deve ter uma sombra gerada, com base no região visível e a opacidade/transparência dela.

Retornar

StaticMap: esta instância de mapa, para encadeamento.

Consulte também

• API Google Static Maps

---

setFormat(format)

Define o formato da imagem do mapa.

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

Parâmetros

Nome	Tipo	Descrição
format	String	Um valor constante de Format.

Retornar

StaticMap: esta instância de mapa, para encadeamento.

Consulte também

• API Google Static Maps

---

setLanguage(language)

Define o idioma a ser usado para o texto no mapa (quando disponível).

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

Parâmetros

Nome	Tipo	Descrição
language	String	Um identificador de idioma BCP-47.

Retornar

StaticMap: esta instância de mapa, para encadeamento.

Consulte também

• Suporte a idiomas nas APIs Google Maps

---

setMapType(mapType)

Define o tipo de mapa a ser mostrado.

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

Parâmetros

Nome	Tipo	Descrição
mapType	String	Um valor constante de Type.

Retornar

StaticMap: esta instância de mapa, para encadeamento.

Consulte também

• API Google Static Maps

---

setMarkerStyle(size, color, label)

Define o estilo do marcador a ser usado na criação de novos marcadores. Marcadores que já foram adicionados não serão afetados.

// 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');

Parâmetros

Nome	Tipo	Descrição
size	String	Um valor constante de MarkerSize.
color	String	Uma string no formato "0xrrggbb". ou um valor constante de Color.
label	String	Uma string que contém um único caractere de A a Z ou de 0 a 9.

Retornar

StaticMap: esta instância de mapa, para encadeamento.

Consulte também

• API Google Static Maps

---

setMobile(useMobileTiles)

Define se deve ou não usar conjuntos de blocos especializados para dispositivos móveis.

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

Parâmetros

Nome	Tipo	Descrição
useMobileTiles	Boolean	Indica se os blocos para dispositivos móveis devem ou não ser usados.

Retornar

StaticMap: esta instância de mapa, para encadeamento.

---

setPathStyle(weight, color, fillColor)

Define o estilo do caminho a ser usado na criação de novos caminhos. Os caminhos que já foram adicionados não são afetadas.

// 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');

Parâmetros

Nome	Tipo	Descrição
weight	Integer	A largura das linhas em pixels.
color	String	A cor da linha, como uma string no formato "0xrrggbb" ou um valor constante de Color:
fillColor	String	A cor de preenchimento, uma string no formato "0xrrggbb". ou um valor constante de Color:

Retornar

StaticMap: esta instância de mapa, para encadeamento.

Consulte também

• API Google Static Maps

---

setSize(width, height)

Define a largura e a altura da imagem do mapa em pixels.

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

Parâmetros

Nome	Tipo	Descrição
width	Integer	A largura da imagem, em pixels.
height	Integer	A altura da imagem, em pixels.

Retornar

StaticMap: esta instância de mapa, para encadeamento.

Consulte também

• API Google Static Maps

---

setZoom(zoom)

Define o fator de zoom, ou nível de ampliação, usado para o mapa.

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

Parâmetros

Nome	Tipo	Descrição
zoom	Integer	Um valor de 0 a 21, inclusive.

Retornar

StaticMap: esta instância de mapa, para encadeamento.

Consulte também

• API Google Static Maps