Namespace: Cluster

Members

---

<static, constant> DEFAULT :object

Default options for this style

Type:

• object

Source:

• style/stylecluster.js, line 213

---

<static, constant> DEFAULT_VENDOR :object

Default options for this style

Type:

• object

Source:

• style/stylecluster.js, line 243

---

<static, constant> RANGE_1_DEFAULT :object

Default options for range 1 style

Type:

• object

Source:

• style/stylecluster.js, line 266

---

<static, constant> RANGE_2_DEFAULT :object

Default options for range 2 style

Type:

• object

Source:

• style/stylecluster.js, line 284

---

<static, constant> RANGE_3_DEFAULT :object

Default options for range 3 style

Type:

• object

Source:

• style/stylecluster.js, line 302

Methods

---

apply(layer)

This function apply style to specified layer

Parameters:

Name	Type	Description
layer	M.layer.Vector	Layer to apply the style

Overrides:

• M.Style#apply

Source:

• style/stylecluster.js, line 54

---

clone()

This function clones the style

Inherited From:

• M.Style#clone

Source:

• style/style.js, line 232

Returns:

Type

M.Style

---

equals()

TODO

Inherited From:

• M.Style#equals

Source:

• style/style.js, line 220

---

get(attribute)

This function returns the value of the indicated attribute

Parameters:

Name	Type	Description
attribute	String	Attribute to know the value

Inherited From:

• M.Style#get

Source:

• style/style.js, line 85

Returns:

Attribute Value

Type

Object

---

getOldStyle()

This function gets the old style of layer

Source:

• style/stylecluster.js, line 72

Returns:

the old style of layer

Type

M.Style

---

getOptions()

This function returns the options of style cluster

Source:

• style/stylecluster.js, line 95

Returns:

options of style cluster

Type

object

---

getRange(min, max)

This function return a specified range

Parameters:

Name	Type	Description
min	number	as minimal value in the interval
max	number	as max value in the interval

Source:

• style/stylecluster.js, line 125

Returns:

Type

Object

---

getRanges()

This function return a set of ranges defined by user

Source:

• style/stylecluster.js, line 84

Returns:

ranges stablished by user

Type

Array.<Object>

---

isAnimated()

This function return if layer is animated

Source:

• style/stylecluster.js, line 168

Returns:

A flag indicating if layer is currently being animated

Type

boolean

---

refresh()

This function updates the style of the
layer

Overrides:

• M.Style#refresh

Source:

• style/stylecluster.js, line 198

Returns:

data url to canvas

Type

String

---

serialize()

TODO

Inherited From:

• M.Style#serialize

Source:

• style/style.js, line 203

---

set(property, value)

This function set value to property and apply new property

Parameters:

Name	Type	Description
property	String	Property to change the value
value	String	Value to property

Inherited From:

• M.Style#set

Source:

• style/style.js, line 109

Returns:

Type

M.Style

---

setAnimated(animated)

This function set if layer must be animated

Parameters:

Name	Type	Description
animated	boolean	defining if layer must be animated

Source:

• style/stylecluster.js, line 156

Returns:

Type

M.style.Cluster

---

setRanges(newRanges)

This function update a set of ranges defined by user

Parameters:

Name	Type	Description
newRanges	Array.<Object>	as new Ranges

Source:

• style/stylecluster.js, line 108

Returns:

Type

M.style.Cluster

---

toImage()

This function returns data url to canvas

Inherited From:

• M.Style#toImage

Overrides:

• M.Style#toImage

Source:

• style/style.js, line 174

Returns:

data url to canvas

Type

String

---

unapply(layer)

This function unapply the style to specified layer

Parameters:

Name	Type	Description
layer	M.layer.Vector	layer to unapply his style

Overrides:

• M.Style#unapply

Source:

• style/stylecluster.js, line 42

---

updateCanvas()

This function updates the styles's canvas

Inherited From:

• M.Style#updateCanvas

Source:

• style/style.js, line 212

---

updateRange(min, max, newRange)

This function set a specified range

Parameters:

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

Source:

• style/stylecluster.js, line 140

Returns:

Type

M.style.Cluster