docs(googlemap): add docs for GoogleMapsMarkerOptions

This commit is contained in:
Ionitron 2016-12-04 12:57:46 -05:00
parent 1e1aaad7aa
commit c1398eb54b

View File

@ -481,20 +481,79 @@ export interface VisibleRegion {
* @private * @private
*/ */
export interface GoogleMapsMarkerOptions { export interface GoogleMapsMarkerOptions {
/**
* The icon image url or properties. Also you can specify HTML Color values. Alternatively you can specify the image as Base64
*/
icon?: any; icon?: any;
/**
* The content of the infoWindow.
*/
title?: string; title?: string;
/**
* The snippet of the infoWindow.
*/
snippet?: string; snippet?: string;
/**
* The position of the marker.
*/
position?: GoogleMapsLatLng; position?: GoogleMapsLatLng;
/**
* Specify the anchor of the InfoWindow
*/
infoWindowAnchor?: number[]; infoWindowAnchor?: number[];
/**
* Set true if you want to enable to drag the marker. (Default: false) Important! Drag starts after long pressed on the marker.
*/
draggable?: boolean; draggable?: boolean;
/**
* Set true if you want to use a flat marker. (Default: false)
*/
flat?: boolean; flat?: boolean;
/**
* Set rotation angle. (Default: 0)
*/
rotation?: number; rotation?: number;
/**
* Set false if you want to hide. (Default: true)
*/
visible?: boolean; visible?: boolean;
/**
* Specify the options for title.
*/
styles?: any; styles?: any;
/**
* Which animation to play when marker is added to a map.
*/
animation?: string; animation?: string;
/**
* 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)
*/
zIndex?: number; zIndex?: number;
/**
* Set to true to disable auto panning when the marker is clicked.
*/
disableAutoPan?: boolean; disableAutoPan?: boolean;
/**
* Function to be invoked when the user clicks on the marker
*/
markerClick?: Function; markerClick?: Function;
/**
* Function to be invoked when the user clicks on the info box
*/
infoClick?: Function; infoClick?: Function;
} }