@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 中指定隐私描述：

• NSLocationAlwaysUsageDescription (隐私 - 始终使用位置描述)
• NSLocationWhenInUseUsageDescription (隐私 - 使用时使用位置描述)

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

目前，Google Maps SDK 不支持在使用基于 M1 芯片的 Macbook 模拟器上运行。这是一个 已知且已被确认的问题，需要 Google 提供修复。如果您在 M1 Macbook 上进行开发，仍然支持在物理设备上构建和运行，这也是推荐的做法。

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" />

使用说明

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-maps #map></capacitor-google-maps>
    <button (click)="createMap()">创建地图</button>
  `,
  styles: [
    `
      capacitor-google-maps {
        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;

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(...)
• enableClustering()
• disableClustering()
• addMarker(...)
• addMarkers(...)
• removeMarker(...)
• removeMarkers(...)
• destroy()
• setCamera(...)
• setMapType(...)
• enableIndoorMaps(...)
• enableTrafficLayer(...)
• enableAccessibilityElements(...)
• enableCurrentLocation(...)
• setPadding(...)
• setOnBoundsChangedListener(...)
• setOnCameraIdleListener(...)
• setOnCameraMoveStartedListener(...)
• setOnClusterClickListener(...)
• setOnClusterInfoWindowClickListener(...)
• setOnInfoWindowClickListener(...)
• setOnMapClickListener(...)
• setOnMarkerClickListener(...)
• setOnMyLocationButtonClickListener(...)
• setOnMyLocationClickListener(...)
• 接口
• 类型别名
• 枚举

create(...)

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

参数	类型
options	CreateMapArgs
callback	MapListenerCallback<MapReadyCallbackData>

返回值: Promise<GoogleMap>

---

enableClustering()

enableClustering() => Promise<void>

---

disableClustering()

disableClustering() => Promise<void>

---

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[]

---

destroy()

destroy() => Promise<void>

---

setCamera(...)

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

参数	类型
config	CameraConfig

---

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

---

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>

---

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 视图将挂载的 DOM 元素，用于确定大小和位置。
forceCreate	boolean	如果已存在具有提供 id 的地图实例，则销毁并重新创建地图实例	false

GoogleMapConfig

属性	类型	描述	默认值
width	number	覆盖原生地图的宽度。
height	number	覆盖原生地图的高度。
x	number	覆盖原生地图的绝对 x 坐标位置。
y	number	覆盖原生地图的绝对 y 坐标位置。
center	LatLng	相机指向的地球上的默认位置。
zoom	number	设置地图的缩放级别。
androidLiteMode	boolean	在 Android 上启用基于图像的轻量模式。	false
devicePixelRatio	number	覆盖原生地图的像素比率。

LatLng

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

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

MapReadyCallbackData

属性	类型
mapId	string

Marker

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

属性	类型	描述	默认值
coordinate	LatLng	标记位置
opacity	number	设置标记的不透明度，介于 0（完全透明）和 1 之间（包含）。	1
title	string	标题，覆盖层的简短描述。
snippet	string	片段文本，在选择时显示在信息窗口中的标题下方。
isFlat	boolean	控制此标记是平贴在地球表面还是面向相机的广告牌。	false
iconUrl	string	要渲染的标记图标。
draggable	boolean	控制此标记是否可以通过交互方式拖动	false

CameraConfig

Google 地图相机的配置属性

属性	类型	描述	默认值
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

LatLngBounds

一个表示视口纬度和经度边界的接口。

属性	类型
southwest	LatLng
center	LatLng
northeast	LatLng

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

MyLocationButtonClickCallbackData

属性	类型
mapId	string

Type Aliases

MapListenerCallback

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

(data: T): void

枚举

MapType

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