Class StaticMap

StaticMap

允许创建和装饰静态地图图片。

以下示例展示了如何使用此类创建纽约市剧院区地图（包括附近的火车站），并在简单的 Web 应用中显示该地图。 

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

另请参阅

方法

方法返回类型简介
addAddress(address)StaticMap向当前路径定义添加新地址。
addMarker(latitude, longitude)StaticMap使用点 (lat/lng) 向地图添加标记。
addMarker(address)StaticMap使用地址向地图添加标记。
addPath(points)StaticMap使用点数组向地图添加路径。
addPath(polyline)StaticMap使用编码多段线将路径添加到地图中。
addPoint(latitude, longitude)StaticMap向当前路线定义添加新点（经度/纬度）。
addVisible(latitude, longitude)StaticMap添加一个必须在地图中显示的点（经纬度）位置。
addVisible(address)StaticMap添加必须在地图中显示的地址位置。
beginPath()StaticMap开始新的路径定义。
clearMarkers()StaticMap清除当前的一组标记。
clearPaths()StaticMap清除当前的一组路径。
clearVisibles()StaticMap清除当前显示的位置集。
endPath()StaticMap完成以 beginPath() 开头的路径定义。
getAs(contentType)Blob将此对象内的数据作为转换为指定内容类型的 blob 返回。
getBlob()Blob以 Blob 的形式获取图片数据。
getMapImage()Byte[]以字节数组的形式获取原始图片数据。
getMapUrl()String获取地图图片的网址。
setCenter(latitude, longitude)StaticMap使用点（纬度/经度）设置地图中心。
setCenter(address)StaticMap使用地址设置地图中心。
setCustomMarkerStyle(imageUrl, useShadow)StaticMap设置在创建新标记时要使用的自定义标记图片。
setFormat(format)StaticMap设置地图图片的格式。
setLanguage(language)StaticMap设置地图上文本所用的语言（如有）。
setMapType(mapType)StaticMap设置要显示的地图类型。
setMarkerStyle(size, color, label)StaticMap设置在创建新标记时要使用的标记样式。
setMobile(useMobileTiles)StaticMap设置是否为移动设备使用专用功能块集。
setPathStyle(weight, color, fillColor)StaticMap设置创建新路径时要使用的路径样式。
setSize(width, height)StaticMap设置地图图片的宽度和高度（以像素为单位）。
setZoom(zoom)StaticMap设置地图使用的缩放比例或放大级别。

详细文档

addAddress(address)

向当前路径定义添加新地址。 

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

参数

名称类型说明
addressString要添加的地址。

返回

StaticMap - 此映射实例，用于链接操作。

addMarker(latitude, longitude)

使用点 (lat/lng) 向地图添加标记。 

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

参数

名称类型说明
latitudeNumber新标记的纬度。
longitudeNumber新标记的 longitude。

返回

StaticMap - 此映射实例，用于链接操作。

另请参阅

addMarker(address)

使用地址向地图添加标记。 

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

参数

名称类型说明
addressString要放置新标记的地址。

返回

StaticMap - 此映射实例，用于链接操作。

另请参阅

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

参数

名称类型说明
pointsNumber[]用于定义路径的纬度/经度对数组。

返回

StaticMap - 此映射实例，用于链接操作。

addPath(polyline)

使用编码多段线将路径添加到地图中。 

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

参数

名称类型说明
polylineString编码多段线。

返回

StaticMap - 此映射实例，用于链接操作。

addPoint(latitude, longitude)

向当前路线定义添加新点（经纬度）。 

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

参数

名称类型说明
latitudeNumber相应点的纬度。
longitudeNumber相应点的经度。

返回

StaticMap - 此映射实例，用于链接操作。

addVisible(latitude, longitude)

添加一个必须在地图中显示的点（经纬度）位置。 

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

参数

名称类型说明
latitudeNumber相应点的纬度。
longitudeNumber相应点的经度。

返回

StaticMap - 此映射实例，用于链接操作。

另请参阅

addVisible(address)

添加必须在地图中显示的地址位置。 

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

参数

名称类型说明
addressString必须在地图上显示的地址。

返回

StaticMap - 此映射实例，用于链接操作。

另请参阅

beginPath()

开始新的路径定义。对 addAddress() 和 addPoint() 的调用会定义路径中的每个新顶点。调用 endPath() 时，路径将完成。 

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

返回

StaticMap - 此映射实例，用于链接操作。

clearMarkers()

清除当前的一组标记。 

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

返回

StaticMap - 此映射实例，用于链接操作。

clearPaths()

清除当前的一组路径。 

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

返回

StaticMap - 此映射实例，用于链接操作。

clearVisibles()

清除当前显示的位置集。 

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

返回

StaticMap - 此映射实例，用于链接操作。

endPath()

完成以 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();

返回

StaticMap - 此映射实例，用于链接操作。

getAs(contentType)

将此对象内的数据作为转换为指定内容类型的 blob 返回。此方法会向文件名添加相应的扩展名，例如“myfile.pdf”。不过，它假定文件名最后一个英文句点（如果有）后面的部分是应替换的现有扩展名。因此，“ShoppingList.12.25.2014”会变为“ShoppingList.12.25.pdf”。

如需查看转化每日配额，请参阅 Google 服务的配额。新创建的 Google Workspace 网域可能会暂时受到更严格的配额限制。

参数

名称类型说明
contentTypeString要转换到的 MIME 类型。对于大多数 blob，'application/pdf' 是唯一有效的选项。对于 BMP、GIF、JPEG 或 PNG 格式的图片，'image/bmp'、'image/gif'、'image/jpeg' 或 'image/png' 中的任何一种也有效。对于 Google 文档，'text/markdown' 也有效。

返回

Blob - 数据（以 blob 的形式）。

getBlob()

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

返回

Blob - 采用所选图片格式的地图图片。

getMapImage()

以字节数组的形式获取原始图片数据。

一般来说，最好使用 getBlob()，这样可以更轻松地与其他服务互动。 

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

返回

Byte[] - 采用所选图片格式的地图图片。

getMapUrl()

获取地图图片的网址。 

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

返回

String - 网址 地图图片的网址。

setCenter(latitude, longitude)

使用点（纬度/经度）设置地图中心。 

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

参数

名称类型说明
latitudeNumber中心的纬度。
longitudeNumber中心的经度。

返回

StaticMap - 此映射实例，用于链接操作。

另请参阅

setCenter(address)

使用地址设置地图中心。 

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

参数

名称类型说明
addressString中心的地址。

返回

StaticMap - 此映射实例，用于链接操作。

另请参阅

setCustomMarkerStyle(imageUrl, useShadow)

设置在创建新标记时要使用的自定义标记图片。已添加的标记不受影响。 

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

参数

名称类型说明
imageUrlString指定用作标记自定义图标的网址。图片可采用 PNG、JPEG 或 GIF 格式，但建议采用 PNG。
useShadowBoolean表示系统应根据图像的可见区域及其不透明度/透明度为标记生成阴影。

返回

StaticMap - 此映射实例，用于链接操作。

另请参阅

setFormat(format)

设置地图图片的格式。 

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

参数

名称类型说明
formatStringFormat 中的常量值。

返回

StaticMap - 此映射实例，用于链接操作。

另请参阅

setLanguage(language)

设置地图上文本所用的语言（如有）。 

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

参数

名称类型说明
languageStringBCP-47 语言标识符。

返回

StaticMap - 此映射实例，用于链接操作。

另请参阅

setMapType(mapType)

设置要显示的地图类型。 

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

参数

名称类型说明
mapTypeStringType 中的常量值。

返回

StaticMap - 此映射实例，用于链接操作。

另请参阅

setMarkerStyle(size, color, label)

设置在创建新标记时要使用的标记样式。已添加的标记不受影响。 

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

参数

名称类型说明
sizeStringMarkerSize 中的常量值。
colorString格式为“0xrrggbb”的字符串或 Color 中的常量值。
labelString包含单个字符 A-Z 或 0-9 的字符串。

返回

StaticMap - 此映射实例，用于链接操作。

另请参阅

setMobile(useMobileTiles)

设置是否为移动设备使用专用功能块集。 

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

参数

名称类型说明
useMobileTilesBoolean是否使用移动功能块。

返回

StaticMap - 此映射实例，用于链接操作。

setPathStyle(weight, color, fillColor)

设置创建新路径时要使用的路径样式。已添加的路径不受影响。 

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

参数

名称类型说明
weightInteger线条的宽度（以像素为单位）。
colorString线条颜色，表示为格式为“0xrrggbb”的字符串或 Color 中的常量值。
fillColorString填充颜色，格式为“0xrrggbb”的字符串或 Color 中的常量值。

返回

StaticMap - 此映射实例，用于链接操作。

另请参阅

setSize(width, height)

设置地图图片的宽度和高度（以像素为单位）。 

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

参数

名称类型说明
widthInteger图片的宽度（以像素为单位）。
heightInteger图片的高度（以像素为单位）。

返回

StaticMap - 此映射实例，用于链接操作。

另请参阅

setZoom(zoom)

设置地图使用的缩放比例或放大级别。 

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

参数

名称类型说明
zoomInteger一个介于 0 到 21（包括这两个数值）之间的值。

返回

StaticMap - 此映射实例，用于链接操作。

另请参阅