ClusterGrid

extends ClusterBase

Cluster definition element for grid based clusters. Visual objects are clustered based on a grid. It is possible to have multiple grid based clusters. The visualization object is placed in the center of the grid cell plus a given offset.

Constructor Summary

new sap.ui.vbm.ClusterGrid(sId?, mSettings?)Constructor for a new ClusterGrid.

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.ClusterGrid.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vbm.ClusterGrid with name sClassName and enriches it with the information contained in oClassInfo.

sap.ui.vbm.ClusterGrid.getMetadata()Returns a metadata object for class sap.ui.vbm.ClusterGrid.

getCellSpacing()Gets current value of property cellSpacing.

getGridSize()Gets current value of property gridSize.

getLimit()Gets current value of property limit.

getLimitTotal()Gets current value of property limitTotal.

getOffset()Gets current value of property offset.

getOrderIndex()Gets current value of property orderIndex.

setCellSpacing(iCellSpacing)Sets a new value for property cellSpacing.

setGridSize(sGridSize)Sets a new value for property gridSize.

setLimit(iLimit)Sets a new value for property limit.

setLimitTotal(iLimitTotal)Sets a new value for property limitTotal.

setOffset(sOffset)Sets a new value for property offset.

setOrderIndex(iOrderIndex)Sets a new value for property orderIndex.

Methods borrowed from class sap.ui.vbm.ClusterBase

Methods borrowed from class sap.ui.core.Element

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.ClusterGrid(sId?, mSettings?)

Constructor for a new ClusterGrid.

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
- gridSize : string (default: 256;256)
- limit : int (default: 2)
- limitTotal : int (default: 2)
- orderIndex : int
- offset : string (default: 0;0)
- cellSpacing : int (default: 4)

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.ClusterGrid.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.vbm.ClusterGrid 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.ClusterGrid.getMetadata(): sap.ui.base.Metadata

Returns a metadata object for class sap.ui.vbm.ClusterGrid.

Returns:

{sap.ui.base.Metadata}

Metadata object describing this class

getCellSpacing(): int

Gets current value of property cellSpacing.

Space between grid cells if cell area is shown

Default value is 4.

Returns:

{int} Value of property cellSpacing

getGridSize(): string

Gets current value of property gridSize.

Size of grid cells in pixels. Format is "distanceX;distanceY"

Default value is 256;256.

Returns:

{string} Value of property gridSize

getLimit(): int

Gets current value of property limit.

Minimal number of objects covered by grid cell fullfilling the cluster rule until clustering is applied.

Default value is 2.

Returns:

{int} Value of property limit

getLimitTotal(): int

Gets current value of property limitTotal.

Minimal total number of objects covered by grid cell until clustering is applied.

Default value is 2.

Returns:

{int} Value of property limitTotal

getOffset(): string

Gets current value of property offset.

Offset for the visualization object from the center of the grid cell. This can be used to show multiple visualization objects in on grid cell without overlapping. Format is "offsetX;offsetY"

Default value is 0;0.

Returns:

{string} Value of property offset

getOrderIndex(): int

Gets current value of property orderIndex.

Ordering index of given cluster in the sequence of all grid based clusters

Returns:

{int} Value of property orderIndex

setCellSpacing(iCellSpacing): sap.ui.vbm.ClusterGrid

Sets a new value for property cellSpacing.

Space between grid cells if cell area is shown

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

Default value is 4.

Parameters:

{int} iCellSpacing New value for property cellSpacing

Returns:

{sap.ui.vbm.ClusterGrid} Reference to this in order to allow method chaining

setGridSize(sGridSize): sap.ui.vbm.ClusterGrid

Sets a new value for property gridSize.

Size of grid cells in pixels. Format is "distanceX;distanceY"

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

Default value is 256;256.

Parameters:

{string} sGridSize New value for property gridSize

Returns:

{sap.ui.vbm.ClusterGrid} Reference to this in order to allow method chaining

setLimit(iLimit): sap.ui.vbm.ClusterGrid

Sets a new value for property limit.

Minimal number of objects covered by grid cell fullfilling the cluster rule until clustering is applied.

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

Default value is 2.

Parameters:

{int} iLimit New value for property limit

Returns:

{sap.ui.vbm.ClusterGrid} Reference to this in order to allow method chaining

setLimitTotal(iLimitTotal): sap.ui.vbm.ClusterGrid

Sets a new value for property limitTotal.

Minimal total number of objects covered by grid cell until clustering is applied.

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

Default value is 2.

Parameters:

{int} iLimitTotal New value for property limitTotal

Returns:

{sap.ui.vbm.ClusterGrid} Reference to this in order to allow method chaining

setOffset(sOffset): sap.ui.vbm.ClusterGrid

Sets a new value for property offset.

Offset for the visualization object from the center of the grid cell. This can be used to show multiple visualization objects in on grid cell without overlapping. Format is "offsetX;offsetY"

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

Default value is 0;0.

Parameters:

{string} sOffset New value for property offset

Returns:

{sap.ui.vbm.ClusterGrid} Reference to this in order to allow method chaining

setOrderIndex(iOrderIndex): sap.ui.vbm.ClusterGrid

Sets a new value for property orderIndex.

Ordering index of given cluster in the sequence of all grid based clusters

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

Parameters:

{int} iOrderIndex New value for property orderIndex

Returns:

{sap.ui.vbm.ClusterGrid} Reference to this in order to allow method chaining