Manages the visibility and selection states of nodes in the scene.
Constructor for a new ViewStateManager.
new sap.ui.vk.svg.ViewStateManager(sId?, mSettings?)
Param | Type | Default Value | Description |
---|---|---|---|
sId? | string | ID for the new ViewStateManager object. Generated automatically if no ID is given. |
|
mSettings? | object | Initial settings for the new ViewStateManager object. |
Method | Description |
---|---|
enumerateSelection |
Enumerates IDs of the selected nodes. |
sap.ui.vk.svg.ViewStateManager.extend |
Creates a new subclass of class sap.ui.vk.svg.ViewStateManager with name
|
getHighlightColor |
Gets the default highlighting color |
sap.ui.vk.svg.ViewStateManager.getMetadata |
Returns a metadata object for class sap.ui.vk.svg.ViewStateManager. |
getNodeHierarchy |
Gets the NodeHierarchy object associated with this ViewStateManager object. |
getOpacity |
Gets the opacity of the node. If a single node is passed to the method then a single value is returned. |
getSelectionState |
Gets the selection state of the node. If a single node reference is passed to the method then a single selection state is returned. |
getTintColor |
Gets the tint color of the node. If a single node reference is passed to the method then a single value is returned. |
getVisibilityChanges |
Gets the visibility changes in the current ViewStateManager object. |
getVisibilityState |
Gets the visibility state of nodes. If a single node is passed to the method then a single visibility state is returned. |
setHighlightColor |
Sets the default highlighting color |
setOpacity |
Sets the opacity of the nodes. |
setSelectionState |
Sets the selection state of the nodes. |
setSelectionStates |
Sets or resets the selection state of the nodes. |
setTintColor |
Sets the tint color of the nodes. |
setVisibilityState |
Sets the visibility state of the nodes. |
Enumerates IDs of the selected nodes.
Param | Type | DefaultValue | Description |
---|---|---|---|
callback | function |
A function to call when the selected nodes are enumerated. The function takes one parameter of type |
Creates a new subclass of class sap.ui.vk.svg.ViewStateManager 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.vk.ViewStateManagerBase.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 the default highlighting color
Param | Type | DefaultValue | Description |
---|---|---|---|
inABGRFormat | boolean | false |
This flag indicates to return the highlighting color in the ABGR format, if it equals |
Returns a metadata object for class sap.ui.vk.svg.ViewStateManager.
Gets the opacity of the node.
If a single node is passed to the method then a single value is returned.
If an array of nodes is passed to the method then an array of values is returned.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRefs | any any[] |
The node reference or the array of node references. |
Gets the selection state of the node.
If a single node reference is passed to the method then a single selection state is returned.
If an array of node references is passed to the method then an array of selection states is returned.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRefs | any any[] |
The node reference or the array of node references. |
Gets the tint color of the node.
If a single node reference is passed to the method then a single value is returned.
If an array of node references is passed to the method then an array of values is returned.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRefs | any any[] |
The node reference or the array of node references. |
|
inABGRFormat | boolean | false |
This flag indicates to return the tint color in the ABGR format, if it equals |
Gets the visibility state of nodes.
If a single node is passed to the method then a single visibility state is returned.
If an array of nodes is passed to the method then an array of visibility states is returned.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRefs | any any[] |
The node reference or the array of node references. |
Sets the default highlighting color
Param | Type | DefaultValue | Description |
---|---|---|---|
color | sap.ui.vk.CSSColor string int |
The new highlighting color. The value can be defined as a string in the CSS color format or as an integer in the ABGR format. If |
Sets the opacity of the nodes.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRefs | any any[] |
The node reference or the array of node references. |
|
opacity | float float[] null |
The new opacity of the nodes. If |
|
recursive | boolean | false |
This flag is not used, as opacity is always recursively applied to the offspring nodes by multiplication |
Sets the selection state of the nodes.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRefs | any any[] |
The node reference or the array of node references. |
|
selected | boolean |
The new selection state of the nodes. |
|
recursive | boolean |
The flags indicates if the change needs to propagate recursively to child nodes. |
|
blockNotification | boolean |
The flag to suppress selectionChanged event. |
Sets or resets the selection state of the nodes.
Param | Type | DefaultValue | Description |
---|---|---|---|
selectedNodeRefs | any any[] |
The node reference or the array of node references of selected nodes. |
|
unselectedNodeRefs | any any[] |
The node reference or the array of node references of unselected nodes. |
|
recursive | boolean |
The flags indicates if the change needs to propagate recursively to child nodes. |
|
blockNotification | boolean |
The flag to suppress selectionChanged event. |
Sets the tint color of the nodes.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRefs | any any[] |
The node reference or the array of node references. |
|
tintColor | sap.ui.vk.CSSColor int sap.ui.vk.CSSColor[] int[] null |
The new tint color of the nodes. The value can be defined as a string in the CSS color format or as an integer in the ABGR format or it could be array of these values. If |
|
recursive | boolean | false |
This flag indicates if the change needs to propagate recursively to child nodes. |
Sets the visibility state of the nodes.
Param | Type | DefaultValue | Description |
---|---|---|---|
nodeRefs | any any[] |
The node reference or the array of node references. |
|
visible | boolean boolean[] |
The new visibility state or array of states of the nodes. |
|
recursive | boolean |
The flags indicates if the change needs to propagate recursively to child nodes. |
|
force | boolean |
If a node is made visible but its parent is hidden then it will still be hidden in Viewport. This flag will force node to be visible regardless of parent's state. |