@capacitor/google-maps

@capacitor/google-maps

Google maps on Capacitor

Install

npm install @capacitor/google-maps
npx cap sync

API

• create(...)
• enableClustering()
• disableClustering()
• addMarker(...)
• addMarkers(...)
• removeMarker(...)
• removeMarkers(...)
• destroy()
• setCamera(...)
• setMapType(...)
• enableIndoorMaps(...)
• enableTrafficLayer(...)
• enableAccessibilityElements(...)
• enableCurrentLocation(...)
• setPadding(...)
• setOnCameraIdleListener(...)
• setOnCameraMoveStartedListener(...)
• setOnClusterClickListener(...)
• setOnClusterInfoWindowClickListener(...)
• setOnInfoWindowClickListener(...)
• setOnMapClickListener(...)
• setOnMarkerClickListener(...)
• setOnMyLocationButtonClickListener(...)
• setOnMyLocationClickListener(...)
• Interfaces
• Type Aliases
• Enums

create(...)

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

Param	Type
options	CreateMapOptions
callback	MapListenerCallback

Returns: Promise<GoogleMap>

---

enableClustering()

enableClustering() => Promise<void>

---

disableClustering()

disableClustering() => Promise<void>

---

addMarker(...)

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

Param	Type
marker	Marker

Returns: Promise<string>

---

addMarkers(...)

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

Param	Type
markers	Marker[]

Returns: Promise<string[]>

---

removeMarker(...)

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

Param	Type
id	string

---

removeMarkers(...)

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

Param	Type
ids	string[]

---

destroy()

destroy() => Promise<void>

---

setCamera(...)

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

Param	Type
config	CameraConfig

---

setMapType(...)

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

Param	Type
mapType	MapType

---

enableIndoorMaps(...)

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

Param	Type
enabled	boolean

---

enableTrafficLayer(...)

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

Param	Type
enabled	boolean

---

enableAccessibilityElements(...)

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

Param	Type
enabled	boolean

---

enableCurrentLocation(...)

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

Param	Type
enabled	boolean

---

setPadding(...)

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

Param	Type
padding	MapPadding

---

setOnCameraIdleListener(...)

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

Param	Type
callback	MapListenerCallback

---

setOnCameraMoveStartedListener(...)

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

Param	Type
callback	MapListenerCallback

---

setOnClusterClickListener(...)

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

Param	Type
callback	MapListenerCallback

---

setOnClusterInfoWindowClickListener(...)

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

Param	Type
callback	MapListenerCallback

---

setOnInfoWindowClickListener(...)

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

Param	Type
callback	MapListenerCallback

---

setOnMapClickListener(...)

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

Param	Type
callback	MapListenerCallback

---

setOnMarkerClickListener(...)

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

Param	Type
callback	MapListenerCallback

---

setOnMyLocationButtonClickListener(...)

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

Param	Type
callback	MapListenerCallback

---

setOnMyLocationClickListener(...)

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

Param	Type
callback	MapListenerCallback

---

Interfaces

CreateMapOptions

Prop	Type
id	string
apiKey	string
config	GoogleMapConfig
element	HTMLElement
forceCreate	boolean

GoogleMapConfig

Prop	Type
width	number
height	number
x	number
y	number
center	LatLng
zoom	number
androidLiteMode	boolean

LatLng

Prop	Type
lat	number
lng	number

Marker

Prop	Type
coordinate	LatLng
opacity	number
title	string
snippet	string
isFlat	boolean
iconUrl	string
draggable	boolean

CameraConfig

Prop	Type
coordinate	LatLng
zoom	number
bearing	number
angle	number
animate	boolean
animationDuration	number

MapPadding

Prop	Type
top	number
left	number
right	number
bottom	number

Type Aliases

MapListenerCallback

(data: any): void

Enums

MapType

Members	Value
Normal	'Normal'
Hybrid	'Hybrid'
Satellite	'Satellite'
Terrain	'Terrain'
None	'None'