@types/markerclustererplus
Advanced tools
Comparing version 2.1.31 to 2.1.32
@@ -46,3 +46,4 @@ // Type definitions for MarkerClustererPlus for Google Maps V3 2.1 | ||
textDecoration?: string; | ||
/** [fontWeight="bold"] The value of the CSS <code>font-weight</code> | ||
/** | ||
* [fontWeight="bold"] The value of the CSS <code>font-weight</code> | ||
* property for the label text shown on the cluster icon. | ||
@@ -72,10 +73,5 @@ */ | ||
/** | ||
* @name ClusterIconInfo | ||
* @class This class is an object containing general information about a cluster icon. This is | ||
* the object that a <code>calculator</code> function returns. | ||
* | ||
* @property {string} text The text of the label to be shown on the cluster icon. | ||
* @property {number} index The index plus 1 of the element in the <code>styles</code> | ||
* array to be used to style the cluster icon. | ||
* @property {string} title The tooltip to display when the mouse moves over the cluster icon. | ||
* If this value is <code>undefined</code> or <code>""</code>, <code>title</code> is set to the | ||
@@ -94,8 +90,6 @@ * value of the <code>title</code> property passed to the MarkerClusterer. | ||
* | ||
* @constructor | ||
* @extends google.maps.OverlayView | ||
* @param {Cluster} cluster The cluster with which the icon is to be associated. | ||
* @param {Array} [styles] An array of {@link ClusterIconStyle} defining the cluster icons | ||
* @param cluster The cluster with which the icon is to be associated. | ||
* @param [styles] An array of {@link ClusterIconStyle} defining the cluster icons | ||
* to use for various cluster sizes. | ||
* @private | ||
*/ | ||
@@ -132,3 +126,3 @@ constructor(cluster: Cluster, styles: ClusterIconStyle[]); | ||
* | ||
* @param {ClusterIconInfo} style The icon label text and styles index. | ||
* @param style The icon label text and styles index. | ||
*/ | ||
@@ -140,3 +134,3 @@ useStyle(style: ClusterIconInfo): void; | ||
* | ||
* @param {google.maps.LatLng} center The latlng to set as the center. | ||
* @param center The latlng to set as the center. | ||
*/ | ||
@@ -148,4 +142,4 @@ setCenter(center: google.maps.LatLng): void; | ||
* | ||
* @param {google.maps.Point} pos The position of the icon. | ||
* @return {string} The CSS style text. | ||
* @param pos The position of the icon. | ||
* @return The CSS style text. | ||
*/ | ||
@@ -157,4 +151,4 @@ createCss(pos: google.maps.Point): string; | ||
* | ||
* @param {google.maps.LatLng} latLng The position in latlng. | ||
* @return {google.maps.Point} The position in pixels. | ||
* @param latLng The position in latlng. | ||
* @return The position in pixels. | ||
*/ | ||
@@ -168,4 +162,3 @@ getPosFromLatLng_(latLng: google.maps.LatLng): google.maps.Point; | ||
* Used internally, do not call this constructor directly. | ||
* @constructor | ||
* @param {MarkerClusterer} mc The <code>MarkerClusterer</code> object with which this | ||
* @param mc The <code>MarkerClusterer</code> object with which this | ||
* cluster is associated. | ||
@@ -180,3 +173,3 @@ */ | ||
* | ||
* @return {number} The number of markers in the cluster. | ||
* @return The number of markers in the cluster. | ||
*/ | ||
@@ -190,3 +183,3 @@ getSize(): number; | ||
* | ||
* @return {Array} The array of markers in the cluster. | ||
* @return The array of markers in the cluster. | ||
*/ | ||
@@ -200,3 +193,3 @@ getMarkers(): google.maps.Marker[]; | ||
* | ||
* @return {google.maps.LatLng} The center of the cluster. | ||
* @return The center of the cluster. | ||
*/ | ||
@@ -208,3 +201,3 @@ getCenter(): google.maps.LatLng; | ||
* | ||
* @return {google.maps.Map} The map. | ||
* @return The map. | ||
* @ignore | ||
@@ -217,3 +210,3 @@ */ | ||
* | ||
* @return {MarkerClusterer} The associated marker clusterer. | ||
* @return The associated marker clusterer. | ||
* @ignore | ||
@@ -226,3 +219,3 @@ */ | ||
* | ||
* @return {google.maps.LatLngBounds} the cluster bounds. | ||
* @return the cluster bounds. | ||
* @ignore | ||
@@ -242,4 +235,4 @@ */ | ||
* | ||
* @param {google.maps.Marker} marker The marker to be added. | ||
* @return {boolean} True if the marker was added. | ||
* @param marker The marker to be added. | ||
* @return True if the marker was added. | ||
* @ignore | ||
@@ -252,4 +245,4 @@ */ | ||
* | ||
* @param {google.maps.Marker} marker The marker to check. | ||
* @return {boolean} True if the marker lies in the bounds. | ||
* @param marker The marker to check. | ||
* @return True if the marker lies in the bounds. | ||
* @ignore | ||
@@ -272,4 +265,4 @@ */ | ||
* | ||
* @param {google.maps.Marker} marker The marker to check. | ||
* @return {boolean} True if the marker has already been added. | ||
* @param marker The marker to check. | ||
* @return True if the marker has already been added. | ||
*/ | ||
@@ -287,3 +280,4 @@ isMarkerAlreadyAdded_(marker: google.maps.Marker): boolean; | ||
gridSize?: number; | ||
/** [maxZoom=null] The maximum zoom level at which clustering is enabled or | ||
/** | ||
* [maxZoom=null] The maximum zoom level at which clustering is enabled or | ||
* <code>null</code> if clustering is to be enabled at all zoom levels. | ||
@@ -405,7 +399,6 @@ */ | ||
* Creates a MarkerClusterer object with the options specified in {@link MarkerClustererOptions}. | ||
* @constructor | ||
* @extends google.maps.OverlayView | ||
* @param {google.maps.Map} map The Google map to attach to. | ||
* @param {Array.<google.maps.Marker>} [markers] The markers to be added to the cluster. | ||
* @param {MarkerClustererOptions} [options] The optional parameters. | ||
* @param map The Google map to attach to. | ||
* @param [markers] The markers to be added to the cluster. | ||
* @param [options] The optional parameters. | ||
*/ | ||
@@ -447,3 +440,3 @@ constructor(map: google.maps.Map, markers?: google.maps.Marker[], options?: MarkerClustererOptions); | ||
* | ||
* @return {number} The grid size. | ||
* @return The grid size. | ||
*/ | ||
@@ -455,3 +448,3 @@ getGridSize(): number; | ||
* | ||
* @param {number} gridSize The grid size. | ||
* @param gridSize The grid size. | ||
*/ | ||
@@ -463,3 +456,3 @@ setGridSize(gridSize: number): void; | ||
* | ||
* @return {number} The minimum cluster size. | ||
* @return The minimum cluster size. | ||
*/ | ||
@@ -471,3 +464,3 @@ getMinimumClusterSize(): number; | ||
* | ||
* @param {number} minimumClusterSize The minimum cluster size. | ||
* @param minimumClusterSize The minimum cluster size. | ||
*/ | ||
@@ -479,3 +472,3 @@ setMinimumClusterSize(minimumClusterSize: number): void; | ||
* | ||
* @return {number} The maximum zoom level. | ||
* @return The maximum zoom level. | ||
*/ | ||
@@ -487,3 +480,3 @@ getMaxZoom(): number; | ||
* | ||
* @param {number} maxZoom The maximum zoom level. | ||
* @param maxZoom The maximum zoom level. | ||
*/ | ||
@@ -495,3 +488,3 @@ setMaxZoom(maxZoom: number): void; | ||
* | ||
* @return {Array} The array of styles defining the cluster markers to be used. | ||
* @return The array of styles defining the cluster markers to be used. | ||
*/ | ||
@@ -503,3 +496,3 @@ getStyles(): ClusterIconStyle[]; | ||
* | ||
* @param {Array.<ClusterIconStyle>} styles The array of styles to use. | ||
* @param styles The array of styles to use. | ||
*/ | ||
@@ -511,3 +504,3 @@ setStyles(styles: ClusterIconStyle[]): void; | ||
* | ||
* @return {string} The content of the title text. | ||
* @return The content of the title text. | ||
*/ | ||
@@ -519,3 +512,3 @@ getTitle(): string; | ||
* | ||
* @param {string} title The value of the title property. | ||
* @param title The value of the title property. | ||
*/ | ||
@@ -527,3 +520,3 @@ setTitle(title: string): void; | ||
* | ||
* @return {boolean} True if zoomOnClick property is set. | ||
* @return True if zoomOnClick property is set. | ||
*/ | ||
@@ -535,3 +528,3 @@ getZoomOnClick(): boolean; | ||
* | ||
* @param {boolean} zoomOnClick The value of the zoomOnClick property. | ||
* @param zoomOnClick The value of the zoomOnClick property. | ||
*/ | ||
@@ -543,3 +536,3 @@ setZoomOnClick(zoomOnClick: boolean): void; | ||
* | ||
* @return {boolean} True if averageCenter property is set. | ||
* @return True if averageCenter property is set. | ||
*/ | ||
@@ -551,3 +544,3 @@ getAverageCenter(): boolean; | ||
* | ||
* @param {boolean} averageCenter The value of the averageCenter property. | ||
* @param averageCenter The value of the averageCenter property. | ||
*/ | ||
@@ -559,3 +552,3 @@ setAverageCenter(averageCenter: boolean): void; | ||
* | ||
* @return {boolean} True if ignoreHidden property is set. | ||
* @return True if ignoreHidden property is set. | ||
*/ | ||
@@ -567,3 +560,3 @@ getIgnoreHidden(): boolean; | ||
* | ||
* @param {boolean} ignoreHidden The value of the ignoreHidden property. | ||
* @param ignoreHidden The value of the ignoreHidden property. | ||
*/ | ||
@@ -575,3 +568,3 @@ setIgnoreHidden(ignoreHidden: boolean): void; | ||
* | ||
* @return {boolean} True if enableRetinaIcons property is set. | ||
* @return True if enableRetinaIcons property is set. | ||
*/ | ||
@@ -583,3 +576,3 @@ getEnableRetinaIcons(): boolean; | ||
* | ||
* @param {boolean} enableRetinaIcons The value of the enableRetinaIcons property. | ||
* @param enableRetinaIcons The value of the enableRetinaIcons property. | ||
*/ | ||
@@ -591,3 +584,3 @@ setEnableRetinaIcons(enableRetinaIcons: boolean): void; | ||
* | ||
* @return {string} The value of the imageExtension property. | ||
* @return The value of the imageExtension property. | ||
*/ | ||
@@ -599,3 +592,3 @@ getImageExtension(): string; | ||
* | ||
* @param {string} imageExtension The value of the imageExtension property. | ||
* @param imageExtension The value of the imageExtension property. | ||
*/ | ||
@@ -607,3 +600,3 @@ setImageExtension(imageExtension: string): void; | ||
* | ||
* @return {string} The value of the imagePath property. | ||
* @return The value of the imagePath property. | ||
*/ | ||
@@ -615,3 +608,3 @@ getImagePath(): string; | ||
* | ||
* @param {string} imagePath The value of the imagePath property. | ||
* @param imagePath The value of the imagePath property. | ||
*/ | ||
@@ -623,3 +616,3 @@ setImagePath(imagePath: string): void; | ||
* | ||
* @return {Array} The value of the imageSizes property. | ||
* @return The value of the imageSizes property. | ||
*/ | ||
@@ -631,3 +624,3 @@ getImageSizes(): number[]; | ||
* | ||
* @param {Array} imageSizes The value of the imageSizes property. | ||
* @param imageSizes The value of the imageSizes property. | ||
*/ | ||
@@ -639,3 +632,3 @@ setImageSizes(imageSizes: number[]): void; | ||
* | ||
* @return {function} the value of the calculator property. | ||
* @return the value of the calculator property. | ||
*/ | ||
@@ -647,3 +640,3 @@ getCalculator(): Calculator; | ||
* | ||
* @param {function(Array.<google.maps.Marker>, number)} calculator The value | ||
* @param calculator The value | ||
* of the calculator property. | ||
@@ -656,3 +649,3 @@ */ | ||
* | ||
* @param {boolean} printable The value of the hideLabel property. | ||
* @param printable The value of the hideLabel property. | ||
*/ | ||
@@ -664,3 +657,3 @@ setHideLabel(printable: boolean): void; | ||
* | ||
* @return {boolean} the value of the hideLabel property. | ||
* @return the value of the hideLabel property. | ||
*/ | ||
@@ -672,3 +665,3 @@ getHideLabel(): boolean; | ||
* | ||
* @return {number} the value of the batchSizeIE property. | ||
* @return the value of the batchSizeIE property. | ||
*/ | ||
@@ -680,3 +673,3 @@ getBatchSizeIE(): number; | ||
* | ||
* @param {number} batchSizeIE The value of the batchSizeIE property. | ||
* @param batchSizeIE The value of the batchSizeIE property. | ||
*/ | ||
@@ -688,3 +681,3 @@ setBatchSizeIE(batchSizeIE: number): void; | ||
* | ||
* @return {string} the value of the clusterClass property. | ||
* @return the value of the clusterClass property. | ||
*/ | ||
@@ -696,3 +689,3 @@ getClusterClass(): string; | ||
* | ||
* @param {string} clusterClass The value of the clusterClass property. | ||
* @param clusterClass The value of the clusterClass property. | ||
*/ | ||
@@ -704,3 +697,3 @@ setClusterClass(clusterClass: string): void; | ||
* | ||
* @return {Array} The array of markers managed by the clusterer. | ||
* @return The array of markers managed by the clusterer. | ||
*/ | ||
@@ -712,3 +705,3 @@ getMarkers(): google.maps.Marker[]; | ||
* | ||
* @return {number} The number of markers. | ||
* @return The number of markers. | ||
*/ | ||
@@ -720,3 +713,3 @@ getTotalMarkers(): number; | ||
* | ||
* @return {Array} The array of clusters formed by the clusterer. | ||
* @return The array of clusters formed by the clusterer. | ||
*/ | ||
@@ -728,3 +721,3 @@ getClusters(): Cluster[]; | ||
* | ||
* @return {number} The number of clusters formed by the clusterer. | ||
* @return The number of clusters formed by the clusterer. | ||
*/ | ||
@@ -737,4 +730,4 @@ getTotalClusters(): number; | ||
* | ||
* @param {google.maps.Marker} marker The marker to add. | ||
* @param {boolean} [noDraw] Set to <code>true</code> to prevent redrawing. | ||
* @param marker The marker to add. | ||
* @param [noDraw] Set to <code>true</code> to prevent redrawing. | ||
*/ | ||
@@ -747,4 +740,4 @@ addMarker(marker: google.maps.Marker, noDraw?: boolean): void; | ||
* | ||
* @param {Array.<google.maps.Marker>} markers The markers to add. | ||
* @param {boolean} [noDraw] Set to <code>true</code> to prevent redrawing. | ||
* @param markers The markers to add. | ||
* @param [noDraw] Set to <code>true</code> to prevent redrawing. | ||
*/ | ||
@@ -756,3 +749,3 @@ addMarkers(markers: google.maps.Marker[], noDraw?: boolean): void; | ||
* | ||
* @param {google.maps.Marker} marker The marker to add. | ||
* @param marker The marker to add. | ||
*/ | ||
@@ -766,6 +759,6 @@ pushMarkerTo_(marker: google.maps.Marker): void; | ||
* | ||
* @param {google.maps.Marker} marker The marker to remove. | ||
* @param {boolean} [noDraw] Set to <code>true</code> to prevent redrawing. | ||
* @param {boolean} [noMapRemove] Set to <code>true</code> to prevent removal from map but still removing from cluster management | ||
* @return {boolean} True if the marker was removed from the clusterer. | ||
* @param marker The marker to remove. | ||
* @param [noDraw] Set to <code>true</code> to prevent redrawing. | ||
* @param [noMapRemove] Set to <code>true</code> to prevent removal from map but still removing from cluster management | ||
* @return True if the marker was removed from the clusterer. | ||
*/ | ||
@@ -779,6 +772,6 @@ removeMarker(marker: google.maps.Marker, noDraw?: boolean, noMapRemove?: boolean): boolean; | ||
* | ||
* @param {Array.<google.maps.Marker>} markers The markers to remove. | ||
* @param {boolean} [noDraw] Set to <code>true</code> to prevent redrawing. | ||
* @param {boolean} [noMapRemove] Set to <code>true</code> to prevent removal from map but still removing from cluster management | ||
* @return {boolean} True if markers were removed from the clusterer. | ||
* @param markers The markers to remove. | ||
* @param [noDraw] Set to <code>true</code> to prevent redrawing. | ||
* @param [noMapRemove] Set to <code>true</code> to prevent removal from map but still removing from cluster management | ||
* @return True if markers were removed from the clusterer. | ||
*/ | ||
@@ -790,5 +783,5 @@ removeMarkers(markers: google.maps.Marker[], noDraw?: boolean, noMapRemove?: boolean): boolean; | ||
* | ||
* @param {google.maps.Marker} marker The marker to remove | ||
* @param {boolean} removeFromMap set to <code>true</code> to explicitly remove from map as well as cluster manangement | ||
* @return {boolean} Whether the marker was removed or not | ||
* @param marker The marker to remove | ||
* @param removeFromMap set to <code>true</code> to explicitly remove from map as well as cluster manangement | ||
* @return Whether the marker was removed or not | ||
*/ | ||
@@ -812,4 +805,4 @@ removeMarker_(marker: google.maps.Marker, removeFromMap?: boolean): boolean; | ||
* | ||
* @param {google.maps.LatLngBounds} bounds The bounds to extend. | ||
* @return {google.maps.LatLngBounds} The extended bounds. | ||
* @param bounds The bounds to extend. | ||
* @return The extended bounds. | ||
* @ignore | ||
@@ -828,3 +821,3 @@ */ | ||
* | ||
* @param {boolean} [hide] Set to <code>true</code> to also remove the markers | ||
* @param [hide] Set to <code>true</code> to also remove the markers | ||
* from the map. | ||
@@ -837,5 +830,5 @@ */ | ||
* | ||
* @param {google.maps.LatLng} p1 The first lat lng point. | ||
* @param {google.maps.LatLng} p2 The second lat lng point. | ||
* @return {number} The distance between the two points in km. | ||
* @param p1 The first lat lng point. | ||
* @param p2 The second lat lng point. | ||
* @return The distance between the two points in km. | ||
* @see http://www.movable-type.co.uk/scripts/latlong.html | ||
@@ -848,5 +841,5 @@ */ | ||
* | ||
* @param {google.maps.Marker} marker The marker to check. | ||
* @param {google.maps.LatLngBounds} bounds The bounds to check against. | ||
* @return {boolean} True if the marker is in the bounds. | ||
* @param marker The marker to check. | ||
* @param bounds The bounds to check against. | ||
* @return True if the marker is in the bounds. | ||
*/ | ||
@@ -858,3 +851,3 @@ isMarkerInBounds_(marker: google.maps.Marker, bounds: google.maps.LatLngBounds): boolean; | ||
* | ||
* @param {google.maps.Marker} marker The marker to add. | ||
* @param marker The marker to add. | ||
*/ | ||
@@ -867,3 +860,3 @@ addToClosestCluster_(marker: google.maps.Marker): void; | ||
* | ||
* @param {number} iFirst The index of the first marker in the batch of | ||
* @param iFirst The index of the first marker in the batch of | ||
* markers to be added to clusters. | ||
@@ -876,5 +869,5 @@ */ | ||
* | ||
* @param {object} obj1 The object to be extended. | ||
* @param {object} obj2 The object to extend with. | ||
* @return {object} The new extended object. | ||
* @param obj1 The object to be extended. | ||
* @param obj2 The object to extend with. | ||
* @return The new extended object. | ||
* @ignore | ||
@@ -888,6 +881,5 @@ */ | ||
* | ||
* @param {Array.<google.maps.Marker>} markers The array of markers represented by the cluster. | ||
* @param {number} numStyles The number of marker styles available. | ||
* @return {ClusterIconInfo} The information resource for the cluster. | ||
* @constant | ||
* @param markers The array of markers represented by the cluster. | ||
* @param numStyles The number of marker styles available. | ||
* @return The information resource for the cluster. | ||
* @ignore | ||
@@ -900,4 +892,2 @@ */ | ||
* | ||
* @type {number} | ||
* @constant | ||
*/ | ||
@@ -909,4 +899,2 @@ static BATCH_SIZE: number; | ||
* | ||
* @type {number} | ||
* @constant | ||
*/ | ||
@@ -918,4 +906,2 @@ static BATCH_SIZE_IE: number; | ||
* | ||
* @type {string} | ||
* @constant | ||
*/ | ||
@@ -927,4 +913,2 @@ static IMAGE_PATH: string; | ||
* | ||
* @type {string} | ||
* @constant | ||
*/ | ||
@@ -936,4 +920,2 @@ static IMAGE_EXTENSION: string; | ||
* | ||
* @type {Array.<number>} | ||
* @constant | ||
*/ | ||
@@ -940,0 +922,0 @@ static IMAGE_SIZES: number[]; |
{ | ||
"name": "@types/markerclustererplus", | ||
"version": "2.1.31", | ||
"version": "2.1.32", | ||
"description": "TypeScript definitions for MarkerClustererPlus for Google Maps V3", | ||
@@ -27,4 +27,4 @@ "license": "MIT", | ||
}, | ||
"typesPublisherContentHash": "84463fc55bd04b88fcd3b294b9dd6260c85985139e241d2c46d9f3e417ee5ca6", | ||
"typesPublisherContentHash": "776ac0fc5e4a0c54ef25ea8d1baeac4d59051e03dc8b8436af34cb26c1ccd98e", | ||
"typeScriptVersion": "2.2" | ||
} |
@@ -11,3 +11,3 @@ # Installation | ||
Additional Details | ||
* Last updated: Wed, 11 Oct 2017 23:18:32 GMT | ||
* Last updated: Wed, 25 Oct 2017 01:11:50 GMT | ||
* Dependencies: google-maps | ||
@@ -14,0 +14,0 @@ * Global values: Cluster, ClusterIcon, MarkerClusterer |
31974
760