跳到主要内容
版本:v6

@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 (隐私 - 使用时位置使用说明)

有关在 Xcode 中设置 iOS 权限的更多信息,请阅读 iOS 指南 中的 配置 Info.plist

主 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 => '637954e5bcb2a879c11a6f2cear153a6bad5339f'

然后从 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 的版本(默认:18.2.0
  • googleMapsUtilsVersion: com.google.maps.android:android-maps-utils 的版本(默认:3.8.2
  • googleMapsKtxVersion: com.google.maps.android:maps-ktx 的版本(默认:5.0.0
  • googleMapsUtilsKtxVersion: com.google.maps.android:maps-utils-ktx 的版本(默认:5.0.0
  • kotlinxCoroutinesVersion: org.jetbrains.kotlinx:kotlinx-coroutines-androidorg.jetbrains.kotlinx:kotlinx-coroutines-core 的版本(默认:1.7.3
  • androidxCoreKTXVersion: androidx.core:core-ktx 的版本(默认:1.12.0
  • kotlin_version: org.jetbrains.kotlin:kotlin-stdlib 的版本(默认:1.9.10

使用

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

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

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 地图 API 密钥
config: {
center: {
// 地图初始渲染的位置
lat: 33.6,
lng: -117.9,
},
zoom: 8, // 地图初始渲染的缩放级别
},
});
};
</script>

API

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>
参数类型描述
minClusterSizenumber可以聚合成一个标记簇的最小标记数量,默认值为 4 个标记。

disableClustering()

disableClustering() => Promise<void>

addMarker(...)

addMarker(marker: Marker) => Promise<string>
参数类型
marker
Marker

返回值: Promise<string>


addMarkers(...)

addMarkers(markers: Marker[]) => Promise<string[]>
参数类型
markersMarker[]

返回值: Promise<string[]>


removeMarker(...)

removeMarker(id: string) => Promise<void>
参数类型
idstring

removeMarkers(...)

removeMarkers(ids: string[]) => Promise<void>
参数类型
idsstring[]

addPolygons(...)

addPolygons(polygons: Polygon[]) => Promise<string[]>
参数类型
polygonsPolygon[]

返回值: Promise<string[]>

--------------------### removePolygons(...)

removePolygons(ids: string[]) => Promise<void>
参数类型
idsstring[]

addCircles(...)

addCircles(circles: Circle[]) => Promise<string[]>
参数类型
circlesCircle[]

返回值: Promise<string[]>


removeCircles(...)

removeCircles(ids: string[]) => Promise<void>
参数类型
idsstring[]

addPolylines(...)

addPolylines(polylines: Polyline[]) => Promise<string[]>
参数类型
polylinesPolyline[]

返回值: Promise<string[]>


removePolylines(...)

removePolylines(ids: string[]) => Promise<void>
参数类型
idsstring[]

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>
参数类型
enabledboolean

enableTrafficLayer(...)

enableTrafficLayer(enabled: boolean) => Promise<void>
参数类型
enabledboolean

enableAccessibilityElements(...)

enableAccessibilityElements(enabled: boolean) => Promise<void>
参数类型
enabledboolean

enableCurrentLocation(...)

enableCurrentLocation(enabled: boolean) => Promise<void>
参数类型
enabledboolean

setPadding(...)

setPadding(padding: MapPadding) => Promise<void>
参数类型
padding
MapPadding

getMapBounds()

getMapBounds() => Promise<LatLngBounds>

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

返回值: Promise<LatLngBounds>


fitBounds(...)

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

将地图视口调整到包含指定的边界范围。

参数类型描述
boundsLatLngBounds需要适配到视口的边界范围。
paddingnumber可选的内边距(以像素为单位)。地图将在扣除内边距后剩余的区域中适配该边界范围。

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>

接口

CreateMapArgs

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

属性类型描述默认值
idstring地图实例的唯一标识符。
apiKeystringGoogle Maps SDK API 密钥。
config
GoogleMapConfig
地图的初始配置设置。
elementHTMLElement用于挂载 Google 地图视图的 DOM 元素,它决定了地图的大小和位置。
forceCreateboolean如果已存在具有相同 id 的地图实例,则销毁并重新创建它。false
regionstringregion 参数会改变您的应用程序,使其提供不同的地图图块,或使应用程序产生偏差(例如,将地理编码结果偏向该区域)。仅适用于 Web 平台。
languagestringlanguage 参数会影响控件名称、版权声明、驾驶路线和控件标签,以及服务请求的响应。仅适用于 Web 平台。

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

属性类型说明默认值始于版本
widthnumber覆盖原生地图的宽度。
heightnumber覆盖原生地图的高度。
xnumber覆盖原生地图的绝对 x 坐标位置。
ynumber覆盖原生地图的绝对 y 坐标位置。
center
LatLng
相机指向的地球上的默认位置。
zoomnumber设置地图的缩放级别。
androidLiteModeboolean在 Android 上启用基于图像的轻量模式。false
devicePixelRationumber覆盖原生地图的像素比。
stylesMapTypeStyle[] | null应用于每种默认地图类型的样式。请注意,对于卫星、混合和地形模式,这些样式仅适用于标签和几何图形。4.3.0
mapIdstring与特定地图样式或功能关联的地图 ID。使用地图 ID 仅适用于 Web。5.4.0
androidMapIdstring与特定地图样式或功能关联的地图 ID。使用地图 ID 仅适用于 Android。5.4.0
iOSMapIdstring与特定地图样式或功能关联的地图 ID。使用地图 ID 仅适用于 iOS。5.4.0

LatLng

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

属性类型说明
latnumber坐标纬度,以度为单位。该值在范围 [-90, 90] 内。
lngnumber坐标经度,以度为单位。该值在范围 [-180, 180] 内。

MapReadyCallbackData

属性类型
mapIdstring

标记点是在地图表面特定位置显示的图标。

属性类型说明默认值引入版本
coordinate
LatLng
标记点位置
opacitynumber设置标记点的不透明度,范围从 0(完全透明)到 1(完全不透明)1
titlestring标题,即标记点的简短描述
snippetstring片段文本,当标记点被选中时,在信息窗口中显示于标题下方
isFlatboolean控制标记点是否贴于地球表面(平铺)还是作为广告牌始终面向相机false
iconUrlstring要渲染的标记点图标路径。可以是相对于 web 应用公共目录的相对路径,也可以是远程标记点图标的 https 地址。原生平台不支持 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 和 Android4.2.0
draggableboolean控制此标记点是否可以通过交互拖动false
zIndexnumber指定此标记点相对于地图上其他标记点的堆叠顺序。z-index 高的标记点会绘制在 z-index 低的标记点之上0

尺寸

属性类型
widthnumber
heightnumber

几何对象。 参考链接:https://tools.ietf.org/html/rfc7946#section-3.1.2

属性类型说明
type
'Point'
指定 GeoJSON 对象的类型
coordinates
Position

多边形

多边形 几何对象。 参考链接:https://tools.ietf.org/html/rfc7946#section-3.1.6

属性类型说明
type
'Polygon'
指定 GeoJSON 对象的类型
coordinatesPosition[][]

在网页端,所有 JavaScript Circle 选项都可用,因为 Polygon 继承自 google.maps.CircleOptions。
在 iOS 和 Android 上,只有 Circle 中声明的配置选项可用。

属性类型描述
fillColorstring填充颜色。支持所有 CSS3 颜色,但不包括扩展的命名颜色。
fillOpacitynumber填充不透明度,介于 0.0 和 1.0 之间。
strokeColorstring描边颜色。支持所有 CSS3 颜色,但不包括扩展的命名颜色。
strokeWeightnumber描边宽度,单位为像素。
geodesicboolean
clickableboolean指示此
Circle
是否处理鼠标事件。
titlestring标题,即覆盖层的简短描述。某些覆盖层(如标记)会在地图上显示标题。标题也是默认的无障碍文本。仅在 iOS 上可用。
tagstring

折线

在网页端,所有 JavaScript Polyline 选项都可用,因为 Polyline 继承自 google.maps.PolylineOptions。
在 iOS 和 Android 上,只有 Polyline 中声明的配置选项可用。

属性类型描述
strokeColorstring描边颜色。支持所有 CSS3 颜色,但不包括扩展的命名颜色。
strokeOpacitynumber描边不透明度,介于 0.0 和 1.0 之间。
strokeWeightnumber描边宽度,单位为像素。
geodesicbooleantrue 时,多边形的边被视为测地线,并会跟随地球的曲率。当 false 时,多边形的边在屏幕空间中被渲染为直线。请注意,测地线多边形的形状在拖动时可能会发生变化,因为其尺寸会相对于地球表面保持。
clickableboolean指示此
Polyline
是否处理鼠标事件。
tagstring
styleSpansStyleSpan[]用于指定折线的一个或多个段的颜色。styleSpans 属性是一个 StyleSpan 对象数组。设置 spans 属性是更改折线颜色的首选方法。仅在 iOS 和 Android 上可用。

样式跨度

描述折线某一部分的样式。

属性类型描述
colorstring描边颜色。支持所有 CSS3 颜色,但不包括扩展的命名颜色。
segmentsnumber此跨度的长度,以段数表示。

Google 地图摄像头的配置属性

属性类型描述默认值
coordinate
LatLng
摄像头指向的地球位置。
zoomnumber设置地图的缩放级别。
bearingnumber摄像头的方位角,以真北方向为基准顺时针计算的度数。0
anglenumber摄像头相对于天底(垂直指向地球)的角度,单位为度。仅允许的值为 0 和 45。0
animateboolean是否以动画方式过渡到新的摄像头属性。false
animationDurationnumber此配置选项当前未使用。

MapPadding

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

属性类型
topnumber
leftnumber
rightnumber
bottomnumber

CameraIdleCallbackData

属性类型
mapIdstring
boundsLatLngBounds
bearingnumber
latitudenumber
longitudenumber
tiltnumber
zoomnumber

CameraMoveStartedCallbackData

属性类型
mapIdstring
isGestureboolean

ClusterClickCallbackData

属性类型
mapIdstring
latitudenumber
longitudenumber
sizenumber
itemsMarkerCallbackData[]

MarkerCallbackData

属性类型
markerIdstring
latitudenumber
longitudenumber
titlestring
snippetstring

MarkerClickCallbackData

属性类型
mapIdstring

MapClickCallbackData

属性类型
mapIdstring
latitudenumber
longitudenumber

PolygonClickCallbackData

属性类型
mapIdstring
polygonIdstring
tagstring

CircleClickCallbackData

属性类型
mapIdstring
circleIdstring
tagstring

PolylineCallbackData

属性类型
polylineIdstring
tagstring

MyLocationButtonClickCallbackData

属性类型
mapIdstring

类型别名

MapListenerCallback

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

(data: T): void

Position

Position 是一个坐标数组。 参考:https://tools.ietf.org/html/rfc7946#section-3.1.1 数组应包含 2 到 3 个元素。 之前的 GeoJSON 规范允许更多元素(例如,可用于表示 M 值),但当前规范仅允许定义 X、Y 和(可选的)Z。

number[]

枚举

MapType

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