@capacitor/google-maps

@capacitor/google-maps

Google maps on Capacitor

Install

npm install @capacitor/google-maps
npx cap sync

API

• create(...)
• addMarker(...)
• addMarkers(...)
• removeMarker(...)
• removeMarkers(...)
• enableClustering(...)
• disableClustering(...)
• destroy(...)
• setCamera(...)
• setMapType(...)
• enableIndoorMaps(...)
• enableTrafficLayer(...)
• enableAccessibilityElements(...)
• enableCurrentLocation(...)
• setPadding(...)
• onScroll(...)
• addListener('onCameraIdle', ...)
• addListener('onCameraMoveStarted', ...)
• addListener('onClusterClick', ...)
• addListener('onClusterInfoWindowClick', ...)
• addListener('onInfoWindowClick', ...)
• addListener('onMapReady', ...)
• addListener('onMapClick', ...)
• addListener('onMarkerClick', ...)
• addListener('onMyLocationButtonClick', ...)
• addListener('onMyLocationClick', ...)
• Interfaces
• Type Aliases
• Enums

create(...)

create(args: CreateMapArgs) => Promise<void>

Param	Type
args	CreateMapArgs

---

addMarker(...)

addMarker(args: AddMarkerArgs) => Promise<{ id: string; }>

Param	Type
args	AddMarkerArgs

Returns: Promise<{ id: string; }>

---

addMarkers(...)

addMarkers(args: AddMarkersArgs) => Promise<{ ids: string[]; }>

Param	Type
args	AddMarkersArgs

Returns: Promise<{ ids: string[]; }>

---

removeMarker(...)

removeMarker(args: RemoveMarkerArgs) => Promise<void>

Param	Type
args	RemoveMarkerArgs

---

removeMarkers(...)

removeMarkers(args: RemoveMarkersArgs) => Promise<void>

Param	Type
args	RemoveMarkersArgs

---

enableClustering(...)

enableClustering(args: { id: string; }) => Promise<void>

Param	Type
args	{ id: string; }

---

disableClustering(...)

disableClustering(args: { id: string; }) => Promise<void>

Param	Type
args	{ id: string; }

---

destroy(...)

destroy(args: DestroyMapArgs) => Promise<void>

Param	Type
args	DestroyMapArgs

---

setCamera(...)

setCamera(args: CameraArgs) => Promise<void>

Param	Type
args	CameraArgs

---

setMapType(...)

setMapType(args: MapTypeArgs) => Promise<void>

Param	Type
args	MapTypeArgs

---

enableIndoorMaps(...)

enableIndoorMaps(args: IndoorMapArgs) => Promise<void>

Param	Type
args	IndoorMapArgs

---

enableTrafficLayer(...)

enableTrafficLayer(args: TrafficLayerArgs) => Promise<void>

Param	Type
args	TrafficLayerArgs

---

enableAccessibilityElements(...)

enableAccessibilityElements(args: AccElementsArgs) => Promise<void>

Param	Type
args	AccElementsArgs

---

enableCurrentLocation(...)

enableCurrentLocation(args: CurrentLocArgs) => Promise<void>

Param	Type
args	CurrentLocArgs

---

setPadding(...)

setPadding(args: PaddingArgs) => Promise<void>

Param	Type
args	PaddingArgs

---

onScroll(...)

onScroll(args: OnScrollArgs) => Promise<void>

Param	Type
args	OnScrollArgs

---

addListener('onCameraIdle', ...)

addListener(eventName: 'onCameraIdle', listenerFunc: MapListenerCallback) => PluginListenerHandle

Param	Type
eventName	'onCameraIdle'
listenerFunc	MapListenerCallback

Returns: PluginListenerHandle

---

addListener('onCameraMoveStarted', ...)

addListener(eventName: 'onCameraMoveStarted', listenerFunc: MapListenerCallback) => PluginListenerHandle

Param	Type
eventName	'onCameraMoveStarted'
listenerFunc	MapListenerCallback

Returns: PluginListenerHandle

---

addListener('onClusterClick', ...)

addListener(eventName: 'onClusterClick', listenerFunc: MapListenerCallback) => PluginListenerHandle

Param	Type
eventName	'onClusterClick'
listenerFunc	MapListenerCallback

Returns: PluginListenerHandle

---

addListener('onClusterInfoWindowClick', ...)

addListener(eventName: 'onClusterInfoWindowClick', listenerFunc: MapListenerCallback) => PluginListenerHandle

Param	Type
eventName	'onClusterInfoWindowClick'
listenerFunc	MapListenerCallback

Returns: PluginListenerHandle

---

addListener('onInfoWindowClick', ...)

addListener(eventName: 'onInfoWindowClick', listenerFunc: MapListenerCallback) => PluginListenerHandle

Param	Type
eventName	'onInfoWindowClick'
listenerFunc	MapListenerCallback

Returns: PluginListenerHandle

---

addListener('onMapReady', ...)

addListener(eventName: 'onMapReady', listenerFunc: MapListenerCallback) => PluginListenerHandle

Param	Type
eventName	'onMapReady'
listenerFunc	MapListenerCallback

Returns: PluginListenerHandle

---

addListener('onMapClick', ...)

addListener(eventName: 'onMapClick', listenerFunc: MapListenerCallback) => PluginListenerHandle

Param	Type
eventName	'onMapClick'
listenerFunc	MapListenerCallback

Returns: PluginListenerHandle

---

addListener('onMarkerClick', ...)

addListener(eventName: 'onMarkerClick', listenerFunc: MapListenerCallback) => PluginListenerHandle

Param	Type
eventName	'onMarkerClick'
listenerFunc	MapListenerCallback

Returns: PluginListenerHandle

---

addListener('onMyLocationButtonClick', ...)

addListener(eventName: 'onMyLocationButtonClick', listenerFunc: MapListenerCallback) => PluginListenerHandle

Param	Type
eventName	'onMyLocationButtonClick'
listenerFunc	MapListenerCallback

Returns: PluginListenerHandle

---

addListener('onMyLocationClick', ...)

addListener(eventName: 'onMyLocationClick', listenerFunc: MapListenerCallback) => PluginListenerHandle

Param	Type
eventName	'onMyLocationClick'
listenerFunc	MapListenerCallback

Returns: PluginListenerHandle

---

Interfaces

CreateMapArgs

Prop	Type
id	string
apiKey	string
config	GoogleMapConfig
element	HTMLElement
frame	{ x: number; y: number; width: number; height: number; }
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

AddMarkerArgs

Prop	Type
id	string
marker	Marker

Marker

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

AddMarkersArgs

Prop	Type
id	string
markers	Marker[]

RemoveMarkerArgs

Prop	Type
id	string
markerId	string

RemoveMarkersArgs

Prop	Type
id	string
markerIds	string[]

DestroyMapArgs

Prop	Type
id	string

CameraArgs

Prop	Type
id	string
config	CameraConfig

CameraConfig

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

MapTypeArgs

Prop	Type
id	string
mapType	MapType

IndoorMapArgs

Prop	Type
id	string
enabled	boolean

TrafficLayerArgs

Prop	Type
id	string
enabled	boolean

AccElementsArgs

Prop	Type
id	string
enabled	boolean

CurrentLocArgs

Prop	Type
id	string
enabled	boolean

PaddingArgs

Prop	Type
id	string
padding	MapPadding

MapPadding

Prop	Type
top	number
left	number
right	number
bottom	number

OnScrollArgs

Prop	Type
id	string
frame	{ x: number; y: number; width: number; height: number; }
mapBounds	{ x: number; y: number; width: number; height: number; }

PluginListenerHandle

Prop	Type
remove	() => Promise<void>

Type Aliases

MapListenerCallback

(data: any): void

Enums

MapType

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