This class is used to represent display states for a set of scene nodes. The same display state need not be used for all of the scene nodes in the set.
Constructor for a new DisplayGroup.
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.vtm.DisplayGroup(sId, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId | string | An optional ID for the sap.ui.vtm.DisplayGroup. |
|
mSettings? | object | An optional object with initial settings for the new sap.ui.vtm.DisplayGroup instance. |
Name | Type | Default Value | Description |
---|---|---|---|
displayStatesBySceneNodeId | object | empty object | A plain object map that uses scene node id as the key and a display state object as the value. The display state is a plain JavaScript object that can contain the following properties:
"" ) is used, the highlight color is cleared, otherwise the value is expected to be a sap.ui.core.CSSColor. Display state objects can be reused multiple times in the map to reduce memory usage.Visibility: public |
Method | Description |
---|---|
sap.ui.vtm.DisplayGroup.extend |
Creates a new subclass of class sap.ui.vtm.DisplayGroup with name
|
getDisplayStatesBySceneNodeId |
Gets current value of property displayStatesBySceneNodeId. A plain object map that uses scene node id as the key and a display state object as the value. The display state is a plain JavaScript object that can contain the following properties:
"" ) is used, the highlight color is cleared, otherwise the value is expected to be a sap.ui.core.CSSColor. Display state objects can be reused multiple times in the map to reduce memory usage.Default value is |
sap.ui.vtm.DisplayGroup.getMetadata |
Returns a metadata object for class sap.ui.vtm.DisplayGroup. |
setDisplayStatesBySceneNodeId |
Sets a new value for property displayStatesBySceneNodeId. A plain object map that uses scene node id as the key and a display state object as the value. The display state is a plain JavaScript object that can contain the following properties:
"" ) is used, the highlight color is cleared, otherwise the value is expected to be a sap.ui.core.CSSColor. Display state objects can be reused multiple times in the map to reduce memory usage.When called with a value of Default value is |
Creates a new subclass of class sap.ui.vtm.DisplayGroup 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.core.Element.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 displayStatesBySceneNodeId.
A plain object map that uses scene node id as the key and a display state object as the value. The display state is a plain JavaScript object that can contain the following properties:
""
) is used, the highlight color is cleared, otherwise the value is expected to be a sap.ui.core.CSSColor. true
this display state will be applied to the scene node and its descendants.
{
visibility: true,
opacity: 100,
highlightColor: "red",
recursive: false
}
Display state objects can be reused multiple times in the map to reduce memory usage.Default value is {}
.
Sets a new value for property displayStatesBySceneNodeId.
A plain object map that uses scene node id as the key and a display state object as the value. The display state is a plain JavaScript object that can contain the following properties:
""
) is used, the highlight color is cleared, otherwise the value is expected to be a sap.ui.core.CSSColor. true
this display state will be applied to the scene node and its descendants.
{
visibility: true,
opacity: 100,
highlightColor: "red",
recursive: false
}
Display state objects can be reused multiple times in the map to reduce memory usage.When called with a value of null
or undefined
, the default value of the property will be restored.
Default value is {}
.
Param | Type | DefaultValue | Description |
---|---|---|---|
oDisplayStatesBySceneNodeId | object | {} |
New value for property |