diff --git a/src/plugins/googlemaps.ts b/src/plugins/googlemaps.ts index 231a91449..96dff4bda 100644 --- a/src/plugins/googlemaps.ts +++ b/src/plugins/googlemaps.ts @@ -51,7 +51,9 @@ export const GoogleMapsAnimation = { * ... * * // somewhere in your component - * let map = new GoogleMap('elementID'); + * let map = new GoogleMap('elementID', { + * // Map Options: https://developers.google.com/maps/documentation/javascript/3.exp/reference#MapOptions + }); * * map.on(GoogleMapsEvent.MAP_READY).subscribe(() => console.log('Map is ready!')); * ``` @@ -65,8 +67,9 @@ export class GoogleMap { _objectInstance: any; /** - * Checks if a map object has been created. - * @return {Promise} returns a promise that resolves with a boolean that indicates if the plugin is available. + * Checks if a map object has been created and is available. + * + * @return {Promise} */ @Cordova() static isAvailable(): Promise { @@ -76,7 +79,12 @@ export class GoogleMap { constructor(elementId: string, options?: any) { this._objectInstance = plugin.google.maps.Map.getMap(document.getElementById(elementId), options); } - + + /** + * Listen to a map event. + * + * @return {Observable} + */ on(event: any): Observable { return new Observable( (observer) => { @@ -85,14 +93,18 @@ export class GoogleMap { } ); } - + + /** + * Listen to a map event only once. + * + * @return{ Promise} + */ one(event: any): Promise { return new Promise( resolve => this._objectInstance.one(event, resolve) ); } - @CordovaInstance({ sync: true }) setDebuggable(isDebuggable: boolean): void { } @@ -102,7 +114,9 @@ export class GoogleMap { } /** - * Get the position of the camera + * Get the position of the camera. + * + * @return {Promise} */ @CordovaInstance() getCameraPosition(): Promise { @@ -110,7 +124,9 @@ export class GoogleMap { } /** - * Get the location of the user + * Get the location of the user. + * + * @return {Promise} */ @CordovaInstance() getMyLocation(): Promise { @@ -118,7 +134,9 @@ export class GoogleMap { } /** - * Get the visible region + * Get the visible region. + * + * @return {Promise} */ @CordovaInstance() getVisibleRegion(): Promise {