Panel: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
{{learned|what (Computer Software) Panels are|how Panels relate to the Tygron engine|about the different Panel types in the Tygron engine|how to add Panels to your project|how to change Panels in your project}}
{{learned|what panels are|how panels relate to the Tygron engine|what types of panels are available to you|common use-cases which can be fulfilled using panels|how to add and edit panels in a project}}
{{stub}}
{{stub}}


==What is a (Computer Software) Panel?==
==Panels==
:''From Wikipedia, the free encyclopedia
Panels, in a software context, are windows, dialogs or similar generic interface elements which are presented to a user. They can be small prompts or dialogs which facilitate an inquiry or message towards a user. They can also be larger, more complex interface components with multiple texts and/or elements on them.


: A (Computer Software) panel is "a particular arrangement of information grouped together for presentation to users in a window or pop-up."
==Panels in the Tygron Engine?==
 
==How do (Computer Software) Panels relate to the Tygron Engine?==
[[File:ReleaseNotesPanel.jpg|thumb|left|180px|Release Notes Panel from Editor]]
[[File:ReleaseNotesPanel.jpg|thumb|left|180px|Release Notes Panel from Editor]]
: One way Panels are implemented in the Tygron Engine is to use panels to provide information. A Panel as such is the Release Notes Panel. These panels are mostly aimed at the editor role. The other way panels are implemented in the Tygron Engine, are so called 'User Panels' in the Editor. These panels are implemented by the editor role in the project and are aimed at the end user role of the project, not the editor role. This article describes the implementation of the so called 'User panels'. The Editor with its panels is described [[Editor|here]].
In a [[project]], panels are a term specifically used for a user-defined interface element, which can be created and configured in the [[editor]]. They are purposefully left generic and abstract. The contents are entirely left open for a project- or template-specific implementation. Panels can be placed in the [[3D world]], where they are represented by a popup which can be clicked to open the panel. They can also be opened via a [[client event]], or left entirely unavailable.


==Different types of Panels (Editor)==
Most panels render a html content. This means they can display text without additional formatting, but can also be styled using html, css, and javascript. This has the added benefit that those panels can also be opened in a web browser, or included in the rendering of a [[web interface]].
: Panels for users to implement in their project, come in different flavors; Single Panels and Template Panels. There are also Tools available for managing/ editing panels. Most panels are linked to a specific location in the 3D world, usually after interaction with a dedicated pop up icon, although this is not required.
<br style="clear:left;">


===Single Panels===
==Panel types==
: Single panels are panels that need to be created for each instance of the panel. These panels contain plain text, an URL to a web page, or even calculations based on a spread sheet.
There are 5 types of panels available in the Tygron Engine.


====Text Panel====
{| class="wikitable"
: A text panel displays plain text, which can be formatted using HTML tags.
|-
<br>
! Panel type
{{Editor steps|title=add a Text Panel|In the Editor main View, select Indicators|Select Panels|Select to add a Single Text panel|Ensure the newly added panel is highlighted|Enter the plain text, and adjust the other panel details on the right side of the screen|Select 'Open panel' to view the panel|See also [[Panels#Editing Panel Details|Editing Panel Details]]}}
! Description
<br>
! Functioning
<gallery mode="nolines">
|-
File:Panels-SelectIndicators.jpg|In the Editor main View, select Indicators
| Text panel
File:Panels-SelectPanels.jpg|Select Panels
| The contents of the panel are defined directly as text.
File:Panels-AddTextPanel.jpg|Select to add a Single Text panel
| The text is interpreted as html content and directly displayed as content of the panel. If it's html-formatted content, it will be displayed in that styled manner.  
File:Panels-HighlightTextPanel.jpg|Ensure the newly added panel is highlighted
|-
File:Panels-AddText.jpg|Enter the plain text, and adjust the other panel details on the right side of the screen
| Web panel
File:Panels-SelectOpenPanel.jpg|Select 'Open panel' to view the panel
| The contents of the panel are defined by a url.
</gallery>
| The web page at that url is used as content for the panel. When attempting to open the panel in a web browser, the web page will be accessed directly (i.e. not via the Tygron Engine).
====Web Panel====
|-
: A Web panel displays a web page, based on the entered URL (link).
| Global panel
<br>
| One or more [[global]]s are linked to this panel, allowing an end-user to edit the values of those globals during a session.
{{Editor steps|title=add a Web Panel|In the Editor main View, select Indicators|Select Panels|Select to add a Single Web panel|Ensure the newly added panel is highlighted|Enter the URL (link), and adjust the other panel details on the right side of the screen|Select 'Open panel' to view the Website|See also [[Panels#Editing Panel Details|Editing Panel Details]]}}
| The panel has a predefined structure in the [[session interface]], and a fixed location. For each linked global, an input field with that global's value is displayed. The value can be changed and submitted by an end-user in the session. This will change the value of the global to the entered value. This panel does not have an html representation, and cannot be opened in the web browser or be made part of the [[web interface]].
<br>
|-
<gallery mode="nolines">
| Excel panel
File:Panels-SelectIndicators.jpg|In the Editor main View, select Indicators
| The contents of the panel are defined by an [[excel]] file.
File:Panels-SelectPanels.jpg|Select Panels
| Each time data in the [[project]] or [[session]] is updated, the excel file is recalculated. The results are interpreted as (html-formatted) text, and displayed as such. Effectively, this panel is similar to a text panel, but rather than a static definition for the text contents, the definition is dynamically generated via the excel.
File:Panels-AddWebPanel.jpg|Select to add a Single Web panel
|-
File:Panels-HighlightWebPanel.jpg|Ensure the newly added panel is highlighted
| Template excel panel
File:Panels-AddURL.jpg|Enter the plain text, and adjust the other panel details on the right side of the screen
| This is not a panel by itself, but forms a definition by which panels can be generated automatically. The "instances" of these panels behave as regular panels.
File:Panels-SelectOpenWebPanel.jpg|Select 'Open panel' to view the panel
| Based on how the template panel is defined, a number of "instances" of the panel will be generated. Configurations such as the size, model, and [[attribute]]s of the panel are carried over directly. The panel name, the assigned [[stakeholder]], and certain [[TQL|queries]] in the excel are modified based on what the template panel is applied on.
</gallery>
====Excel Panel====
: An Excel panel contains a calculation that has impact on/ is influenced by changes in the 3D world.
<br>
{{Editor steps|title=add an Excel Panel|In the Editor main View, select Indicators|Select Panels|Select to add a Single Excel panel|Ensure the newly added panel is highlighted|Upload the prepared excel file, and adjust the other panel details on the right side of the screen|Select 'Open panel' to view the panel|See also [[Panels#Editing Panel Details|Editing Panel Details]]}}
<br>
<gallery mode="nolines">
File:Panels-SelectIndicators.jpg|1. In the Editor main View, select Indicators
File:Panels-SelectPanels.jpg|2. Select Panels
File:Panels-AddExcelPanel.jpg|3. Select to add a Single Excel panel
File:Panels-HighlightExcelPanel.jpg|4. Ensure the newly added panel is highlighted
File:Panels-UploadExcel.jpg|5. Upload the prepared excel file, and adjust the other panel details on the right side of the screen
File:Panels-SelectOpenExcelPanel.jpg|6. Select 'Open panel' to view the panel
</gallery>
{| border="1" style="border-collapse:collapse; background-color:#ffffcc;"
|Tip: To implement calculation models with a spreadsheet in the engine, it is possible to create an excel panel without actually displaying this panel. See also: [[Calculation Models]].
|}
|}
===Template panels===
: Single panels are panels that are created once, and then reused for every other equal situation.


====Simple Template Panel====
==Use-cases for panels==
====Noise Template Panel====
 
====Dangerous Objects template Panel====
==Adding and editing single panels==
====Wikipedia Points (of Interest) Template Panel====
 
===Adding/removing panels===
{{Editor ribbon|header=Indicators|bar=Panels}}
[[File:panels-left.jpg|framed|left|The [[left panel]] for panels in the editor.]]
 
{{Editor steps|title=add a single panel|Select the desired panel type at the bottom of the [[left panel]].|Select "Add Panel".}}
{{Editor steps|title=remove a single panel|Select the "Single Panels" category in the [[left panel]]. Select the specific panel you wish to remove.|Select "Remove".}}
<br style="clear:both;">
 
===Configuring panels===
 
==Adding and editing template panels==
 
===Adding/removing template panels===
 
{{Editor steps|title=add a template panel|Select the desired panel type at the bottom of the [[left panel]].|Select "Add Panel".}}
{{Editor steps|title=remove an instance of a template panel|Select the "Single Panels" category in the [[left panel]]. Select the specific panel you wish to remove.|Select "Remove".}}
{{Editor steps|title=remove a template panel and all instances|Select the "Single Panels" category in the [[left panel]]. Select the specific panel you wish to remove.|Select "Remove".}}


===Tools===
===Configuring and instantiating panels===
====Show Panels====
====Apply All Template Panels====
====Delete All Template Panels====
====Show Panels Documentation====
==Editing Panel Details==
===Name===
===Panel Width===
===Panel Height===
===Visible===
===Request Attention===
===Assign to Stakeholder===
===Model===
===Overlay===
===Panel Text===
===Web Link===
===Select Excelsheet===
===Open panel===
===Set Point===
===Remove Point===

Revision as of 13:58, 30 July 2018

Template:Learned

This article is a stub.

Panels

Panels, in a software context, are windows, dialogs or similar generic interface elements which are presented to a user. They can be small prompts or dialogs which facilitate an inquiry or message towards a user. They can also be larger, more complex interface components with multiple texts and/or elements on them.

Panels in the Tygron Engine?

File:ReleaseNotesPanel.jpg
Release Notes Panel from Editor

In a project, panels are a term specifically used for a user-defined interface element, which can be created and configured in the editor. They are purposefully left generic and abstract. The contents are entirely left open for a project- or template-specific implementation. Panels can be placed in the 3D world, where they are represented by a popup which can be clicked to open the panel. They can also be opened via a client event, or left entirely unavailable.

Most panels render a html content. This means they can display text without additional formatting, but can also be styled using html, css, and javascript. This has the added benefit that those panels can also be opened in a web browser, or included in the rendering of a web interface.

Panel types

There are 5 types of panels available in the Tygron Engine.

Panel type Description Functioning
Text panel The contents of the panel are defined directly as text. The text is interpreted as html content and directly displayed as content of the panel. If it's html-formatted content, it will be displayed in that styled manner.
Web panel The contents of the panel are defined by a url. The web page at that url is used as content for the panel. When attempting to open the panel in a web browser, the web page will be accessed directly (i.e. not via the Tygron Engine).
Global panel One or more globals are linked to this panel, allowing an end-user to edit the values of those globals during a session. The panel has a predefined structure in the session interface, and a fixed location. For each linked global, an input field with that global's value is displayed. The value can be changed and submitted by an end-user in the session. This will change the value of the global to the entered value. This panel does not have an html representation, and cannot be opened in the web browser or be made part of the web interface.
Excel panel The contents of the panel are defined by an excel file. Each time data in the project or session is updated, the excel file is recalculated. The results are interpreted as (html-formatted) text, and displayed as such. Effectively, this panel is similar to a text panel, but rather than a static definition for the text contents, the definition is dynamically generated via the excel.
Template excel panel This is not a panel by itself, but forms a definition by which panels can be generated automatically. The "instances" of these panels behave as regular panels. Based on how the template panel is defined, a number of "instances" of the panel will be generated. Configurations such as the size, model, and attributes of the panel are carried over directly. The panel name, the assigned stakeholder, and certain queries in the excel are modified based on what the template panel is applied on.

Use-cases for panels

Adding and editing single panels

Adding/removing panels

Template:Editor ribbon

The left panel for panels in the editor.
How to add a single panel:
  1. Select the desired panel type at the bottom of the left panel.
  2. Select "Add Panel".
How to remove a single panel:
  1. Select the "Single Panels" category in the left panel. Select the specific panel you wish to remove.
  2. Select "Remove".


Configuring panels

Adding and editing template panels

Adding/removing template panels

How to add a template panel:
  1. Select the desired panel type at the bottom of the left panel.
  2. Select "Add Panel".
How to remove an instance of a template panel:
  1. Select the "Single Panels" category in the left panel. Select the specific panel you wish to remove.
  2. Select "Remove".
How to remove a template panel and all instances:
  1. Select the "Single Panels" category in the left panel. Select the specific panel you wish to remove.
  2. Select "Remove".

Configuring and instantiating panels

Retrieved from "https://support.tygron.com/w/index.php?title=Panel&oldid=14995"