Template Panel: Difference between revisions
mNo edit summary |
|||
| Line 29: | Line 29: | ||
==When to use Template Panels== | ==When to use Template Panels== | ||
There are a number of use-cases for which Template Panels can be desirable. | There are a number of use-cases for which Template Panels can be desirable. | ||
===Repeated data in project=== | ===Repeated data in project=== | ||
Individual [[Panel]]s can be created and added to the [[3D world]], but depending on how many are desired this may be a lot of menial work. By using a Template Panel to autoamtically generate the desired [[Panel]]s, effort can be saved, changes can be applied to all instances more easily, and the appearance and effects of the [[Panel]]s remains more consistent. | |||
===Spatial data in Template Project=== | ===Spatial data in Template Project=== | ||
When using the [[Project]] as a [[Template]], Template Panels can be easily applied to data in the [[Project]], reducing the amount of time it takes to configure a [[Project]] based on a [[Template]] "out-of-the-box". In fact, after creating a new [[Project]] based on a [[Template]], Template Panels are applied automatically. | |||
===Web Interface=== | ===Web Interface=== | ||
Template Panels can be used with the Web Interface to serve different information per user. | Template Panels can be used with the Web Interface to serve different information per user. | ||
When a Template Panel is used as part of a [[Web Interface]], either for a frontpage or for custom HTML, an instance of the Template Panel is displayed. Specifically, the displayed instance is the one with an owner which matches the [[Stakeholder]] whom's [[Web Token]] was used to authenticate. | When a Template Panel is used as part of a [[Web Interface]], either for a frontpage or for custom HTML, an instance of the Template Panel is displayed. Specifically, the displayed instance is the one with an owner which matches the [[Stakeholder]] whom's [[Web Token]] was used to authenticate. | ||
Revision as of 09:04, 29 June 2020
A Template Panel is a special variant of a Panel, which serves as a definition through which a large amount of Panels can be created. They have most properties of ordinary Panels. They cannot be displayed to or used by end-users directly. Based on a Template Panel, an amount of Panels can be generated automatically. These are known as Instanced Panels (or the Template Panel's instances), which function identically to regular Panels. A Template pales is linked to a specifc type of data. Instanced Panels have, in general, the same properties as the Template Panel they are derived from, in addition to a location in the 3D World matching the location of the Item it is applicable to.
When a Template Panel is linked to a specific type of data, an Attribute filter can be added as well. This means the Template Panel will only be applied to the Items matching the specifed type which also have the specified Attribute.
When a Template Panel is "applied", Instanced Panels are created for each Item of the specified type. Instanced Panels can be modified independantly of their orignal Template Panels (although this is not recommended). A Template Panel can also be modified independantly of its instances. It is only when the Template Panel is reapplied that its instances are affected. If the Template Panel had been applied before, any Instanced Panels previously created based on the same Template Panel are removed before creating the new Instanced Panels. This is also true if the Template Panel is changed to be applicable to a different type of data than its instances currently are.
Types of Template Panels
There are two types of template panels:
| Type | Description |
|---|---|
| Text Template Panel | Generates Text Panels. Each Instanced Panel has its own discrete copy of the text content of the Template Panel. |
| Excel Template Panel | Generates Excel Panels. Each Instanced Panel is connected to the same Excel definition as the Template Panel. |
Target
Template Panels can be applied to the following Items:
When to use Template Panels
There are a number of use-cases for which Template Panels can be desirable.
Repeated data in project
Individual Panels can be created and added to the 3D world, but depending on how many are desired this may be a lot of menial work. By using a Template Panel to autoamtically generate the desired Panels, effort can be saved, changes can be applied to all instances more easily, and the appearance and effects of the Panels remains more consistent.
Spatial data in Template Project
When using the Project as a Template, Template Panels can be easily applied to data in the Project, reducing the amount of time it takes to configure a Project based on a Template "out-of-the-box". In fact, after creating a new Project based on a Template, Template Panels are applied automatically.
Web Interface
Template Panels can be used with the Web Interface to serve different information per user.
When a Template Panel is used as part of a Web Interface, either for a frontpage or for custom HTML, an instance of the Template Panel is displayed. Specifically, the displayed instance is the one with an owner which matches the Stakeholder whom's Web Token was used to authenticate.