Class sap.ui.vbm.ClusterTreeModule: sap/ui/vbm/ClusterTree

extends ClusterBase

Cluster definition element for tree clusters. Complex clustering based on Voronoi diagrams. The actual clustering is based on the areas in the Voronoi diagram and cluster objects get aggregated to a hierarchy over several levels of detail.

Constructor Summary
new sap.ui.vbm.ClusterTree(sId?, mSettings?)Constructor for a new ClusterTree.
Events borrowed from class sap.ui.vbm.ClusterBase
Method Summary
sap.ui.vbm.ClusterTree.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vbm.ClusterTree with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vbm.ClusterTree.getMetadata()Returns a metadata object for class sap.ui.vbm.ClusterTree.
getAnimateClusterSplit()Gets current value of property animateClusterSplit.
setAnimateClusterSplit(bAnimateClusterSplit)Sets a new value for property animateClusterSplit.
Constructor Detail
new sap.ui.vbm.ClusterTree(sId?, mSettings?)
Constructor for a new ClusterTree.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

In addition, all settings applicable to the base type sap.ui.vbm.ClusterBase can be used as well.

Parameters:
{string}sId? id for the new control, generated automatically if no id is given
{object}mSettings? initial settings for the new control
Method Detail
sap.ui.vbm.ClusterTree.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vbm.ClusterTree with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.vbm.ClusterBase.extend.

Parameters:
{string}sClassName Name of the class being created
{object}oClassInfo? Object literal with information about the class
{function}FNMetaImpl? Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
{function} Created class / constructor function
sap.ui.vbm.ClusterTree.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vbm.ClusterTree.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getAnimateClusterSplit(): boolean
Gets current value of property animateClusterSplit.

Indicates whether the split of a cluster object into sub clusterers or visual objects should be animated

Default value is true.

Returns:
{boolean} Value of property animateClusterSplit
setAnimateClusterSplit(bAnimateClusterSplit): sap.ui.vbm.ClusterTree
Sets a new value for property animateClusterSplit.

Indicates whether the split of a cluster object into sub clusterers or visual objects should be animated

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
{boolean}bAnimateClusterSplit New value for property animateClusterSplit
Returns:
{sap.ui.vbm.ClusterTree} Reference to this in order to allow method chaining