Class StaticMap

StaticMap

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

O exemplo abaixo mostra como usar essa classe para criar um mapa do distrito de teatros de Nova York, incluindo estações de trem próximas, e exibi-lo em um app da Web simples.

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

Consulte também

Métodos

MétodoTipo de retornoBreve descrição
addAddress(address)StaticMapAdiciona um novo endereço à definição de caminho atual.
addMarker(latitude, longitude)StaticMapAdiciona um marcador ao mapa usando um ponto (lat/lng).
addMarker(address)StaticMapAdiciona um marcador ao mapa usando um endereço.
addPath(points)StaticMapAdiciona um caminho ao mapa usando uma matriz de pontos.
addPath(polyline)StaticMapAdiciona um caminho ao mapa usando uma polilinha codificada.
addPoint(latitude, longitude)StaticMapAdiciona um novo ponto (lat/lng) à definição de caminho atual.
addVisible(latitude, longitude)StaticMapAdiciona um local de ponto (lat/lng) que precisa estar visível no mapa.
addVisible(address)StaticMapAdiciona um local de endereço que precisa estar visível no mapa.
beginPath()StaticMapInicia uma nova definição de caminho.
clearMarkers()StaticMapLimpa o conjunto atual de marcadores.
clearPaths()StaticMapLimpe o conjunto atual de caminhos.
clearVisibles()StaticMapLimpa o conjunto atual de locais visíveis.
endPath()StaticMapConclui uma definição de caminho iniciada com beginPath().
getAs(contentType)BlobRetorna os dados dentro deste objeto como um blob convertido para o tipo de conteúdo especificado.
getBlob()BlobRecebe os dados da imagem como um Blob.
getMapImage()Byte[]Recebe os dados da imagem bruta como uma matriz de bytes.
getMapUrl()StringRecebe o URL da imagem do mapa.
setCenter(latitude, longitude)StaticMapDefine o centro do mapa usando um ponto (lat/lng).
setCenter(address)StaticMapDefine o centro do mapa usando um endereço.
setCustomMarkerStyle(imageUrl, useShadow)StaticMapDefine a imagem do marcador personalizado a ser usada na criação de novos marcadores.
setFormat(format)StaticMapDefine o formato da imagem do mapa.
setLanguage(language)StaticMapDefine o idioma a ser usado para o texto no mapa (quando disponível).
setMapType(mapType)StaticMapDefine o tipo de mapa a ser mostrado.
setMarkerStyle(size, color, label)StaticMapDefine o estilo de marcador a ser usado ao criar novos marcadores.
setMobile(useMobileTiles)StaticMapDefine se os conjuntos de blocos especializados serão usados ou não para dispositivos móveis.
setPathStyle(weight, color, fillColor)StaticMapDefine o estilo de caminho a ser usado ao criar novos caminhos.
setSize(width, height)StaticMapDefine a largura e a altura da imagem do mapa em pixels.
setZoom(zoom)StaticMapDefine o fator de zoom ou o nível de ampliação usado no 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.
const map = Maps.newStaticMap()
                .beginPath()
                .addAddress('New York, NY')
                .addAddress('Boston, MA')
                .endPath();

Parâmetros

NomeTipoDescrição
addressStringUm 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.
const map = Maps.newStaticMap().addMarker(40.741799, -74.004207);

Parâmetros

NomeTipoDescrição
latitudeNumberA latitude do novo marcador.
longitudeNumberA longitude do novo marcador.

Retornar

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

Consulte também


addMarker(address)

Adiciona um marcador ao mapa usando um endereço.

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

Parâmetros

NomeTipoDescrição
addressStringO endereço em que o novo marcador será colocado.

Retornar

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

Consulte também


addPath(points)

Adiciona um caminho ao mapa usando uma matriz de pontos.

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

Parâmetros

NomeTipoDescrição
pointsNumber[]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.
const polyline = Maps.encodePolyline([
  40.714353,
  -74.005973,
  42.358431,
  -71.059773,
]);
const map = Maps.newStaticMap().addPath(polyline);

Parâmetros

NomeTipoDescrição
polylineStringUma polilinha codificada.

Retornar

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


addPoint(latitude, longitude)

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

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

Parâmetros

NomeTipoDescrição
latitudeNumberA latitude do ponto.
longitudeNumberA longitude do ponto.

Retornar

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


addVisible(latitude, longitude)

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

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

Parâmetros

NomeTipoDescrição
latitudeNumberA latitude do ponto.
longitudeNumberA longitude do ponto.

Retornar

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

Consulte também


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.
const map =
    Maps.newStaticMap().addVisible('New York, NY').addVisible('Boston, MA');

Parâmetros

NomeTipoDescrição
addressStringUm endereço que precisa estar visível no mapa.

Retornar

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

Consulte também


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.
const 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.

const 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()

Limpe o conjunto atual de caminhos.

const 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.

const 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()

Conclui uma definição de caminho iniciada com 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();

Retornar

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


getAs(contentType)

Retorna os dados dentro deste objeto como um blob convertido para o tipo de conteúdo especificado. Esse método adiciona a extensão apropriada ao nome do arquivo, por exemplo, "myfile.pdf". No entanto, ele pressupõe que a parte do nome do arquivo que segue o último ponto (se houver) é uma extensão existente que precisa ser substituída. Consequentemente, "ShoppingList.12.25.2014" se torna "ShoppingList.12.25.pdf".

Para conferir as cotas diárias de conversões, consulte Cotas dos Serviços do Google. Os domínios do Google Workspace recém-criados podem estar temporariamente sujeitos a cotas mais rígidas.

Parâmetros

NomeTipoDescrição
contentTypeStringO tipo MIME para a conversão. Para a maioria dos blobs, 'application/pdf' é a única opção válida. Para imagens nos formatos BMP, GIF, JPEG ou PNG, qualquer um dos formatos 'image/bmp', 'image/gif', 'image/jpeg' ou 'image/png' também é válido. 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.
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.

Retornar

Blob: uma imagem do mapa no formato selecionado.


getMapImage()

Recebe os dados da imagem bruta 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.
const map = Maps.newStaticMap().setCenter('Times Square, New York, NY');
DriveApp.createFile(
    Utilities.newBlob(map.getMapImage(), 'image/png', 'map.png'),
);

Retornar

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


getMapUrl()

Recebe o URL da imagem do mapa.

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

Retornar

String: 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.
const map = Maps.newStaticMap().setCenter(40.759011, -73.984472);

Parâmetros

NomeTipoDescrição
latitudeNumberA latitude do centro.
longitudeNumberA longitude do centro.

Retornar

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

Consulte também


setCenter(address)

Define o centro do mapa usando um endereço.

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

Parâmetros

NomeTipoDescrição
addressStringO endereço do centro.

Retornar

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

Consulte também


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 são afetados.

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

Parâmetros

NomeTipoDescrição
imageUrlStringEspecifica um URL a ser usado como ícone personalizado do marcador. As imagens podem estar nos formatos PNG, JPEG ou GIF, mas PNG é o formato recomendado.
useShadowBooleanIndica que o marcador precisa ter uma sombra gerada com base na região visível da imagem e na sua opacidade/transparência.

Retornar

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

Consulte também


setFormat(format)

Define o formato da imagem do mapa.

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

Parâmetros

NomeTipoDescrição
formatStringUm valor constante de Format.

Retornar

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

Consulte também


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.
const map = Maps.newStaticMap().setLanguage('fr');

Parâmetros

NomeTipoDescrição
languageStringUm identificador de idioma BCP-47.

Retornar

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

Consulte também


setMapType(mapType)

Define o tipo de mapa a ser mostrado.

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

Parâmetros

NomeTipoDescrição
mapTypeStringUm valor constante de Type.

Retornar

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

Consulte também


setMarkerStyle(size, color, label)

Define o estilo de marcador a ser usado ao criar novos marcadores. Os marcadores que já foram adicionados não são afetados.

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

Parâmetros

NomeTipoDescrição
sizeStringUm valor constante de MarkerSize.
colorStringUma string no formato "0xrrggbb" ou um valor constante de Color.
labelStringUma string que contém um único caractere A-Z ou 0-9.

Retornar

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

Consulte também


setMobile(useMobileTiles)

Define se os conjuntos de blocos especializados serão usados ou não para dispositivos móveis.

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

Parâmetros

NomeTipoDescrição
useMobileTilesBooleanIndica se os Blocos para dispositivos móveis serão usados ou não.

Retornar

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


setPathStyle(weight, color, fillColor)

Define o estilo de caminho a ser usado ao criar novos caminhos. Os caminhos que já foram adicionados não são afetados.

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

Parâmetros

NomeTipoDescrição
weightIntegerA largura das linhas em pixels.
colorStringA cor da linha, como uma string no formato "0xrrggbb" ou um valor constante de Color.
fillColorStringA 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


setSize(width, height)

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

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

Parâmetros

NomeTipoDescrição
widthIntegerA largura da imagem, em pixels.
heightIntegerA altura da imagem, em pixels.

Retornar

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

Consulte também


setZoom(zoom)

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

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

Parâmetros

NomeTipoDescrição
zoomIntegerUm valor de zero a 21.

Retornar

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

Consulte também