new View()
A view built with/by view configuration
Methods
configurationElement() → {$k.SemanticElement}
Get configuration element
- Since
- 5.2.0
- Type:
- $k.SemanticElement
domainModel() → {object}
Get domain model
- Since
- 5.4.0
SemanticElement or TopicCollection
- Type:
- object
getPanelsToActivate()
Get the panel configurations activated by the current action.
Only supported in the following application environment(s): View-Configuration-Mapper
- Since
- 5.3.2
- Deprecated
- Use the corresponding function of the action
getVariable(variable)
get the value of the given variable
| Name | Type | Description |
|---|---|---|
variable | string |
(arrays of) SemanticElements and timestamps are auto-converted to native form
panelView() → {$k.PanelView}
Get this view's panel view
- Since
- 5.4.0
- Type:
- $k.PanelView
parentView() → {$k.View}
Get this view's parent view
- Since
- 5.3.2
- Type:
- $k.View
renderContext() → {RenderContext}
Get render context
Only supported in the following application environment(s): View-Configuration-Mapper
- Since
- 5.0.0
- Type:
- RenderContext
roles() → {Array}
Get the roles of the view, if any assigned.
- Since
- 5.4.0
Array of Strings
- Type:
- Array
semanticElement() → {$k.SemanticElement}
Get semantic element
- Since
- 5.2.0
- Type:
- $k.SemanticElement
session() → {$k.Session}
Get the current session
Only supported in the following application environment(s): View-Configuration-Mapper
- Since
- 5.2.0
- Type:
- $k.Session
setState(state) → {object}
Set the state of the view
| Name | Type | Description |
|---|---|---|
state | object |
- Version
- Experimental feature, might be removed at any time
- Since
- 5.4.0
- Type:
- object
setVariable(variable, value)
set the value of the given variable
| Name | Type | Description |
|---|---|---|
variable | string | |
value | supported variable types include all javascript base types as well as: timestamp, SemanticElement and arrays of the latter |
state() → {object}
Get the state of the view - varies according to view type and implementation
- Version
- Experimental feature, might be removed at any time
- Since
- 5.4.0
- Type:
- object
subViews() → {$k.View}
Get this view's sub-views or an empty array if there are none
- Since
- 5.4.0
- Type:
- $k.View
viewsWithRole(role) → {Array}
Get all views with the given role searching from this view down to all sub-views.
| Name | Type | Description |
|---|---|---|
role | string |
- Since
- 5.4.0
Array of Views
- Type:
- Array
viewType() → {string}
Get the view type
- Since
- 5.4.0
the view type: edit, query, etc.
- Type:
- string