@ionic-native/google-maps

constructor

constructor(initialData?: any);

method empty

empty: (noNotify?: boolean) => void;

• Removes all elements from the array.

  Parameter noNotify

  ? {boolean} [options] Set true to prevent remove_at events.

method filter

filter: (fn: (element: T, index: number) => boolean) => T[];

• The filter() method creates a new array with all elements that pass the test implemented by the provided function.

  Parameter fn

  {T[]} returns a new filtered array

method filterAsync

filterAsync: (
    fn: (element: T, callback: (result: boolean) => void) => void
) => Promise<T[]>;

• The filterAsync() method creates a new array with all elements that pass the test implemented by the provided function.

  Parameter fn

  Parameter callback

  {Promise<T[]>} returns a new filtered array

method forEach

forEach: (fn: (element: T, index?: number) => void) => void;

• Iterate over each element, calling the provided callback.

  Parameter fn

method forEachAsync

forEachAsync: (fn: (element: T, callback: () => void) => void) => Promise<void>;

• Iterate over each element, calling the provided callback.

  Parameter fn

  {Promise}

method getArray

getArray: () => T[];

• Returns a reference to the underlying Array. {Object[]}

method getAt

getAt: (index: number) => any;

• Returns the element at the specified index.

  Parameter index

  {Object}

method getLength

getLength: () => number;

• Returns the number of the elements. {number}

method indexOf

indexOf: (element: T) => number;

• The indexOf() method returns the first index at which a given element can be found in the array, or -1 if it is not present.

  Parameter element

  {number}

method insertAt

insertAt: (index: number, element: T, noNotify?: boolean) => void;

• Inserts an element at the specified index.

  Parameter index

  Parameter element

  Parameter noNotify

  ? {boolean} [options] Set true to prevent insert_at event. {Object}

method map

map: (fn: (element: T, index: number) => any) => any[];

• Iterate over each element, then Returns a new value. Then you can get the results of each callback.

  Parameter fn

  {Object[]} returns a new array with the results

method mapAsync

mapAsync: (
    fn: (element: T, callback: (newElement: any) => void) => void
) => Promise<any[]>;

• Iterate over each element, calling the provided callback. Then you can get the results of each callback.

  Parameter fn

  Parameter callback

  {Promise} returns a new array with the results

method mapSeries

mapSeries: (
    fn: (element: T, callback: (newElement: any) => void) => void
) => Promise<any[]>;

• Same as mapAsync, but keep the execution order

  Parameter fn

  Parameter callback

  {Promise} returns a new array with the results

method pop

pop: (noNotify?: boolean) => T;

• Removes the last element of the array and returns that element.

  Parameter noNotify

  ? {boolean} [options] Set true to prevent remove_at event. {Object}

method push

push: (element: T, noNotify?: boolean) => void;

• Adds one element to the end of the array and returns the new length of the array.

  Parameter element

  Parameter noNotify

  ? {boolean} Set true to prevent insert_at events.

method removeAt

removeAt: (index: number, noNotify?: boolean) => T;

• Removes an element from the specified index.

  Parameter index

  Parameter noNotify

  ? {boolean} [options] Set true to prevent remove_at event.

method reverse

reverse: () => void;

• The reverse() method reverses an array in place.

method setAt

setAt: (index: number, element: T, noNotify?: boolean) => void;

• Sets an element at the specified index.

  Parameter index

  Parameter element

  Parameter noNotify

  ? {boolean} [options] Set true to prevent set_at event.

method sort

sort: () => void;

• The sort() method sorts the elements of an array in place and returns the array.

constructor

constructor(objInstance?: any);

method addEventListener

addEventListener: (eventName: string) => Observable<any>;

• Adds an event listener.

  Parameter eventName

  event name you want to observe. {Observable}

method addEventListenerOnce

addEventListenerOnce: (eventName: string) => Promise<any>;

• Adds an event listener that works once.

  Parameter eventName

  event name you want to observe. {Promise}

method addListenerOnce

addListenerOnce: (eventName: string) => Promise<any>;

• Parameter eventName

  event name you want to observe. {Promise}

  Deprecated

  Adds an event listener that works once.

method bindTo

bindTo: (
    key: string,
    target: any,
    targetKey?: string,
    noNotify?: boolean
) => void;

• Bind a key to another object

  Parameter key

  The property name you want to observe.

  Parameter target

  The target object you want to observe.

  Parameter targetKey

  ? {string} [options] The property name you want to observe. If you omit this, the key argument is used.

  Parameter noNotify

  ? {boolean} [options] True if you want to prevent (key)_changed event when you bind first time, because the internal status is changed from undefined to something.

method destroy

destroy: () => void;

• Executes off() and empty()

method empty

empty: () => void;

• Clears all stored values

method get

get: (key: string) => any;

• Gets a value

  Parameter key

method hasEventListener

hasEventListener: () => boolean;

• Return true if this object has event listener for event name

  Parameter eventName

  Event name {boolean}

method off

off: (eventName?: string, listener?: (...parameters: any[]) => void) => void;

• Alias of removeEventListener

  Parameter eventName

  [options] Event name

  Parameter listener

  [options] Event listener

method on

on: (eventName: string) => Observable<any>;

• Alias of addEventListener

  Parameter key

  The property name you want to observe. {Observable}

method one

one: (eventName: string) => Promise<any>;

• Alias of addEventListenerOnce

  Parameter key

  The property name you want to observe. {Promise}

method removeEventListener

removeEventListener: (
    eventName?: string,
    listener?: (...parameters: any[]) => void
) => void;

• Remove event listener(s) The removeEventListener() has three usages: - removeEventListener("eventName", listenerFunction); This removes one particular event listener - removeEventListener("eventName"); This removes the event listeners that added for the event name. - removeEventListener(); This removes all listeners.

  Parameter eventName

  [options] Event name

  Parameter listener

  [options] Event listener

method set

set: (key: string, value: any, noNotify?: boolean) => void;

• Sets a value

  Parameter key

  The key name for the value. (key)_changed will be fired when you set value through this method.

  Parameter value

  Parameter noNotify

  [options] True if you want to prevent firing the (key)_changed event.

method trigger

trigger: (eventName: string, ...parameters: any[]) => void;

• Dispatch event.

  Parameter eventName

  Event name

  Parameter parameters

  [options] The data you want to pass to event listerners.

constructor

constructor(_map: GoogleMap, _objectInstance: any);

method getBounds

getBounds: () => LatLngBounds;

• Returns the latLngBounds (rectangle) that contains the circle. {LatLngBounds}

method getCenter

getCenter: () => ILatLng;

• Returns the current center position {ILatLng}

method getClickable

getClickable: () => boolean;

• Returns true if the circle is clickable. {boolean}

method getFillColor

getFillColor: () => string;

• Returns the current circle filling color (inner color). {string}

method getId

getId: () => string;

• Returns the ID of instance. {string}

method getMap

getMap: () => any;

• Returns the map instance. {GoogleMap}

method getRadius

getRadius: () => number;

• Returns the current circle radius. {number}

method getStrokeColor

getStrokeColor: () => string;

• Returns the current circle stroke color (outer color). {string}

method getStrokeWidth

getStrokeWidth: () => number;

• Returns the current circle stroke width (unit: pixel). {number}

method getVisible

getVisible: () => boolean;

• Returns true if the circle is visible. {boolean}

method getZIndex

getZIndex: () => number;

• Returns the current circle zIndex. {number}

method remove

remove: () => void;

• Remove the circle.

method setCenter

setCenter: (latLng: ILatLng) => void;

• Changes the center position.

  Parameter latLng

method setClickable

setClickable: (clickable: boolean) => void;

• Changes click-ability of the circle.

  Parameter clickable

method setFillColor

setFillColor: (color: string) => void;

• Changes the filling color (inner color).

  Parameter color

method setRadius

setRadius: (radius: number) => void;

• Changes the circle radius.

  Parameter radius

method setStrokeColor

setStrokeColor: (strokeColor: string) => void;

• Changes the stroke color (outter color).

  Parameter strokeColor

method setStrokeWidth

setStrokeWidth: (strokeWidth: number) => void;

• Changes the stroke width.

  Parameter strokeWidth

method setVisible

setVisible: (visible: boolean) => void;

• Set circle visibility

  Parameter visible

method setZIndex

setZIndex: (zIndex: number) => void;

• Changes the circle zIndex order.

  Parameter zIndex

method decodePath

static decodePath: (encoded: string, precision?: number) => ILatLng[];

• Decodes an encoded path string into a sequence of LatLngs.

  Parameter encoded

  an encoded path string

  Parameter precision

  ? {number} default: 5 {LatLng}

• This method is static. Please use Encoding.decodePath()

method encodePath

static encodePath: (path: ILatLng[] | BaseArrayClass<ILatLng>) => string;

• Encodes a sequence of LatLngs into an encoded path string.

  Parameter path

  a sequence of LatLngs {string}

• This method is static. Please use Encoding.encodePath()

method getLicenseInfo

static getLicenseInfo: () => Promise<any>;

• Get the open source software license information for Google Maps SDK for iOS. {Promise}

• This method is static. Please use Environment.getLicenseInfo()

method setBackgroundColor

static setBackgroundColor: (color: string) => void;

• Specifies the background color of the app.

  Parameter color

• This method is static. Please use Environment.setBackgroundColor()

method setEnv

static setEnv: (envOptions: EnvOptions) => void;

• Set environment variables.

method geocode

static geocode: (
    request: GeocoderRequest
) => Promise<GeocoderResult[] | BaseArrayClass<GeocoderResult[]>>;

• This method is static. Please use Geocoder.geocode()

• Converts position to address and vice versa

  Parameter request

  Request object with either an address or a position {Promise<GeocoderResult[] | BaseArrayClass>}

constructor

constructor(
    element: string | HTMLElement,
    options?: GoogleMapOptions,
    __timeout?: number
);

method addCircle

addCircle: (options: CircleOptions) => Promise<Circle | any>;

• Adds a circle

  Parameter options

  options {Promise}

method addCircleSync

addCircleSync: (options: CircleOptions) => Circle;

• Adds a circle in synchronous

  Parameter options

  options {Circle}

method addGroundOverlay

addGroundOverlay: (
    options: GroundOverlayOptions
) => Promise<GroundOverlay | any>;

• Adds a ground overlay

  Parameter options

  options {Promise}

method addGroundOverlaySync

addGroundOverlaySync: (options: GroundOverlayOptions) => GroundOverlay;

• Adds a ground overlay in synchronous

  Parameter options

  options {GroundOverlay}

method addKmlOverlay

addKmlOverlay: (options: KmlOverlayOptions) => Promise<KmlOverlay>;

• Adds a kml overlay

  Parameter options

  options {Promise}

method addMarker

addMarker: (options: MarkerOptions) => Promise<Marker | any>;

• Adds a marker

  Parameter options

  options {Promise}

method addMarkerCluster

addMarkerCluster: (
    options: MarkerClusterOptions
) => Promise<MarkerCluster | any>;

• Adds a marker cluster

  Parameter options

  options {Promise}

method addMarkerClusterSync

addMarkerClusterSync: (options: MarkerClusterOptions) => MarkerCluster;

• Adds a marker cluster in synchronous

  Parameter options

  options

  Returns

  {MarkerCluster}

method addMarkerSync

addMarkerSync: (options: MarkerOptions) => Marker;

• Adds a marker in synchronous

  Parameter options

  options

  Returns

  {Marker}

method addPolygon

addPolygon: (options: PolygonOptions) => Promise<Polygon | any>;

• Adds a polygon

  Parameter options

  options {Promise}

method addPolygonSync

addPolygonSync: (options: PolygonOptions) => Polygon;

• Adds a polygon in synchronous

  Parameter options

  options {Polygon}

method addPolyline

addPolyline: (options: PolylineOptions) => Promise<Polyline | any>;

• Adds a polyline

  Parameter options

  options {Promise}

method addPolylineSync

addPolylineSync: (options: PolylineOptions) => Polyline;

• Adds a polyline in synchronous

  Parameter options

  options {Polyline}

method addTileOverlay

addTileOverlay: (options: TileOverlayOptions) => Promise<TileOverlay | any>;

• Adds a tile overlay

  Parameter options

  options {Promise}

method addTileOverlaySync

addTileOverlaySync: (options: TileOverlayOptions) => TileOverlay;

• Adds a tile overlay in synchronous

  Parameter options

  options {TileOverlay}

method animateCamera

animateCamera: (cameraPosition: CameraPosition<any>) => Promise<any>;

• Moves the camera with animation {Promise}

method animateCameraZoomIn

animateCameraZoomIn: () => Promise<any>;

• Zooming in the camera with animation {Promise}

method animateCameraZoomOut

animateCameraZoomOut: () => Promise<any>;

• Zooming out the camera with animation {Promise}

method clear

clear: () => Promise<any>;

• Remove all overlays, such as marker {Promise}

method fromLatLngToPoint

fromLatLngToPoint: (latLng: ILatLng) => Promise<any[]>;

• Convert the unit from LatLng to the pixels from the left/top of the map div {Promise}

method fromPointToLatLng

fromPointToLatLng: (point: number[]) => Promise<LatLng>;

• Convert the unit from the pixels from the left/top to the LatLng {Promise}

method getCameraBearing

getCameraBearing: () => number;

• Get the current camera bearing {number}

method getCameraPosition

getCameraPosition: () => CameraPosition<ILatLng>;

• Get the position of the camera. {CameraPosition}

method getCameraTarget

getCameraTarget: () => ILatLng;

• Get the current camera target position {ILatLng}

method getCameraTilt

getCameraTilt: () => number;

• Get the current camera tilt (view angle) {number}

method getCameraZoom

getCameraZoom: () => number;

• Get the current camera zoom level {number}

method getDiv

getDiv: () => HTMLElement;

• Returns the map HTML element {HTMLElement}

method getFocusedBuilding

getFocusedBuilding: () => Promise<any>;

• Get the currently focused building {Promise}

method getMyLocation

getMyLocation: (options?: MyLocationOptions) => Promise<MyLocation>;

• Get the current device location {Promise}

method getVisibleRegion

getVisibleRegion: () => VisibleRegion;

• Get the current visible region (southWest and northEast) {VisibleRegion}

method moveCamera

moveCamera: (cameraPosition: CameraPosition<any>) => Promise<any>;

• Moves the camera without animation {Promise}

method moveCameraZoomIn

moveCameraZoomIn: () => Promise<any>;

• Zooming in the camera without animation {Promise}

method moveCameraZoomOut

moveCameraZoomOut: () => Promise<any>;

• Zooming out the camera without animation {Promise}

method panBy

panBy: (x: number, y: number) => void;

• Changes the center of the map by the given distance in pixels

  Parameter x

  Parameter y

method remove

remove: () => Promise<any>;

• Destroy a map completely {Promise}

method setAllGesturesEnabled

setAllGesturesEnabled: (enabled: boolean) => void;

• Sets the preference for whether all gestures should be enabled or disabled

  Parameter enabled

method setCameraBearing

setCameraBearing: (bearing: any) => void;

• Set camera bearing

  Parameter bearing

method setCameraTarget

setCameraTarget: (latLng: ILatLng | ILatLng[]) => void;

• Set the center position of the camera view

  Parameter latLng

method setCameraTilt

setCameraTilt: (tiltAngle: number) => void;

• Set the camera view angle

  Parameter tiltAngle

  Tilt angle

method setCameraZoom

setCameraZoom: (zoomLevel: number) => void;

• Set zoom level of the camera

  Parameter zoomLevel

  Zoom level

method setClickable

setClickable: (isClickable: boolean) => void;

• Set false to ignore all clicks on the map

  Parameter isClickable

method setCompassEnabled

setCompassEnabled: (enabled: boolean) => void;

• Set true if you want to show the compass button

  Parameter enabled

method setDiv

setDiv: (domNode?: HTMLElement | string) => void;

• Changes the map div

  Parameter domNode

  [options] If you want to display the map in an html element, you need to specify an element or id. If omit this argument, the map is detached from webview.

method setIndoorEnabled

setIndoorEnabled: (enabled: boolean) => void;

• Set true if you want to show the indoor map

  Parameter enabled

method setMapTypeId

setMapTypeId: (mapTypeId: MapType | string) => void;

• Changes the map type id

  Parameter mapTypeId

method setMyLocationButtonEnabled

setMyLocationButtonEnabled: (enabled: boolean) => void;

• Set true if you want to show the MyLocation button

  Parameter enabled

method setMyLocationEnabled

setMyLocationEnabled: (enabled: boolean) => void;

• Set true if you want to show the MyLocation control (blue dot)

  Parameter enabled

method setOptions

setOptions: (options: GoogleMapOptions) => void;

• Set options

  Parameter options

method setPadding

setPadding: (
    top: number,
    right?: number,
    bottom?: number,
    left?: number
) => void;

• Adjust the map padding (same as CSS padding rule)

  Parameter top

  Parameter right

  Parameter left

  Parameter bottom

method setTrafficEnabled

setTrafficEnabled: (enabled: boolean) => void;

• Set true if you want to show the traffic layer

  Parameter enabled

method setVisible

setVisible: (visible: boolean) => void;

• Set visibility of the map

  Parameter visible

method toDataURL

toDataURL: (options?: ToDataUrlOptions) => Promise<string>;

• Returns the base64 encoded screen capture of the map.

  Parameter options

  [options] options {Promise}

method create

static create: (
    element: string | HTMLElement | GoogleMapOptions,
    options?: GoogleMapOptions
) => GoogleMap;

• Creates a new GoogleMap instance

  Parameter element

  Element ID or reference to attach the map to

  Parameter options

  [options] Options {GoogleMap}

• keep this for backward compatibility.

method createPanorama

static createPanorama: (
    element: string | HTMLElement,
    options?: StreetViewOptions
) => StreetViewPanorama;

• Creates a new StreetView instance

  Parameter element

  Element ID or reference to attach the map to

  Parameter options

  [options] Options {StreetViewPanorama}

constructor

constructor(_map: GoogleMap, _objectInstance: any);

method getBearing

getBearing: () => number;

• Returns the current bearing value

method getClickable

getClickable: () => boolean;

• Returns true if the ground overlay is clickable {boolean}

method getId

getId: () => string;

• Returns the ID of instance. {string}

method getMap

getMap: () => any;

• Returns the map instance. {GoogleMap}

method getOpacity

getOpacity: () => number;

• Returns the current opacity {number}

method getVisible

getVisible: () => boolean;

• Returns true if the ground overlay is visible {boolean}

method getZIndex

getZIndex: () => number;

• Returns the current ground overlay zIndex {number}

method remove

remove: () => void;

• Remove the ground overlay

method setBearing

setBearing: (bearing: number) => void;

• Changes the bearing of the ground overlay

  Parameter bearing

method setBounds

setBounds: (bounds: ILatLng[]) => void;

• Changes the bounds of the GroundOverlay

  Parameter bounds

method setClickable

setClickable: (clickable: boolean) => void;

• Changes click-ability of the ground overlay

  Parameter clickable

method setImage

setImage: (imageUrl: string) => void;

• Changes the image of the ground overlay

  Parameter imageUrl

  URL of image

method setOpacity

setOpacity: (opacity: number) => void;

• Changes the opacity of the ground overlay from 0.0 to 1.0

  Parameter opacity

method setVisible

setVisible: (visible: boolean) => void;

• Changes visibility of the ground overlay

  Parameter visible

method setZIndex

setZIndex: (index: number) => void;

• Changes the ground overlay zIndex order

  Parameter index

constructor

constructor();

method close

close: () => void;

• Close the htmlInfoWindow

method open

open: (marker: any) => any;

• Open the htmlInfoWindow

  Parameter marker

method setBackgroundColor

setBackgroundColor: (color: string) => void;

• Changes the backgroundColor

  Parameter color

method setContent

setContent: (content: string | Element, cssOptions?: any) => void;

• Set your HTML contents.

  Parameter content

  String containing text or HTML element

  Parameter cssOptions

  ? {any} CSS styles for the container element of HTMLInfoWindow

constructor

constructor(_map: GoogleMap, _objectInstance: any);

method getClickable

getClickable: () => boolean;

• Returns true if the KmlOverlay is clickable {boolean}

method getDefaultViewport

getDefaultViewport: () => CameraPosition<ILatLng | ILatLng[]>;

• Returns the viewport to contains all overlays

method getId

getId: () => string;

• Returns the ID of instance. {string}

method getMap

getMap: () => GoogleMap;

• Returns the map instance. {GoogleMap}

method getVisible

getVisible: () => boolean;

• Returns true if the kml overlay is visible {boolean}

method remove

remove: () => void;

• Remove the KmlOverlay

method setClickable

setClickable: (clickable: boolean) => void;

• Changes click-ability of the KmlOverlay

  Parameter clickable

method setVisible

setVisible: (visible: boolean) => void;

• Changes visibility of the kml overlay

  Parameter visible

constructor

constructor(lat: number, lng: number);

property lat

lat: number;

property lng

lng: number;

method equals

equals: (other: ILatLng) => boolean;

method toString

toString: () => string;

method toUrlValue

toUrlValue: (precision?: number) => string;

constructor

constructor(points?: ILatLng[]);

property northeast

northeast: ILatLng;

property southwest

southwest: ILatLng;

property type

type: string;