@capacitor/google-maps

在 Capacitor 中使用 Google 地图

安装

npm install @capacitor/google-maps
npx cap sync

API 密钥

要在任何平台上使用 Google Maps SDK，都需要使用关联到已启用计费的账户的 API 密钥。这些密钥可以从 Google Cloud Console 获取。Android、iOS 和 JavaScript 三个平台均需要此密钥。关于获取这些 API 密钥的更多信息，可在各平台的 Google Maps 文档 中找到。

iOS

Google Maps SDK 支持通过 enableCurrentLocation(bool) 显示用户的当前位置。为此，Apple 要求在 Info.plist 中指定隐私描述：

• NSLocationWhenInUseUsageDescription (隐私 - 使用时位置访问说明)

请阅读 iOS 指南 中的 配置 Info.plist 部分，了解更多关于在 Xcode 中设置 iOS 权限的信息。

TypeScript 配置

您的项目还需要在 tsconfig.json 中将 skipLibCheck 设置为 true。

从旧版本迁移

主要的 Google Maps SDK 现在支持在 Apple Silicon Mac 的模拟器上运行，但请确保您安装了最新版本的 Google-Maps-iOS-Utils。

如果您之前添加了获取未发布版本的特殊处理，现在可以通过从 ios/App/Podfile 中删除以下行来移除它：

pod 'Google-Maps-iOS-Utils', :git => 'https://github.com/googlemaps/google-maps-ios-utils.git', :commit => '637954e5bcb2a879c11a6f2cead153a6bad5339f'

然后从 ios/App/ 文件夹运行 pod update Google-Maps-iOS-Utils：

cd ios/App
pod update Google-Maps-iOS-Utils

Android

适用于 Android 的 Google Maps SDK 要求您将 API 密钥添加到项目中的 AndroidManifest.xml 文件。

<meta-data android:name="com.google.android.geo.API_KEY" android:value="YOUR_API_KEY_HERE"/>

要使用某些定位功能，SDK 还要求将以下权限添加到您的 AndroidManifest.xml：

<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

变量

此插件将使用以下项目变量（在您应用的 variables.gradle 文件中定义）：

• googleMapsPlayServicesVersion: com.google.android.gms:play-services-maps 的版本（默认：19.2.0）
• googleMapsUtilsVersion: com.google.maps.android:android-maps-utils 的版本（默认：3.19.1）
• googleMapsKtxVersion: com.google.maps.android:maps-ktx 的版本（默认：5.2.1）
• googleMapsUtilsKtxVersion: com.google.maps.android:maps-utils-ktx 的版本（默认：5.2.1）
• kotlinxCoroutinesVersion: org.jetbrains.kotlinx:kotlinx-coroutines-android 和 org.jetbrains.kotlinx:kotlinx-coroutines-core 的版本（默认：1.10.2）
• androidxCoreKTXVersion: androidx.core:core-ktx 的版本（默认：1.17.0）
• kotlin_version: org.jetbrains.kotlin:kotlin-stdlib 的版本（默认：2.2.20）

使用方法

Google Maps Capacitor 插件附带了一个 Web 组件，必须在您的应用程序中使用它来渲染地图，因为它使我们能够在 iOS 上更有效地嵌入原生视图。插件将自动注册此 Web 组件以供您在应用中使用。

对于 Angular 用户，您会收到一个错误警告，提示 Angular 编译器不认识此 Web 组件。这可以通过修改声明组件的模块以允许自定义 Web 组件来解决。

import { CUSTOM_ELEMENTS_SCHEMA } from '@angular/core';

@NgModule({
  schemas: [CUSTOM_ELEMENTS_SCHEMA]
})

在您的 HTML 中包含此组件并为其分配一个 ID，以便稍后可以轻松查询该元素引用。

<capacitor-google-map id="map"></capacitor-google-map>

在 Android 上，地图是在整个 WebView 下方渲染的，并使用此组件在滚动事件期间管理其定位。这意味着作为开发者，您必须确保 WebView 从各层一直到最底部都是透明的。在典型的 Ionic 应用中，这意味着需要在诸如 IonContent 和根 HTML 标签等元素上设置透明度，以确保可以看到地图。如果在 Android 上看不到地图，这应该是您首先检查的事项。

在 iOS 上，我们直接将地图渲染到 WebView 中，因此不需要相同的透明度效果。我们仍在研究 Android 的替代方法，并希望在未来的更新中更好地解决此问题。

Google Map 元素本身是无样式的，因此您应该对其进行样式设置以使其适应页面结构的布局。因为我们正在将视图渲染到此插槽中，所以元素本身没有宽度或高度，请务必显式设置它们。

capacitor-google-map {
  display: inline-block;
  width: 275px;
  height: 400px;
}

接下来，我们应该创建地图引用。这是通过从 Capacitor 插件导入 GoogleMap 类并调用 create 方法，并传入所需的参数来完成的。

import { GoogleMap } from '@capacitor/google-maps';

const apiKey = 'YOUR_API_KEY_HERE';

const mapRef = document.getElementById('map');

const newMap = await GoogleMap.create({
  id: 'my-map', // 此地图实例的唯一标识符
  element: mapRef, // 对 capacitor-google-map 元素的引用
  apiKey: apiKey, // 您的 Google Maps API 密钥
  config: {
    center: {
      // 地图初始渲染位置
      lat: 33.6,
      lng: -117.9,
    },
    zoom: 8, // 地图初始缩放级别
  },
});

此时，您的地图应该在应用程序中创建完成。使用返回的地图引用，您可以通过多种方式轻松地与地图交互，这里展示了其中一些方式。

const newMap = await GoogleMap.create({...});

// 向地图添加标记
const markerId = await newMap.addMarker({
  coordinate: {
    lat: 33.6,
    lng: -117.9
  }
});

// 以编程方式移动地图
await newMap.setCamera({
  coordinate: {
    lat: 33.6,
    lng: -117.9
  }
});

// 启用标记聚类
await newMap.enableClustering();

// 处理标记点击事件
await newMap.setOnMarkerClickListener((event) => {...});

// 清理地图引用
await newMap.destroy();

完整示例

Angular

import { GoogleMap } from '@capacitor/google-maps';

@Component({
  template: `
    <capacitor-google-map #map></capacitor-google-map>
    <button (click)="createMap()">创建地图</button>
  `,
  styles: [
    `
      capacitor-google-map {
        display: inline-block;
        width: 275px;
        height: 400px;
      }
    `,
  ],
})
export class MyMap {
  @ViewChild('map')
  mapRef: ElementRef<HTMLElement>;
  newMap: GoogleMap;

  async createMap() {
    this.newMap = await GoogleMap.create({
      id: 'my-cool-map',
      element: this.mapRef.nativeElement,
      apiKey: environment.apiKey,
      config: {
        center: {
          lat: 33.6,
          lng: -117.9,
        },
        zoom: 8,
      },
    });
  }
}

React

import { GoogleMap } from '@capacitor/google-maps';
import { useRef } from 'react';

const MyMap: React.FC = () => {
  const mapRef = useRef<HTMLElement>();
  let newMap: GoogleMap;

  async function createMap() {
    if (!mapRef.current) return;

    newMap = await GoogleMap.create({
      id: 'my-cool-map',
      element: mapRef.current,
      apiKey: process.env.REACT_APP_YOUR_API_KEY_HERE,
      config: {
        center: {
          lat: 33.6,
          lng: -117.9
        },
        zoom: 8
      }
    })
  }

  return (
    <div className="component-wrapper">
      <capacitor-google-map ref={mapRef} style={{
        display: 'inline-block',
        width: 275,
        height: 400
      }}></capacitor-google-map>

      <button onClick={createMap}>创建地图</button>
    </div>
  )
}

export default MyMap;

你可能需要为React中的自定义元素创建一个*.d.ts文件：

// custom-elements.d.ts

declare module "react" {
  namespace JSX {
    interface IntrinsicElements {
      "capacitor-google-map": React.DetailedHTMLProps<
        React.HTMLAttributes<HTMLElement>,
        HTMLElement
      >;
    }
  }
}

export {};

Vue

<script lang="ts" setup>
import { ref, shallowRef, useTemplateRef } from 'vue';
import { GoogleMap } from '@capacitor/google-maps';

const mapRef = useTemplateRef<HTMLElement>('mapRef');
const newMap = shallowRef<GoogleMap>();

async function createMap() {
  if (!mapRef.value) return;

  newMap.value = await GoogleMap.create({
    id: 'my-cool-map',
    element: mapRef.value,
    apiKey: import.meta.env.VITE_YOUR_API_KEY_HERE,
    config: {
      center: {
        lat: 33.6,
        lng: -117.9,
      },
      zoom: 8,
    },
  });
}
</script>

<template>
  <capacitor-google-map ref="mapRef" style="display: inline-block; width: 275px; height: 400px"></capacitor-google-map>
  <button @click="createMap()">创建地图</button>
</template>

请确保您需要启用识别原生自定义元素功能，例如：

// vite.config.mts > plugins
Vue({
  template: {
    compilerOptions: {
      isCustomElement: (tag) => tag.startsWith('capacitor-')
    },
  },
}),

JavaScript

<capacitor-google-map id="map"></capacitor-google-map>
<button onclick="createMap()">创建地图</button>

<style>
  capacitor-google-map {
    display: inline-block;
    width: 275px;
    height: 400px;
  }
</style>

<script>
  import { GoogleMap } from '@capacitor/google-maps';

  const createMap = async () => {
    const mapRef = document.getElementById('map');

    const newMap = await GoogleMap.create({
      id: 'my-map', // 此地图实例的唯一标识符
      element: mapRef, // 对 capacitor-google-map 元素的引用
      apiKey: 'YOUR_API_KEY_HERE', // 您的 Google Maps API 密钥
      config: {
        center: {
          // 地图初始渲染位置
          lat: 33.6,
          lng: -117.9,
        },
        zoom: 8, // 地图初始缩放级别
      },
    });
  };
</script>

API

• create(...)
• enableTouch()
• disableTouch()
• enableClustering(...)
• disableClustering()
• addTileOverlay(...)
• removeTileOverlay(...)
• addMarker(...)
• addMarkers(...)
• removeMarker(...)
• removeMarkers(...)
• addPolygons(...)
• removePolygons(...)
• addCircles(...)
• removeCircles(...)
• addPolylines(...)
• removePolylines(...)
• destroy()
• setCamera(...)
• getMapType()
• setMapType(...)
• enableIndoorMaps(...)
• enableTrafficLayer(...)
• enableAccessibilityElements(...)
• enableCurrentLocation(...)
• setPadding(...)
• getMapBounds()
• fitBounds(...)
• setOnBoundsChangedListener(...)
• setOnCameraIdleListener(...)
• setOnCameraMoveStartedListener(...)
• setOnClusterClickListener(...)
• setOnClusterInfoWindowClickListener(...)
• setOnInfoWindowClickListener(...)
• setOnMapClickListener(...)
• setOnMarkerClickListener(...)
• setOnPolygonClickListener(...)
• setOnCircleClickListener(...)
• setOnPolylineClickListener(...)
• setOnMarkerDragStartListener(...)
• setOnMarkerDragListener(...)
• setOnMarkerDragEndListener(...)
• setOnMyLocationButtonClickListener(...)
• setOnMyLocationClickListener(...)
• 接口
• 类型别名
• 枚举

create(...)

create(options: CreateMapArgs, callback?: MapListenerCallback<MapReadyCallbackData> | undefined) => Promise<GoogleMap>

参数	类型
options	CreateMapArgs
callback	MapListenerCallback<MapReadyCallbackData>

返回值: Promise<GoogleMap>

---

enableTouch()

enableTouch() => Promise<void>

---

disableTouch()

disableTouch() => Promise<void>

---

enableClustering(...)

enableClustering(minClusterSize?: number | undefined) => Promise<void>

参数	类型	描述
minClusterSize	number	可聚集在一起的最小标记数量。默认为 4 个标记。

---

disableClustering()

disableClustering() => Promise<void>

---

addTileOverlay(...)

addTileOverlay(tileOverlay: TileOverlay) => Promise<{ id: string; }>

参数	类型
tileOverlay	TileOverlay

返回值: Promise<{ id: string; }>

---

removeTileOverlay(...)

removeTileOverlay(id: string) => Promise<void>

参数	类型
id	string

---

addMarker(...)

addMarker(marker: Marker) => Promise<string>

参数	类型
marker	Marker

返回值: Promise<string>

---

addMarkers(...)

addMarkers(markers: Marker[]) => Promise<string[]>

参数	类型
markers	Marker[]

返回值: Promise<string[]>

---

removeMarker(...)

removeMarker(id: string) => Promise<void>

参数	类型
id	string

---

removeMarkers(...)

removeMarkers(ids: string[]) => Promise<void>

参数	类型
ids	string[]

---

addPolygons(...)

addPolygons(polygons: Polygon[]) => Promise<string[]>

参数	类型
polygons	Polygon[]

返回值: Promise<string[]>

---

removePolygons(...)

removePolygons(ids: string[]) => Promise<void>

参数	类型
ids	string[]

---

addCircles(...)

addCircles(circles: Circle[]) => Promise<string[]>

参数	类型
circles	Circle[]

返回值: Promise<string[]>

---

removeCircles(...)

removeCircles(ids: string[]) => Promise<void>

参数	类型
ids	string[]

---

addPolylines(...)

addPolylines(polylines: Polyline[]) => Promise<string[]>

参数	类型
polylines	Polyline[]

返回值: Promise<string[]>

---

removePolylines(...)

removePolylines(ids: string[]) => Promise<void>

参数	类型
ids	string[]

---

destroy()

destroy() => Promise<void>

---

setCamera(...)

setCamera(config: CameraConfig) => Promise<void>

参数	类型
config	CameraConfig

---

getMapType()

getMapType() => Promise<MapType>

获取当前地图类型

返回值:

Promise<MapType>

---

setMapType(...)

setMapType(mapType: MapType) => Promise<void>

参数	类型
mapType	MapType

---

enableIndoorMaps(...)

enableIndoorMaps(enabled: boolean) => Promise<void>

参数	类型
enabled	boolean

---

enableTrafficLayer(...)

enableTrafficLayer(enabled: boolean) => Promise<void>

参数	类型
enabled	boolean

---

enableAccessibilityElements(...)

enableAccessibilityElements(enabled: boolean) => Promise<void>

参数	类型
enabled	boolean

---

enableCurrentLocation(...)

enableCurrentLocation(enabled: boolean) => Promise<void>

参数	类型
enabled	boolean

---

setPadding(...)

setPadding(padding: MapPadding) => Promise<void>

参数	类型
padding	MapPadding

---

getMapBounds()

getMapBounds() => Promise<LatLngBounds>

获取地图当前视口的经纬度边界。

返回值: Promise<LatLngBounds>

---

fitBounds(...)

fitBounds(bounds: LatLngBounds, padding?: number | undefined) => Promise<void>

设置地图视口以包含给定的边界。

参数	类型	描述
bounds	LatLngBounds	要适应视口的边界。
padding	number	可选的内边距（以像素为单位）。边界将适应在移除内边距后剩余的地图部分。

---

setOnBoundsChangedListener(...)

setOnBoundsChangedListener(callback?: MapListenerCallback<CameraIdleCallbackData> | undefined) => Promise<void>

参数	类型
callback	MapListenerCallback<CameraIdleCallbackData>

---

setOnCameraIdleListener(...)

setOnCameraIdleListener(callback?: MapListenerCallback<CameraIdleCallbackData> | undefined) => Promise<void>

参数	类型
callback	MapListenerCallback<CameraIdleCallbackData>

---

setOnCameraMoveStartedListener(...)

setOnCameraMoveStartedListener(callback?: MapListenerCallback<CameraMoveStartedCallbackData> | undefined) => Promise<void>

参数	类型
callback	MapListenerCallback<CameraMoveStartedCallbackData>

---

setOnClusterClickListener(...)

setOnClusterClickListener(callback?: MapListenerCallback<ClusterClickCallbackData> | undefined) => Promise<void>

参数	类型
callback	MapListenerCallback<ClusterClickCallbackData>

---

setOnClusterInfoWindowClickListener(...)

setOnClusterInfoWindowClickListener(callback?: MapListenerCallback<ClusterClickCallbackData> | undefined) => Promise<void>

参数	类型
callback	MapListenerCallback<ClusterClickCallbackData>

---

setOnInfoWindowClickListener(...)

setOnInfoWindowClickListener(callback?: MapListenerCallback<MarkerClickCallbackData> | undefined) => Promise<void>

参数	类型
callback	MapListenerCallback<MarkerClickCallbackData>

---

setOnMapClickListener(...)

setOnMapClickListener(callback?: MapListenerCallback<MapClickCallbackData> | undefined) => Promise<void>

参数	类型
callback	MapListenerCallback<MapClickCallbackData>

---

setOnMarkerClickListener(...)

setOnMarkerClickListener(callback?: MapListenerCallback<MarkerClickCallbackData> | undefined) => Promise<void>

参数	类型
callback	MapListenerCallback<MarkerClickCallbackData>

---

setOnPolygonClickListener(...)

setOnPolygonClickListener(callback?: MapListenerCallback<PolygonClickCallbackData> | undefined) => Promise<void>

参数	类型
callback	MapListenerCallback<PolygonClickCallbackData>

---

setOnCircleClickListener(...)

setOnCircleClickListener(callback?: MapListenerCallback<CircleClickCallbackData> | undefined) => Promise<void>

参数	类型
callback	MapListenerCallback<CircleClickCallbackData>

---

setOnPolylineClickListener(...)

setOnPolylineClickListener(callback?: MapListenerCallback<PolylineCallbackData> | undefined) => Promise<void>

参数	类型
callback	MapListenerCallback<PolylineCallbackData>

---

setOnMarkerDragStartListener(...)

setOnMarkerDragStartListener(callback?: MapListenerCallback<MarkerClickCallbackData> | undefined) => Promise<void>

参数	类型
callback	MapListenerCallback<MarkerClickCallbackData>

---

setOnMarkerDragListener(...)

setOnMarkerDragListener(callback?: MapListenerCallback<MarkerClickCallbackData> | undefined) => Promise<void>

参数	类型
callback	MapListenerCallback<MarkerClickCallbackData>

---

setOnMarkerDragEndListener(...)

setOnMarkerDragEndListener(callback?: MapListenerCallback<MarkerClickCallbackData> | undefined) => Promise<void>

参数	类型
callback	MapListenerCallback<MarkerClickCallbackData>

---

setOnMyLocationButtonClickListener(...)

setOnMyLocationButtonClickListener(callback?: MapListenerCallback<MyLocationButtonClickCallbackData> | undefined) => Promise<void>

参数	类型
callback	MapListenerCallback<MyLocationButtonClickCallbackData>

---

setOnMyLocationClickListener(...)

setOnMyLocationClickListener(callback?: MapListenerCallback<MapClickCallbackData> | undefined) => Promise<void>

参数	类型
callback	MapListenerCallback<MapClickCallbackData>

---

Interfaces

CreateMapArgs

一个包含创建地图时使用的选项的接口。

属性	类型	描述	默认值
id	string	地图实例的唯一标识符。
apiKey	string	Google Maps SDK API 密钥。
config	GoogleMapConfig	地图的初始配置设置。
element	HTMLElement	Google Map View 将挂载的 DOM 元素，决定大小和位置。
forceCreate	boolean	如果已存在具有所提供 id 的地图实例，则销毁并重新创建地图实例	false
region	string	region 参数会改变您的应用程序以提供不同的地图瓦片或偏置应用程序（例如将地理编码结果偏向该区域）。仅适用于 Web。
language	string	language 参数会影响控件名称、版权声明、驾驶方向和控制标签，以及服务请求的响应。仅适用于 Web。

GoogleMapConfig

对于 Web，所有 JavaScript Google Maps 选项都可用，因为 GoogleMapConfig 扩展了 google.maps.MapOptions。 对于 iOS 和 Android，只有声明在 GoogleMapConfig 上的配置选项可用。

属性	类型	描述	默认值	自版本
width	number	覆盖原生地图的宽度。
height	number	覆盖原生地图的高度。
x	number	覆盖原生地图的绝对 x 坐标位置。
y	number	覆盖原生地图的绝对 y 坐标位置。
center	LatLng	相机指向的地球上的默认位置。
zoom	number	设置地图的缩放级别。
androidLiteMode	boolean	在 Android 上启用基于图像的 Lite 模式。	false
devicePixelRatio	number	覆盖原生地图的像素比率。
styles	MapTypeStyle[] | null	应用于每种默认地图类型的样式。请注意，对于卫星、混合和地形模式，这些样式仅适用于标签和几何图形。		4.3.0
mapId	string	与特定地图样式或功能关联的地图 ID。使用地图 ID 仅适用于 Web。		5.4.0
androidMapId	string	与特定地图样式或功能关联的地图 ID。使用地图 ID 仅适用于 Android。		5.4.0
iOSMapId	string	与特定地图样式或功能关联的地图 ID。使用地图 ID 仅适用于 iOS。		5.4.0
maxZoom	number | null	地图上显示的最大缩放级别。如果省略或设置为 <code>null</code>，则改用当前地图类型的最大缩放级别。有效的缩放值是从零到支持的 <a href="https://developers.google.com/maps/documentation/javascript/maxzoom"&gt;最大缩放级别&lt;/a> 的数字。
minZoom	number | null	地图上显示的最小缩放级别。如果省略或设置为 <code>null</code>，则改用当前地图类型的最小缩放级别。有效的缩放值是从零到支持的 <a href="https://developers.google.com/maps/documentation/javascript/maxzoom"&gt;最大缩放级别&lt;/a> 的数字。
mapTypeId	string | null	初始地图 mapTypeId。默认为 <code>ROADMAP</code>。
heading	number | null	航空影像的航向，以从正北方向顺时针测量的度数表示。航向会捕捉到有可用影像的最接近角度。
restriction	MapRestriction | null	定义限制用户可访问地图区域的边界。设置后，用户只能在相机视图保持在边界限制内时进行平移和缩放。

LatLng

表示一对经纬度坐标的接口。

属性	类型	描述
lat	number	坐标纬度，以度为单位。此值在 [-90, 90] 范围内。
lng	number	坐标经度，以度为单位。此值在 [-180, 180] 范围内。

MapReadyCallbackData

属性	类型
mapId	string

TileOverlay

瓦片覆盖层是在特定缩放级别放置在地图顶部的图像。适用于 iOS、Android 和 Web

属性	类型	描述	默认值
url	string	表示瓦片 URL 的字符串。应包含 {x}、{y} 和 {z}，以便可以用 x、y 和缩放的实际值替换它们。适用于 iOS、Android 和 Web
opacity	number	瓦片覆盖层的不透明度，介于 0（完全透明）和 1（含）之间。适用于 iOS、Android 和 Web	undefined
visible	boolean	控制此瓦片覆盖层是否应可见。仅适用于 Android	undefined
zIndex	number	瓦片覆盖层的 zIndex。适用于 iOS 和 Android	undefined

Marker

标记是放置在地图表面特定点的图标。

属性	类型	描述	默认值	自版本
coordinate	LatLng	标记 位置
opacity	number	设置标记的不透明度，介于 0（完全透明）和 1（含）之间。	1
title	string	标题，覆盖层的简短描述。
snippet	string	片段文本，选择时在信息窗口中显示在标题下方。
isFlat	boolean	控制此标记是应平贴在地球表面还是面向相机的广告牌。	false
iconUrl	string	要渲染的标记图标路径。可以是相对于 Web 应用公共目录的路径，也可以是远程标记图标的 https URL。SVG 在原生平台上不受支持。		4.2.0
iconSize	Size	控制 iconUrl 中设置的标记图像的缩放大小。		4.2.0
iconOrigin	Point	图像在精灵图中的位置（如果有）。默认情况下，原点位于图像的左上角。		4.2.0
iconAnchor	Point	将图像锚定到地图上标记位置的位置。默认情况下，锚点位于图像底部中心点。		4.2.0
tintColor	{ r: number; g: number; b: number; a: number; }	自定义默认标记图像的颜色。每个值必须在 0 到 255 之间。仅适用于 iOS 和 Android。		4.2.0
draggable	boolean	控制此标记是否可以通过交互拖动	false
zIndex	number	指定此标记的堆叠顺序，相对于地图上的其他标记。z-index 较高的标记绘制在 z-index 较低的标记之上	0

Size

属性	类型
width	number
height	number

Point

属性	类型
x	number
y	number

Polygon

对于 Web，所有 JavaScript 多边形 选项都可用，因为 Polygon 扩展了 google.maps.PolygonOptions。 对于 iOS 和 Android，只有声明在 Polygon 上的配置选项可用。

属性	类型	描述
paths	any[] | MVCArray<any>	指定闭合环的有序坐标序列。与折线不同，多边形可以由一个或多个路径组成。因此，paths 属性可以指定一个或多个 <code>LatLng</code> 坐标数组。路径会自动闭合；不要将路径的第一个顶点重复作为最后一个顶点。简单多边形可以使用单个 <code>LatLng</code> 数组定义。更复杂的多边形可以指定数组的数组。任何简单数组都会转换为 <code><a href="#MVCArray">MVCArray</a></code>s。从 <code>MVCArray</code> 插入或删除 <code>LatLng</code>s 将自动更新地图上的多边形。
strokeColor	string	描边颜色。支持所有 CSS3 颜色，除了扩展的命名颜色。
strokeOpacity	number	描边不透明度，介于 0.0 和 1.0 之间
strokeWeight	number	描边宽度（以像素为单位）。
fillColor	string	填充颜色。支持所有 CSS3 颜色，除了扩展的命名颜色。
fillOpacity	number	填充不透明度，介于 0.0 和 1.0 之间
geodesic	boolean	当 <code>true</code> 时，多边形的边缘被解释为测地线，并将跟随地球的曲率。当 <code>false</code> 时，多边形的边缘在屏幕空间中渲染为直线。请注意，测地线多边形的形状在拖动时可能会发生变化，因为尺寸相对于地球表面保持。
clickable	boolean	指示此 <code>Polygon</code> 是否处理鼠标事件。
title	string	标题，覆盖层的简短描述。一些覆盖层（例如标记）会在地图上显示标题。标题也是默认的无障碍文本。仅适用于 iOS。
tag	string

Circle

对于 Web，所有 JavaScript 圆形 选项都可用，因为 Circle 扩展了 google.maps.CircleOptions。 对于 iOS 和 Android，只有声明在 Circle 上的配置选项可用。

属性	类型	描述
fillColor	string	填充颜色。支持所有 CSS3 颜色，除了扩展的命名颜色。
fillOpacity	number	填充不透明度，介于 0.0 和 1.0 之间。
strokeColor	string	描边颜色。支持所有 CSS3 颜色，除了扩展的命名颜色。
strokeWeight	number	描边宽度（以像素为单位）。
geodesic	boolean
clickable	boolean	指示此 <code>Circle</code> 是否处理鼠标事件。
title	string	标题，覆盖层的简短描述。一些覆盖层（例如标记）会在地图上显示标题。标题也是默认的无障碍文本。仅适用于 iOS。
tag	string

Polyline

对于 Web，所有 JavaScript 折线 选项都可用，因为 Polyline 扩展了 google.maps.PolylineOptions。 对于 iOS 和 Android，只有声明在 Polyline 上的配置选项可用。

属性	类型	描述
strokeColor	string	描边颜色。支持所有 CSS3 颜色，除了扩展的命名颜色。
strokeOpacity	number	描边不透明度，介于 0.0 和 1.0 之间。
strokeWeight	number	描边宽度（以像素为单位）。
geodesic	boolean	当 <code>true</code> 时，多边形的边缘被解释为测地线，并将跟随地球的曲率。当 <code>false</code> 时，多边形的边缘在屏幕空间中渲染为直线。请注意，测地线多边形的形状在拖动时可能会发生变化，因为尺寸相对于地球表面保持。
clickable	boolean	指示此 <code>Polyline</code> 是否处理鼠标事件。
tag	string
styleSpans	StyleSpan[]	用于指定折线一个或多个段的颜色。styleSpans 属性是 StyleSpan 对象的数组。设置 spans 属性是更改折线颜色的首选方法。仅在 iOS 和 Android 上可用。

StyleSpan

描述折线某些区域的样式。

属性	类型	描述
color	string	描边颜色。支持所有 CSS3 颜色，除了扩展的命名颜色。
segments	number	此跨度的长度（以段数表示）。

CameraConfig

Google Map 相机的配置属性

属性	类型	描述	默认值
coordinate	LatLng	相机指向的地球上的位置。
zoom	number	设置地图的缩放级别。
bearing	number	相机的方位角，以从正北方向顺时针测量的度数表示。	0
angle	number	相机从天底（直接面向地球）的角度（以度为单位）。唯一允许的值是 0 和 45。	0
animate	boolean	动画过渡到新的相机属性。	false
animationDuration	number	此配置选项未被使用。

MapPadding

控制视口“可见”区域的内边距设置。

属性	类型
top	number
left	number
right	number
bottom	number

CameraIdleCallbackData

属性	类型
mapId	string
bounds	LatLngBounds
bearing	number
latitude	number
longitude	number
tilt	number
zoom	number

CameraMoveStartedCallbackData

属性	类型
mapId	string
isGesture	boolean

ClusterClickCallbackData

属性	类型
mapId	string
latitude	number
longitude	number
size	number
items	MarkerCallbackData[]

MarkerCallbackData

属性	类型
markerId	string
latitude	number
longitude	number
title	string
snippet	string

MarkerClickCallbackData

属性	类型
mapId	string

MapClickCallbackData

属性	类型
mapId	string
latitude	number
longitude	number

PolygonClickCallbackData

属性	类型
mapId	string
polygonId	string
tag	string

CircleClickCallbackData

属性	类型
mapId	string
circleId	string
tag	string

PolylineCallbackData

属性	类型
polylineId	string
tag	string

MyLocationButtonClickCallbackData

属性	类型
mapId	string

Type Aliases

MapListenerCallback

地图事件发出时要调用的回调函数。

(data: T): void

Marker

支持“传统”或“高级”类型的标记。

  google.maps.Marker | google.maps.marker.AdvancedMarkerElement

Enums

MapType

成员	值	描述
Normal	'Normal'	基本地图。
Hybrid	'Hybrid'	带有道路和标签的卫星图像。
Satellite	'Satellite'	无标签的卫星图像。
Terrain	'Terrain'	地形数据。
None	'None'	无底图瓦片。