M/style/Cluster~Cluster


import Cluster from 'M/style/Cluster';

Main constructor of the class. Creates a style cluster with parameters specified by the user

new Cluster(options, optsVendor)

facade/js/style/Cluster.js, line 25
Name Type Description
options object

parameters for style cluster

optsVendor object

specified parameters for cluster depends on its implementation

Extends

  • M.Style

Members

module:M/style/Cluster~Cluster.DEFAULT{object}

Default options for this style

module:M/style/Cluster~Cluster.DEFAULT_VENDOR{object}

Default options for this style

module:M/style/Cluster~Cluster.RANGE_1_DEFAULT{object}

Default options for range 1 style

module:M/style/Cluster~Cluster.RANGE_2_DEFAULT{object}

Default options for range 2 style

module:M/style/Cluster~Cluster.RANGE_3_DEFAULT{object}

Default options for range 3 style

ORDER

This constant defines the order of style.

Methods

addSelectInteraction()

facade/js/style/Cluster.js, line 247

Add selected interaction and layer to see the features of cluster

apply()

facade/js/style/Cluster.js, line 51

applyInternal(layer)

facade/js/style/Cluster.js, line 82

This function apply style to specified layer

Name Type Description
layer M.layer.Vector

Layer to apply the style

getOldStyle(){M.Style}

facade/js/style/Cluster.js, line 95

This function gets the old style of layer

Returns:
the old style of layer

getOptions(){object}

facade/js/style/Cluster.js, line 118

This function returns the options of style cluster

Returns:
options of style cluster

getRange(min, max){Object}

facade/js/style/Cluster.js, line 148

This function return a specified range

Name Type Description
min number

as minimal value in the interval

max number

as max value in the interval

getRanges(){Array.<Object>}

facade/js/style/Cluster.js, line 107

This function return a set of ranges defined by user

Returns:
ranges stablished by user

isAnimated(){boolean}

facade/js/style/Cluster.js, line 191

This function return if layer is animated

Returns:
A flag indicating if layer is currently being animated

refresh(){String}

facade/js/style/Cluster.js, line 221

This function updates the style of the layer

Returns:
data url to canvas

removeSelectInteraction()

facade/js/style/Cluster.js, line 258

Remove selected interaction and layer to see the features of cluster

setAnimated(animated){Cluster}

facade/js/style/Cluster.js, line 179

This function set if layer must be animated

Name Type Description
animated boolean

defining if layer must be animated

setRanges(newRanges){Cluster}

facade/js/style/Cluster.js, line 131

This function update a set of ranges defined by user

Name Type Description
newRanges Array.<Object>

as new Ranges

toJSON(){object}

facade/js/style/Cluster.js, line 310

This function implements the mechanism to generate the JSON of this instance

updateRange(min, max, newRange){Cluster}

facade/js/style/Cluster.js, line 163

This function set a specified range

Name Type Description
min number

as range minimal value to be overwritten

max number

as range max value to be overwritten

newRange number

as the new range