github/awesome-cordova-plugins
github/awesome-cordova-plugins
2
0
Fork 1
mirror of https://github.com/danielsogl/awesome-cordova-plugins.git synced 2025-02-22 01:19:36 +08:00
Code Issues Projects Releases Wiki Activity

Merge pull request #392 from tlaverdure/docs(google-maps)

Browse Source 
docs(google maps) - Updates to Google Maps docs
This commit is contained in:
Max Lynch 2016-08-04 09:43:06 -05:00 committed by GitHub
commit 9d03a6009b
1 changed files with 27 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/plugins/googlemaps.ts
View File

@ -51,7 +51,9 @@ export const GoogleMapsAnimation = {
* ... * ...
* *
* // somewhere in your component * // 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!')); * map.on(GoogleMapsEvent.MAP_READY).subscribe(() => console.log('Map is ready!'));
* ``` * ```
@ -65,8 +67,9 @@ export class GoogleMap {
_objectInstance: any; _objectInstance: any;
/** /**
* Checks if a map object has been created. * Checks if a map object has been created and is available.
* @return {Promise<boolean>} returns a promise that resolves with a boolean that indicates if the plugin is available. *
* @return {Promise<boolean>}
*/ */
@Cordova() @Cordova()
static isAvailable(): Promise<boolean> { static isAvailable(): Promise<boolean> {
@ -76,7 +79,12 @@ export class GoogleMap {
constructor(elementId: string, options?: any) { constructor(elementId: string, options?: any) {
this._objectInstance = plugin.google.maps.Map.getMap(document.getElementById(elementId), options); this._objectInstance = plugin.google.maps.Map.getMap(document.getElementById(elementId), options);
} }
/**
* Listen to a map event.
*
* @return {Observable<any>}
*/
on(event: any): Observable<any> { on(event: any): Observable<any> {
return new Observable( return new Observable(
(observer) => { (observer) => {
@ -85,14 +93,18 @@ export class GoogleMap {
} }
); );
} }
/**
* Listen to a map event only once.
*
* @return {Promise<any>}
*/
one(event: any): Promise<any> { one(event: any): Promise<any> {
return new Promise<any>( return new Promise<any>(
resolve => this._objectInstance.one(event, resolve) resolve => this._objectInstance.one(event, resolve)
); );
} }
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
setDebuggable(isDebuggable: boolean): void { 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<CameraPosition>}
*/ */
@CordovaInstance() @CordovaInstance()
getCameraPosition(): Promise<CameraPosition> { getCameraPosition(): Promise<CameraPosition> {
@ -110,7 +124,9 @@ export class GoogleMap {
} }
/** /**
* Get the location of the user * Get the location of the user.
*
* @return {Promise<MyLocation>}
*/ */
@CordovaInstance() @CordovaInstance()
getMyLocation(): Promise<MyLocation> { getMyLocation(): Promise<MyLocation> {
@ -118,7 +134,9 @@ export class GoogleMap {
} }
/** /**
* Get the visible region * Get the visible region.
*
* @return {Promise<VisibleRegion>}
*/ */
@CordovaInstance() @CordovaInstance()
getVisibleRegion(): Promise<VisibleRegion> { getVisibleRegion(): Promise<VisibleRegion> {