public/awesome-cordova-plugins
public/awesome-cordova-plugins
9
0
Fork 0
forked from github/awesome-cordova-plugins
Code Pull Requests Activity

docs(googleMaps): clean up extra docs

Browse Source
This commit is contained in:
mhartington 2016-06-09 16:48:40 -04:00
parent 46a656fcbc
commit 4875f66b7a
1 changed files with 86 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
src/plugins/googlemaps.ts
View File

@ -2,10 +2,12 @@ import {Cordova, Plugin} from './plugin';
import {Observable} from 'rxjs/Observable'; import {Observable} from 'rxjs/Observable';
import {CordovaInstance} from './plugin'; import {CordovaInstance} from './plugin';
/** /**
* @private
* Created by Ibrahim on 3/29/2016. * Created by Ibrahim on 3/29/2016.
*/ */
declare var plugin: any; declare var plugin: any;
/** /**
* @private
* You can listen to these events where appropriate * You can listen to these events where appropriate
*/ */
export const GoogleMapsEvent = { export const GoogleMapsEvent = {
@ -29,10 +31,14 @@ export const GoogleMapsEvent = {
MARKER_DRAG_END: 'drag_end' MARKER_DRAG_END: 'drag_end'
}; };
/**
* @private
*/
export const GoogleMapsAnimation = { export const GoogleMapsAnimation = {
BOUNCE: 'BOUNCE', BOUNCE: 'BOUNCE',
DROP: 'DROP' DROP: 'DROP'
}; };
/** /**
* @name Google Maps * @name Google Maps
* @description This plugin uses the native Google Maps SDK * @description This plugin uses the native Google Maps SDK
@ -352,6 +358,10 @@ export class GoogleMap {
} }
} }
/**
* @private
*/
export interface AnimateCameraOptions { export interface AnimateCameraOptions {
target?: GoogleMapsLatLng; target?: GoogleMapsLatLng;
tilt?: number; tilt?: number;
@ -359,22 +369,38 @@ export interface AnimateCameraOptions {
bearing?: number; bearing?: number;
duration?: number; duration?: number;
} }
/**
* @private
*/
export interface CameraPosition { export interface CameraPosition {
target?: GoogleMapsLatLng; target?: GoogleMapsLatLng;
zoom?: number; zoom?: number;
tilt?: number; tilt?: number;
bearing?: number; bearing?: number;
} }
/**
* @private
*/
export interface MyLocation { export interface MyLocation {
latLng?: GoogleMapsLatLng; latLng?: GoogleMapsLatLng;
speed?: number; speed?: number;
time?: string; time?: string;
bearing?: number; bearing?: number;
} }
/**
* @private
*/
export interface VisibleRegion { export interface VisibleRegion {
northeast?: any; northeast?: any;
southwest?: any; southwest?: any;
} }
/**
* @private
*/
export interface GoogleMapsMarkerOptions { export interface GoogleMapsMarkerOptions {
icon?: any; icon?: any;
title?: string; title?: string;
@ -389,6 +415,10 @@ export interface GoogleMapsMarkerOptions {
animation?: string; animation?: string;
zIndex?: number; zIndex?: number;
} }
/**
* @private
*/
export interface GoogleMapsMarkerIcon { export interface GoogleMapsMarkerIcon {
url?: string; url?: string;
size?: { size?: {
@ -396,6 +426,10 @@ export interface GoogleMapsMarkerIcon {
height?: number; height?: number;
}; };
} }
/**
* @private
*/
export class GoogleMapsMarker { export class GoogleMapsMarker {
constructor(private _objectInstance: any) { constructor(private _objectInstance: any) {
@ -573,6 +607,10 @@ export class GoogleMapsMarker {
} }
/**
* @private
*/
export interface GoogleMapsCircleOptions { export interface GoogleMapsCircleOptions {
center?: GoogleMapsLatLng; center?: GoogleMapsLatLng;
radius?: number; radius?: number;
@ -582,6 +620,10 @@ export interface GoogleMapsCircleOptions {
visible?: boolean; visible?: boolean;
zIndex?: number; zIndex?: number;
} }
/**
* @private
*/
export class GoogleMapsCircle { export class GoogleMapsCircle {
constructor(private _objectInstance: any) { constructor(private _objectInstance: any) {
@ -689,6 +731,10 @@ export class GoogleMapsCircle {
} }
/**
* @private
*/
export interface GoogleMapsPolylineOptions { export interface GoogleMapsPolylineOptions {
points?: Array<GoogleMapsLatLng>; points?: Array<GoogleMapsLatLng>;
visible?: boolean; visible?: boolean;
@ -697,6 +743,10 @@ export interface GoogleMapsPolylineOptions {
width?: number; width?: number;
zIndex?: number; zIndex?: number;
} }
/**
* @private
*/
export class GoogleMapsPolyline { export class GoogleMapsPolyline {
constructor(private _objectInstance: any) { constructor(private _objectInstance: any) {
} }
@ -770,6 +820,10 @@ export class GoogleMapsPolyline {
} }
} }
/**
* @private
*/
export interface GoogleMapsPolygonOptions { export interface GoogleMapsPolygonOptions {
points?: Array<GoogleMapsLatLng>; points?: Array<GoogleMapsLatLng>;
geodesic?: boolean; geodesic?: boolean;
@ -780,6 +834,10 @@ export interface GoogleMapsPolygonOptions {
zIndex?: number; zIndex?: number;
addHole?: Array<GoogleMapsLatLng>; addHole?: Array<GoogleMapsLatLng>;
} }
/**
* @private
*/
export class GoogleMapsPolygon { export class GoogleMapsPolygon {
constructor(private _objectInstance: any) { constructor(private _objectInstance: any) {
@ -862,6 +920,10 @@ export class GoogleMapsPolygon {
setGeodesic(geodesic: boolean): void { setGeodesic(geodesic: boolean): void {
} }
} }
/**
* @private
*/
export interface GoogleMapsTileOverlayOptions { export interface GoogleMapsTileOverlayOptions {
titleUrilFormat?: string; titleUrilFormat?: string;
visible?: boolean; visible?: boolean;
@ -869,6 +931,10 @@ export interface GoogleMapsTileOverlayOptions {
tileSize?: number; tileSize?: number;
opacity?: number; opacity?: number;
} }
/**
* @private
*/
export class GoogleMapsTileOverlay { export class GoogleMapsTileOverlay {
constructor(private _objectInstance: any) { constructor(private _objectInstance: any) {
@ -919,6 +985,10 @@ export class GoogleMapsTileOverlay {
} }
} }
/**
* @private
*/
export interface GoogleMapsGroundOverlayOptions { export interface GoogleMapsGroundOverlayOptions {
url?: string; url?: string;
bounds?: Array<GoogleMapsLatLng>; bounds?: Array<GoogleMapsLatLng>;
@ -927,6 +997,10 @@ export interface GoogleMapsGroundOverlayOptions {
bearing?: number; bearing?: number;
zIndex?: number; zIndex?: number;
} }
/**
* @private
*/
export class GoogleMapsGroundOverlay { export class GoogleMapsGroundOverlay {
constructor(private _objectInstance: any) { constructor(private _objectInstance: any) {
@ -968,11 +1042,19 @@ export class GoogleMapsGroundOverlay {
} }
} }
/**
* @private
*/
export interface GoogleMapsKmlOverlayOptions { export interface GoogleMapsKmlOverlayOptions {
url?: string; url?: string;
preserveViewport?: boolean; preserveViewport?: boolean;
animation?: boolean; animation?: boolean;
} }
/**
* @private
*/
export class GoogleMapsKmlOverlay { export class GoogleMapsKmlOverlay {
constructor(private _objectInstance: any) { constructor(private _objectInstance: any) {
@ -987,6 +1069,10 @@ export class GoogleMapsKmlOverlay {
return; return;
} }
} }
/**
* @private
*/
export class GoogleMapsLatLng { export class GoogleMapsLatLng {
private _objectInstance: any; private _objectInstance: any;