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 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#constructor for a general description of the syntax of the settings object.
new sap.ui.vbm.ClusterGrid(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | id for the new control, generated automatically if no id is given |
|
mSettings? | object | initial settings for the new control |
Name | Type | Default Value | Description |
---|---|---|---|
cellSpacing | int | 4 | Space between grid cells if cell area is shown Visibility: public |
gridSize | string | 256;256 | Size of grid cells in pixels. Format is "distanceX;distanceY" Visibility: public |
limit | int | 2 | Minimal number of objects covered by grid cell fullfilling the cluster rule until clustering is applied. Visibility: public |
limitTotal | int | 2 | Minimal total number of objects covered by grid cell until clustering is applied. Visibility: public |
offset | string | 0;0 | 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" Visibility: public |
orderIndex | int | Ordering index of given cluster in the sequence of all grid based clusters Visibility: public |
Name | Type | Default Value | Description |
---|---|---|---|
areaAlwaysVisible | boolean | false | Flag controlling the visibility of the area convered by a cluster object. Visibility: public |
areaColor | sap.ui.core.CSSColor | rgba(200,0,0,0.2) | Fill color for the area covered by a cluster object Visibility: public |
areaColorBorder | sap.ui.core.CSSColor | rgba(220,220,220,0.5) | Border color for the area covered by a cluster object Visibility: public |
rule | string | Clustering rule, describing which visual objects should be considered for clustering Visibility: public |
|
textProperty | string | text | Name of property of the visualization control receiving the number of clustered objects. This setting applys only if aggregation vizTemplate is used. Visibility: public |
textSettings | object | Settings for the text placed on the given Spot telling the number of clustered objects. This setting applys only if aggregation vizVo is used. If omitted the number of clustered object will not be shown! Visibility: public |
Name | Cardinality | Type | Description |
---|---|---|---|
clusterContainers | 0..n | sap.ui.vbm.ClusterContainer |
Hidden aggregation for host container VOs |
clusterVos | 0..n | sap.ui.core.Control |
Hidden aggregation for cluster visualization controls |
vizTemplate | 0..1 | sap.ui.core.Control |
Optional: Instance of a control, which is used as template for visualizing cluster objects. This is the prefered choise. |
vizVo | 0..1 | sap.ui.vbm.Spot |
Optional: Instance of a spot, which is used as template for visualizing cluster objects |
Method | Description |
---|---|
sap.ui.vbm.ClusterGrid.extend |
Creates a new subclass of class sap.ui.vbm.ClusterGrid with name
|
getCellSpacing |
Gets current value of property cellSpacing. Space between grid cells if cell area is shown Default value is |
getGridSize |
Gets current value of property gridSize. Size of grid cells in pixels. Format is "distanceX;distanceY" Default value is |
getLimit |
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 |
getLimitTotal |
Gets current value of property limitTotal. Minimal total number of objects covered by grid cell until clustering is applied. Default value is |
sap.ui.vbm.ClusterGrid.getMetadata |
Returns a metadata object for class sap.ui.vbm.ClusterGrid. |
getOffset |
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 |
getOrderIndex |
Gets current value of property orderIndex. Ordering index of given cluster in the sequence of all grid based clusters |
setCellSpacing |
Sets a new value for property cellSpacing. Space between grid cells if cell area is shown When called with a value of Default value is |
setGridSize |
Sets a new value for property gridSize. Size of grid cells in pixels. Format is "distanceX;distanceY" When called with a value of Default value is |
setLimit |
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 Default value is |
setLimitTotal |
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 Default value is |
setOffset |
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 Default value is |
setOrderIndex |
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 |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
sClassName | string |
Name of the class being created |
|
oClassInfo | object |
Object literal with information about the class |
|
FNMetaImpl | function |
Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class |
Gets current value of property cellSpacing.
Space between grid cells if cell area is shown
Default value is "4"
.
Gets current value of property gridSize.
Size of grid cells in pixels. Format is "distanceX;distanceY"
Default value is "256;256"
.
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
.
Gets current value of property limitTotal.
Minimal total number of objects covered by grid cell until clustering is applied.
Default value is 2
.
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"
.
Gets current value of property orderIndex.
Ordering index of given cluster in the sequence of all grid based clusters
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"
.
Param | Type | DefaultValue | Description |
---|---|---|---|
iCellSpacing | int | "4" |
New value for property |
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"
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sGridSize | string | "256;256" |
New value for property |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
iLimit | int | 2 |
New value for property |
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
.
Param | Type | DefaultValue | Description |
---|---|---|---|
iLimitTotal | int | 2 |
New value for property |
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"
.
Param | Type | DefaultValue | Description |
---|---|---|---|
sOffset | string | "0;0" |
New value for property |
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.
Param | Type | DefaultValue | Description |
---|---|---|---|
iOrderIndex | int |
New value for property |