Nokia Maps API Reference

Contents

Interface nokia.maps.clustering.ClusterProvider.Options

Interface Summary

This interface defines the configuration options for nokia.maps.clustering.ClusterProvider

Field Summary
nokia.maps.clustering.IClusterPoint[] dataPoints Optional This property holds a collection of objects representing data points.
Number eps Optional This property holds the radius (in pixels) within which data points are considered for clustering.
nokia.maps.clustering.Index index Optional This property holds an indexing data structure to use along with the clustering data.
Number max Optional This property holds a value of the maximum zoom level at which to perform clustering.
Number min Optional This property holds a value of the minimum zoom level at which to perform clustering.
Number minPts Optional This property holds the smallest number of points that must be present within the eps distance of an arbitrary point to form a cluster.
nokia.maps.clustering.ITheme theme Optional This property holds an object that represents the display theme for clusters and noise points.
Field Detail
nokia.maps.clustering.IClusterPoint[] dataPoints Optional
This property holds a collection of objects representing data points. Each object contains the latitude and longitude of a location, but may also include the property value for weight-based positioning of the cluster markers - see also nokia.maps.clustering.IClusterPoint for further information.
Number eps Optional

This property holds the radius (in pixels) within which data points are considered for clustering. If a sufficient number of data points are found within this radius from an arbitrary point, a new cluster is created, otherwise any data points within this radius become noise points (individual, unclustered markers).

Note that setting this property to a very low value may result in too many points classified as noise points instead of being aggregated in a cluster. Larger values can help resolve this problem, however, they may also produce bigger clusters than desired/expected.

Default Value:
50
This property holds an indexing data structure to use along with the clustering data. It can lead to a significant improvement in the speed of marker data retrieval operations. If this property is not set, ClusterProvider uses an instance of nokia.maps.clustering.Index with the default nokia.maps.clustering.RTreeConfiguration.
Default Value:
nokia.maps.clustering.Index
Number max Optional
This property holds a value of the maximum zoom level at which to perform clustering.
Default Value:
20
Number min Optional
This property holds a value of the minimum zoom level at which to perform clustering.
Default Value:
0
Number minPts Optional
This property holds the smallest number of points that must be present within the eps distance of an arbitrary point to form a cluster.
Default Value:
1
This property holds an object that represents the display theme for clusters and noise points. By default, ClusterProvider uses an instance of nokia.maps.clustering.MarkerTheme. It creates an SVG marker for each cluster. The marker displays a number reflecting the number of data points in the cluster. The size and color of the marker depends on that number as well.
Default Value:
nokia.maps.clustering.MarkerTheme
Documentation generated on Thu Aug 30 2012 10:10:38 GMT+0200 (CEST).