Cluster
If the data is a collection of point features, setting this to true clusters the points by radius into groups.
Cluster
Parameter
Required Parameter | Description | Type |
map | Map object to display ther Cluster | Map instance |
position | Latitude(must), Longitude(must), iconType(Option), message(Option), popupMessage(Option) | Array<object> |
Optional Parameter | Description | Type |
clusterMaxZoom | Max zoom on which to cluster points if clustering is enabled. Defaults to one zoom less than maxzoom (so that last zoom features are not clustered). Clusters are re-evaluated at integer zoom levels so setting clusterMaxZoom to 14 means the clusters will be displayed until z15. | Numeric |
clusterRadius | Radius of each cluster if clustering is enabled. A value of 512 indicates a radius equal to the width of a tile. | Numeric |
clusterStyle | Set individual cluster styles. color : Set the color of the inner cluster. Colors, HEX, RGB, RGBA strokeColor : Set the color of the outer cluster. Colors, HEX, RGB, RGBA strokeWidth : Set the width of the outer cluster. numeric radius : Set the radius of the cluster. numeric count : The number of clusters. numeric textSize : Set the text size of the cluster. numeric textColor : Set the text color of the cluster. Colors, HEX, RGB, RGBA textHaloWidth : Distance of halo to the font outline. numeric textHaloColor : The color of the text's halo. Colors, HEX, RGB, RGBA | Array<object> |
circleStyle | Set circle styles. color : Set the color of the inner circle. Colors, HEX, RGB, RGBA strokeColor : Set the color of the outer circle. Colors, HEX, RGB, RGBA strokeWidth : Set the width of the outer circle. numeric radius : Set the radius of the circle. numeric | Array<object> |
marker | Whether to display the data as a marker. Default false(circle) | Boolean |
markerStyle | If marker true, Set marker styles. minZoom : Zoom level to indicate the marker. numeric Default clusterMaxZoom overlap : If true, the icon will be visible even if it collides with other previously drawn symbols. boolean Default false placement : If true, other symbols can be visible even if they collide with the icon. boolean Default false iconSize : Scales the original size of the icon by the provided factor. numeric Default 1 iconAnchor : Part of the icon placed closest to the anchor.
String Default center textAnchor : Part of the text placed closest to the anchor.
String Default center textColor : The color with which the text will be drawn. Colors, HEX, RGB, RGBA textOffset : Offset distance of text from its anchor. Array<Numeric> Default [0,0] textHaloColor : The color of the text's halo, which helps it stand out from backgrounds. Colors, HEX, RGB, RGBA textHaloWidth : Distance of halo to the font outline. Max text halo width is 1/4 of the font-size. numeric Default 0 addImage : The marker image is registered with the server. Array<object> imageId : It must match the icon type of data. imageUrl : Link with an image. | Array<object> |
popupStyle | If marker true, Set popup styles. event : mouse event. "click", "mouseenter" String Defautl click className : Space-separated CSS class names to add to popup container. String Default None closeButton : If true, a close button will appear in the top right corner of the popup. Boolean Default false closeOnClick : If true , the popup will close when the map is clicked. Boolean Default false offset : A pixel offset applied to the popup's location. Array<numeric> Default [0,0] maxWidth : A string that sets the CSS property of the popup's maximum width. String Default fit-content anchor : Part of the popup that should be positioned closest to the coordinate |