Class sap.ui.vbm.ClusterDistanceModule: sap/ui/vbm/ClusterDistance

extends ClusterBase

Cluster definition element for distance based clusters. Visual objects are clustered based on the visible distance between them. Objects get aggregated to a cluster object as long as they are inside the given distance range to the start object. The start object for a cluster is not specifically defined, just the next object not belonging to a cluster is taken. The visualization objects are placed in the center of gravity of the covered objects. Thus the actual distance between them may vary.
This clustering is fast, but the results may not be very convincing.

Constructor Summary
new sap.ui.vbm.ClusterDistance(sId?, mSettings?)Constructor for a new ClusterDistance.
Events borrowed from class sap.ui.vbm.ClusterBase
click, contextMenu
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.vbm.ClusterDistance.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vbm.ClusterDistance with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vbm.ClusterDistance.getMetadata()Returns a metadata object for class sap.ui.vbm.ClusterDistance.
getDistance()Gets current value of property distance.
setDistance(iDistance)Sets a new value for property distance.
Methods borrowed from class sap.ui.vbm.ClusterBase
attachClick, attachContextMenu, destroyVizTemplate, destroyVizVo, detachClick, detachContextMenu, fireClick, fireContextMenu, getAreaAlwaysVisible, getAreaColor, getAreaColorBorder, getRule, getTextProperty, getTextSettings, getVizTemplate, getVizVo, openContextMenu, openDetailWindow, setAreaAlwaysVisible, setAreaColor, setAreaColorBorder, setRule, setTextProperty, setTextSettings, setVizTemplate, setVizVo
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, clone, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, focus, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, rerender, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, invalidate, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ui.vbm.ClusterDistance(sId?, mSettings?)
Constructor for a new ClusterDistance.

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:

  • Properties

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.ClusterDistance.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vbm.ClusterDistance 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.ClusterDistance.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vbm.ClusterDistance.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getDistance(): int
Gets current value of property distance.

Distance in pixels between cluster objects. This distance is used as parameter during the clustering. The visualization objects are placed in center of gravity of the covered objects. Thus the actual distance between them may vary.

Default value is 128.

Returns:
{int} Value of property distance
setDistance(iDistance): sap.ui.vbm.ClusterDistance
Sets a new value for property distance.

Distance in pixels between cluster objects. This distance is used as parameter during the clustering. The visualization objects are placed in center of gravity of the covered objects. Thus the actual distance between them may vary.

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

Default value is 128.

Parameters:
{int}iDistance New value for property distance
Returns:
{sap.ui.vbm.ClusterDistance} Reference to this in order to allow method chaining