| Dimension viewer | ||
|---|---|---|
| Previous | Next | |
| XML viewer | Menu viewer | |
The figure below gives a quick overview of the models available when rendering a Dimension Viewer using a template.
These are the global (top level) objects available when using FreeMarker in a Dimension Viewer.
| Object | Description | Type |
|---|---|---|
| component | This object contains information about the executing component. | ComponentModel |
| context | This property contains information about the execution context. | ContextModel |
| nodes | This property contains the top level nodes in the viewer. | DimensionListModel |
| viewer | This property contains information about the viewer. | ViewerModel |
This object contains information about the DimensionViewer.
| Property | Description | Type |
|---|---|---|
| strings | Available strings for the viewer. This TextMapModel supports locations “template” and “domain”. | TextMapModel |
This object contains the top level nodes in the viewer, and is really just a collection of DimensionModel objects.
The object is a freemarker sequence model, so you can access the nodes directly using
${nodes[index]}, or you can traverse it using the
...[/#list] syntax.
The object is also a freemarker node, so you can also use the built-ins ?children, ?parent, ?root, ?ancestors, ?node_name, ?node_type and ?node_namespace. The ?node_name and ?node_type properties are both “DimensionList”.
This object contains information about a single dimension item.
The object is a freemarker node, so you can also use the built-ins ?children, ?parent, ?root, ?ancestors, ?node_name, ?node_type and ?node_namespace.
| Property | Description | Type |
|---|---|---|
| objectId | The object ID of the node | Number |
| objectGuid | The object guid of the node | String |
| level | The level of the node | Number |
| label | The text of the node | String |
| isActive | An indicator of whether this node is the “active” one. | Boolean |
| hasActiveChild | An indicator of whether a sub-node of this one is the “active” one. | Boolean |
| url | The url of the menu item destination, typically used in the href-attribute of an
<a>-tag.
|
String |
| action | The action specification for the dimension | DimensionActionModel |
| dimensionTypes | List of dimensions types applicable to this node | List of ObjectReferenceModel |
| ?children | List of children nodes | List of DimensionModel |
| ?parent | Parent node | DimensionModel |
| ?root | Root node | DimensionModel |
| ?ancestors | List of ancestors | List of DimensionModel |
| ?node_namespace | There is no namespace; it always returns null. | Null |
| ?node_type | Always the string “Dimension” | String |
| ?node_name | Always the string “Dimension” | String |
This object contains information about a single dimension action, typically a URL link.
| Property | Description | Type |
|---|---|---|
| label | The label value of the action | String |
| url | The URL of the action, used as the “href” attribute of the
<a>-tag.
|
String |
| onclick | The value of the “onclick” attribute of the
<a>-tag.
|
String |
| script | The value of the “onclick” attribute of the
<a>-tag.
|
String |
<default>
|
Formatted
<a>-tag representing the action.
|
(Any) |
| Previous | Top | Next |
| XML viewer | Menu viewer |