Class nokia.maps.clustering.ClusterProvider
Class Summary
This class works on a set of data points (locations) and
organizes them into clusters to optimize their display on the map.
Method Summary
add
(dataPoint)
This method adds a data point to the list of data points to be considered for clustering.
addAll
(dataPoints, [callback])
This method adds a list of data points to the list of objects for clustering.
clean
()
This method removes clusters and noise points from display.
cluster
()
This method starts the clustering process.
destroy
()
This method cleans up all internal objects and prepares the given instance of this class to be destroyed.
get
(key)
: Variant
This method retrieves the value of the property with the name provided by the caller.
getCopyrights
(area, zoom)
: Object[]
To get copyright information for a specified geographical area and zoom level.
getDataLength
()
: Number
This method retrieves a numeric value indicating the number of data points in the data set available to the given instance of the class.
getEps
()
: Number
This method retrieves the current epsilon value, which represents the area within which data points are considered for clustering.
getMinPts
()
: Number
This method retrieves a value indicating the smallest number of points within the epsilon radius that are required to form a cluster.
invalidate
()
This method invalidates the current results of clustering and sets the state to nokia.maps.clustering.ClusterProvider.STATE_INITIAL.
numberOfClusters
()
: Number
This method retrieves the number of clusters in the data set available to the given instance of the class.
numberOfNoisePoints
()
: Number
This method retrieves a numeric value indicating the number of noise points in the data set available to the given instance of this class.
remove
(dataPoint)
This method removes a data point from the list of objects to be considered for clustering.
set
(nameOrObject, [value, [force]])
: nokia.maps.util.OObject
This method sets property values, using the property names and values supplied by the caller.
setEps
(epsilon)
This method sets a new epsilon value (in pixels), which represents the area within which data points are considered for clustering.
setMinPts
(minPts)
This method sets a new value indicating the smallest number of points within the epsilon radius that are required to form a cluster.
setTheme
(theme)
This method sets the theme to use while rendering clusters on the map.
update
()
This method set the internal "updated at" time-stamp and publishes a message with topic "updated".
Field Summary
static
string
STATE_CLUSTERED
This constant indicates a state which an instance of ClusterProvider enters when it has completed clustering and rendering of the markers on the map can begin (is about to begin).
static
string
STATE_READY
This constant indicates a state which an instance of ClusterProvider enters when it has determined clusters and noise points and their representation for display on the map.
static
string
STATE_STARTED
This constant indicates a state which an instance of ClusterProvider enters when clustering has started.
String
description
This property holds a description of the provider to be used in the user interface, for example in tool tips.
Number
id
This property holds the id of the Provider instance.
String
label
This property represents a label for the provider to be displayed in the user interface.
Number
max
This property indicates the maximum zoom level.
Number
min
This property indicates the minimum zoom level.
Constructor Detail
This method creates new instance of ClusterProvider.
new nokia.maps.clustering.ClusterProvider(display, [options])
Method Detail
addAll
(dataPoints, [callback])
getDataLength
()
: Number
numberOfClusters
()
: Number
numberOfNoisePoints
()
: Number
Field Detail
static
string
STATE_CLUSTERED
static
string
STATE_INITIAL
static
string
STATE_READY
static
string
STATE_STARTED
Documentation generated on Thu Aug 30 2012 10:10:54 GMT+0200 (CEST).