From 1e1aaad7aa2042941065294bc542ca3fc6694323 Mon Sep 17 00:00:00 2001 From: Ionitron Date: Sun, 4 Dec 2016 12:54:25 -0500 Subject: [PATCH] docs(googlemap): add docs for GoogleMapsMarker --- src/plugins/googlemap.ts | 102 ++++++++++++++++++++++++++++++++++++++- 1 file changed, 101 insertions(+), 1 deletion(-) diff --git a/src/plugins/googlemap.ts b/src/plugins/googlemap.ts index 83b33ccb..ffac08cd 100644 --- a/src/plugins/googlemap.ts +++ b/src/plugins/googlemap.ts @@ -540,78 +540,178 @@ export class GoogleMapsMarker { @CordovaInstance({sync: true}) set(key: string, value: any): void { } + /** + * Return true if the marker is visible + */ @CordovaInstance({ sync: true }) isVisible(): boolean { return; } + /** + * Set false if you want to hide the marker. + * @param visible + */ @CordovaInstance() setVisible(visible: boolean): void { } + /** + * Return the marker hash code. + * @return {string} Marker hash code + */ @CordovaInstance({ sync: true }) getHashCode(): string { return; } + /** + * Remove the marker completely. + */ @CordovaInstance({ sync: true }) remove(): void { } + /** + * Change the marker opacity. + * @param alpha {number} Opacity + */ @CordovaInstance({ sync: true }) setOpacity(alpha: number): void { } + /** + * Return the marker opacity. + * @return {number} Opacity + */ @CordovaInstance({ sync: true }) getOpacity(): number { return; } + /** + * iOS only, Plugin Version >= 1.3.3 Higher zIndex value overlays will be drawn on top of lower zIndex value tile layers and overlays. (You're able to run this on Android, but it will have no effect) + * @return {number} + */ @CordovaInstance({ sync: true }) - setZIndex(): void { } + setZIndex(): number { return; } + /** + * Change the info window anchor. This defaults to 50% from the left of the image and at the bottom of the image. + * @param x {number} + * @param y {number} + */ @CordovaInstance({ sync: true }) setIconAnchor(x: number, y: number): void { } + /** + * Change the info window anchor. This defaults to 50% from the left of the image and at the top of the image. + * @param x {number} + * @param y {number} + */ @CordovaInstance({ sync: true }) setInfoWindowAnchor(x: number, y: number): void { } + /** + * Set true if you allows all users to drag the marker. + * @param draggable {boolean} + */ @CordovaInstance({ sync: true }) setDraggable(draggable: boolean): void { } + /** + * Return true if the marker drag is enabled. + * @return {boolean} + */ @CordovaInstance({ sync: true }) isDraggable(): boolean { return; } + /** + * Set true if you want to be flat marker. + * @param flat {boolean} + */ @CordovaInstance({ sync: true }) setFlat(flat: boolean): void { return; } + /** + * Change icon url and/or size + * @param icon + */ @CordovaInstance({ sync: true }) setIcon(icon: GoogleMapsMarkerIcon): void { return; } + /** + * Change title of the infoWindow. + * @param title {string} + */ @CordovaInstance({ sync: true }) setTitle(title: string): void { } + /** + * Return the title strings. + * @return {string} + */ @CordovaInstance({ sync: true }) getTitle(): string { return; } + /** + * Change snippet of the infoWindow. + * @param snippet {string} + */ @CordovaInstance({ sync: true }) setSnippet(snippet: string): void { } + /** + * Return the snippet strings. + * @return {string} + */ @CordovaInstance({ sync: true }) getSnippet(): string { return; } + /** + * Set the marker rotation angle. + * @param rotation {number} + */ @CordovaInstance({ sync: true }) setRotation(rotation: number): void { } + /** + * Return the marker rotation angle. + * @return {number} + */ @CordovaInstance({ sync: true }) getRotation(): number { return; } + /** + * Show the infoWindow of the marker. + * @return {number} + */ @CordovaInstance({ sync: true }) showInfoWindow(): number { return; } + /** + * Hide the infoWindow of the marker. + * @return {number} + */ @CordovaInstance({ sync: true }) hideInfoWindow(): number { return; } + /** + * Set the marker position. + * @param latLng {GoogleMapLatLng} + */ @CordovaInstance({ sync: true }) setPosition(latLng: GoogleMapsLatLng): void { return; } + /** + * Return the marker position. + * @return {Promise} + */ @CordovaInstance() getPosition(): Promise { return; } + /** + * Return the map instance. + * @return {GoogleMap} + */ @CordovaInstance({ sync: true }) getMap(): GoogleMap { return; } + /** + * Specify the animation either `DROP` or `BOUNCE` + * @param animation {string} + */ @CordovaInstance({ sync: true }) setAnimation(animation: string): void { }