此页面由 Cloud Translation API 翻译。

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

另请参阅

Google Static Maps API

方法

方法	返回类型	简介
`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();

参数

名称	类型	说明
`address`	`String`	要添加的地址。

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

参数

名称	类型	说明
`latitude`	`Number`	新标记的纬度。
`longitude`	`Number`	新标记的 longitude。

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

另请参阅

Google Static Maps API

`addMarker(address)`

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

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

参数

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

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

另请参阅

Google Static Maps API

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

参数

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

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

参数

名称	类型	说明
`polyline`	`String`	编码多段线。

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

参数

名称	类型	说明
`latitude`	`Number`	相应点的纬度。
`longitude`	`Number`	相应点的经度。

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

参数

名称	类型	说明
`latitude`	`Number`	相应点的纬度。
`longitude`	`Number`	相应点的经度。

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

另请参阅

Google Static Maps API

`addVisible(address)`

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

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

参数

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

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

另请参阅

Google Static Maps API

`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 网域可能会暂时受到更严格的配额限制。

参数

名称	类型	说明
`contentType`	`String`	要转换到的 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);

参数

名称	类型	说明
`latitude`	`Number`	中心的纬度。
`longitude`	`Number`	中心的经度。

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

另请参阅

Google Static Maps API

`setCenter(address)`

使用地址设置地图中心。

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

参数

名称	类型	说明
`address`	`String`	中心的地址。

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

另请参阅

Google Static Maps API

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

参数

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

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

另请参阅

Google Static Maps API

`setFormat(format)`

设置地图图片的格式。

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

参数

名称	类型	说明
`format`	`String`	`Format` 中的常量值。

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

另请参阅

Google Static Maps API

`setLanguage(language)`

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

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

参数

名称	类型	说明
`language`	`String`	BCP-47 语言标识符。

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

另请参阅

Google 地图 API 中的语言支持

`setMapType(mapType)`

设置要显示的地图类型。

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

参数

名称	类型	说明
`mapType`	`String`	`Type` 中的常量值。

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

另请参阅

Google Static Maps API

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

参数

名称	类型	说明
`size`	`String`	`MarkerSize` 中的常量值。
`color`	`String`	格式为“0xrrggbb”的字符串或 `Color` 中的常量值。
`label`	`String`	包含单个字符 A-Z 或 0-9 的字符串。

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

另请参阅

Google Static Maps API

`setMobile(useMobileTiles)`

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

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

参数

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

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

参数

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

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

另请参阅

Google Static Maps API

`setSize(width, height)`

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

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

参数

名称	类型	说明
`width`	`Integer`	图片的宽度（以像素为单位）。
`height`	`Integer`	图片的高度（以像素为单位）。

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

另请参阅

Google Static Maps API

`setZoom(zoom)`

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

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

参数

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

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

另请参阅

Google Static Maps API