How to edit Indicator properties: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 20: | Line 20: | ||
====Absolute score==== | ====Absolute score==== | ||
[[File:Absolute_score.png|frame|right|The checkbox for the "absolute score".]] | [[File:Absolute_score.png|frame|right|The checkbox for the "absolute score".]] | ||
''If the checkbox for absolute score is checked, the absolute score of the Indicator is used. The score is a value between 0 and 100%. | ''If the checkbox for absolute score is checked, the absolute score of the Indicator is used. The score is a value between 0 and 100%. This checkbox determines how 0% is defined. If the checkbox is not checked, 0% is the state of the current situation. The Indicator therefore always starts at 0. If you make changes to the current situation by demolishing or constructing [[Buildings]], a new score is calculated based on the impact of the changes to the current situation. If you use the absolute score, a score is already calculated for the current situation, therefore the Indicator can already have a value of for example 60%. By making changes to the current situation, the score changes. Here the 0% is thus defined by the formulas in the excelsheet of the Indicator.'' | ||
====Graph==== | ====Graph==== | ||
[[File:Score_graph.png|frame|right|The checkbox to show the "score graph".]] | [[File:Score_graph.png|frame|right|The checkbox to show the "score graph".]] | ||
'' | ''Checking the 'show score graph' box makes the score graph visible in the Indicator panel. By leaving the text in the description box empty, the full space in the indicator panel can be used for example for showing the output of an [[Indicator]].'' | ||
====Color==== | ====Color==== | ||
[[File:Color.png|frame|right|The "color" square.]] | [[File:Color.png|frame|right|The "color" square.]] | ||
: ''The color of the indicator. The color will be used to display the indicator in graphs and charts. You can change this selecting the color field. A panel will appear in which you can specify the desired color.''<br clear=right> | : ''The color of the indicator. The color will be used to display the indicator in graphs and charts. You can change this by selecting the color field. A panel will appear in which you can specify the desired color.''<br clear=right> | ||
====Active==== | ====Active==== | ||
| Line 36: | Line 36: | ||
====Image==== | ====Image==== | ||
[[File:Image.png|frame|right|The "image" selection field.]] | [[File:Image.png|frame|right|The "image" selection field.]] | ||
: ''The Indicator image, as displayed on the top bar, next to the Indicator progression bar. It is possible to upload a custom image to the {{software}}. This image has to be uploaded as a .png file, and | : ''The Indicator image, as displayed on the top bar, next to the Indicator progression bar. It is possible to upload a custom image to the {{software}}. This image has to be uploaded as a .png file, and must be exactly 39 x 39 pixels.''<br clear=right> | ||
====Excelsheet==== | ====Excelsheet==== | ||
[[File:Excelsheet.png|frame|right|The "Excelsheet" field.]] | [[File:Excelsheet.png|frame|right|The "Excelsheet" field.]] | ||
: ''The Excelsheet section | : ''The Excelsheet section shows which Excelsheet is active for the specific Indicator. The [[Excel_file_manager|Select Excelsheet]] button opens an overview panel of all the Excelsheets in the project. The [[Excel#Debugging|Debug Excelsheet]] and [[CallTree Recordings|CallTree Recordings]] can be used for debugging the Excelsheet. This is mostly done when an error message appears about the Excelsheet. The Open in Web Browser link displays the target and score of the indicator in a separate web page.''<br clear=right> | ||
====Description==== | ====Description==== | ||
| Line 55: | Line 55: | ||
*[[Api session event editor indicator set image]] | *[[Api session event editor indicator set image]] | ||
*[[Api session event editor indicator set description]] | *[[Api session event editor indicator set description]] | ||
*[[Api session event editor indicator set stakeholder]] | |||
*[[Api session event editor indicator set absolute]] | |||
*[[Api session event editor indicator set color]] | |||
*[[Api session event editor indicator set excel]] | |||
*[[Api session event editor indicator add]] | *[[Api session event editor indicator add]] | ||
*[[Api session event editor indicator remove]] | *[[Api session event editor indicator remove]] | ||
Latest revision as of 11:29, 15 July 2026
Stakeholder
- The stakeholder of the Indicator. Stakeholder-specific Indicators have a connection with a single stakeholder. When editing a stakeholder-specific Indicator, you can change this by selecting a different stakeholder from the dropdown menu.
Name
- The full name of the Indicator. This is the name that will appear as the title of the Indicator in the project. You can change this by altering the text in the "Name" field.
Short name
- The short name of the Indicator. This will appear in areas where multiple indicators are summed up. You can change this by altering the text in the "Short name" field.
Absolute score
If the checkbox for absolute score is checked, the absolute score of the Indicator is used. The score is a value between 0 and 100%. This checkbox determines how 0% is defined. If the checkbox is not checked, 0% is the state of the current situation. The Indicator therefore always starts at 0. If you make changes to the current situation by demolishing or constructing Buildings, a new score is calculated based on the impact of the changes to the current situation. If you use the absolute score, a score is already calculated for the current situation, therefore the Indicator can already have a value of for example 60%. By making changes to the current situation, the score changes. Here the 0% is thus defined by the formulas in the excelsheet of the Indicator.
Graph
Checking the 'show score graph' box makes the score graph visible in the Indicator panel. By leaving the text in the description box empty, the full space in the indicator panel can be used for example for showing the output of an Indicator.
Color
- The color of the indicator. The color will be used to display the indicator in graphs and charts. You can change this by selecting the color field. A panel will appear in which you can specify the desired color.
Active
- Whether the Indicator is active. Inactive Indicators remain connected to stakeholders, but are unseen and have no effect. Toggle between the Indicator being active and inactive by clicking the check box.
Image
- The Indicator image, as displayed on the top bar, next to the Indicator progression bar. It is possible to upload a custom image to the Tygron Platform. This image has to be uploaded as a .png file, and must be exactly 39 x 39 pixels.
Excelsheet
- The Excelsheet section shows which Excelsheet is active for the specific Indicator. The Select Excelsheet button opens an overview panel of all the Excelsheets in the project. The Debug Excelsheet and CallTree Recordings can be used for debugging the Excelsheet. This is mostly done when an error message appears about the Excelsheet. The Open in Web Browser link displays the target and score of the indicator in a separate web page.
Description
- The description of the Indicator. Most Indicators have a default description, but by customizing this text it is possible to guide the users towards specific actions, provide hints or refer to other sources of information. You can change this by altering the text in the "Description" area.
See also
API Endpoints
- Api session event editor indicator set name
- Api session event editor indicator set short name
- Api session event editor indicator set active
- Api session event editor indicator set image
- Api session event editor indicator set description
- Api session event editor indicator set stakeholder
- Api session event editor indicator set absolute
- Api session event editor indicator set color
- Api session event editor indicator set excel
- Api session event editor indicator add
- Api session event editor indicator remove