docs(googlemap): add docs for GoogleMapsMarker

This commit is contained in:
Ionitron 2016-12-04 12:54:25 -05:00
parent 54ef50178b
commit 1e1aaad7aa

View File

@ -540,78 +540,178 @@ export class GoogleMapsMarker {
@CordovaInstance({sync: true}) @CordovaInstance({sync: true})
set(key: string, value: any): void { } set(key: string, value: any): void { }
/**
* Return true if the marker is visible
*/
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
isVisible(): boolean { return; } isVisible(): boolean { return; }
/**
* Set false if you want to hide the marker.
* @param visible
*/
@CordovaInstance() @CordovaInstance()
setVisible(visible: boolean): void { } setVisible(visible: boolean): void { }
/**
* Return the marker hash code.
* @return {string} Marker hash code
*/
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
getHashCode(): string { return; } getHashCode(): string { return; }
/**
* Remove the marker completely.
*/
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
remove(): void { } remove(): void { }
/**
* Change the marker opacity.
* @param alpha {number} Opacity
*/
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
setOpacity(alpha: number): void { } setOpacity(alpha: number): void { }
/**
* Return the marker opacity.
* @return {number} Opacity
*/
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
getOpacity(): number { return; } 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 }) @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 }) @CordovaInstance({ sync: true })
setIconAnchor(x: number, y: number): void { } 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 }) @CordovaInstance({ sync: true })
setInfoWindowAnchor(x: number, y: number): void { } setInfoWindowAnchor(x: number, y: number): void { }
/**
* Set true if you allows all users to drag the marker.
* @param draggable {boolean}
*/
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
setDraggable(draggable: boolean): void { } setDraggable(draggable: boolean): void { }
/**
* Return true if the marker drag is enabled.
* @return {boolean}
*/
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
isDraggable(): boolean { return; } isDraggable(): boolean { return; }
/**
* Set true if you want to be flat marker.
* @param flat {boolean}
*/
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
setFlat(flat: boolean): void { return; } setFlat(flat: boolean): void { return; }
/**
* Change icon url and/or size
* @param icon
*/
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
setIcon(icon: GoogleMapsMarkerIcon): void { return; } setIcon(icon: GoogleMapsMarkerIcon): void { return; }
/**
* Change title of the infoWindow.
* @param title {string}
*/
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
setTitle(title: string): void { } setTitle(title: string): void { }
/**
* Return the title strings.
* @return {string}
*/
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
getTitle(): string { return; } getTitle(): string { return; }
/**
* Change snippet of the infoWindow.
* @param snippet {string}
*/
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
setSnippet(snippet: string): void { } setSnippet(snippet: string): void { }
/**
* Return the snippet strings.
* @return {string}
*/
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
getSnippet(): string { return; } getSnippet(): string { return; }
/**
* Set the marker rotation angle.
* @param rotation {number}
*/
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
setRotation(rotation: number): void { } setRotation(rotation: number): void { }
/**
* Return the marker rotation angle.
* @return {number}
*/
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
getRotation(): number { return; } getRotation(): number { return; }
/**
* Show the infoWindow of the marker.
* @return {number}
*/
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
showInfoWindow(): number { return; } showInfoWindow(): number { return; }
/**
* Hide the infoWindow of the marker.
* @return {number}
*/
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
hideInfoWindow(): number { return; } hideInfoWindow(): number { return; }
/**
* Set the marker position.
* @param latLng {GoogleMapLatLng}
*/
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
setPosition(latLng: GoogleMapsLatLng): void { return; } setPosition(latLng: GoogleMapsLatLng): void { return; }
/**
* Return the marker position.
* @return {Promise<GoogleMapLatLng>}
*/
@CordovaInstance() @CordovaInstance()
getPosition(): Promise<GoogleMapsLatLng> { return; } getPosition(): Promise<GoogleMapsLatLng> { return; }
/**
* Return the map instance.
* @return {GoogleMap}
*/
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
getMap(): GoogleMap { return; } getMap(): GoogleMap { return; }
/**
* Specify the animation either `DROP` or `BOUNCE`
* @param animation {string}
*/
@CordovaInstance({ sync: true }) @CordovaInstance({ sync: true })
setAnimation(animation: string): void { } setAnimation(animation: string): void { }