Panels (template panels) tutorial - Revision history

Rudolf@tygron.nl at 10:52, 3 March 2023

2023-03-03T10:52:05Z

← Older revision		Revision as of 10:52, 3 March 2023
Line 155:		Line 155:
	\|}		\|}

	{{header\|level=2\|color=#c45911\|Final ~~Assignments~~}}		{{header\|level=2\|color=#c45911\|Final assignments}}
	Using the information learned in this tutorial, you are able to create alerts for your project. An alert is a message which will appear in the [[3D Visualization]] of the end-user when something is wrong in the [[project area]]. These could be violations of regulations, excessive risks, inappropriate urban planning, and more.		Using the information learned in this tutorial, you are able to create alerts for your project. An alert is a message which will appear in the [[3D Visualization]] of the end-user when something is wrong in the [[project area]]. These could be violations of regulations, excessive risks, inappropriate urban planning, and more.

Frank@tygron.nl at 12:34, 1 March 2023

2023-03-01T12:34:31Z

← Older revision		Revision as of 12:34, 1 March 2023
Line 10:		Line 10:
	In the editor, go to:		In the editor, go to:
	{{Editor location\|Panels\|}}		{{Editor location\|Panels\|}}
	You can add a Template excel either by selecting the "Add Simple Template" option in the [[ribbon ~~hover menu\|ribbon hover menu~~]], or by selecting TEMPLATE_EXCEL_PANEL in the left panel, followed by "Add".		You can add a Template excel either by selecting the "Add Simple Template" option in the popup menu for Panels in the [[ribbon]], or by selecting TEMPLATE_EXCEL_PANEL in the left panel, followed by "Add".
	The panel will be added in the Template Panels category.		The panel will be added in the Template Panels category.
	[[File:panels-editor-added-templateexcelpanel.jpg\|350px\|frame\|center\|The Template excel panel has been added.]]		[[File:panels-editor-added-templateexcelpanel.jpg\|350px\|frame\|center\|The Template excel panel has been added.]]

Frank@tygron.nl at 17:19, 30 January 2023

2023-01-30T17:19:02Z

Maxim@tygron.com at 15:41, 5 October 2022

2022-10-05T15:41:04Z

← Older revision		Revision as of 15:41, 5 October 2022
Line 1:		Line 1:
	~~{{learned\|what panels are\|what kind of panels are available\|how to add and configure the basic types of panels}}~~
	{{tutorial prerequisites		{{tutorial prerequisites
	\|tutorial=This tutorial is a continuation of the [[panels_tutorial\|panels tutorial]]. If you have not already done so, please complete that tutorial first.		\|tutorial=This tutorial is a continuation of the [[panels_tutorial\|panels tutorial]]. If you have not already done so, please complete that tutorial first.

Rudolf@tygron.nl at 11:49, 9 June 2020

2020-06-09T11:49:15Z

← Older revision		Revision as of 11:49, 9 June 2020
Line 54:		Line 54:

	==ID-queries==		==ID-queries==
	When creating a panel for every neighborhood, or every area, or every spatial datum of a given type, most use-cases desire that information related to that specific item is displayed or used in determining the content of that panel. For this, a new syntax can be used in TQL called an “ID” query. A specific id in a query can be replaced by “ID” to mean as much as “(of) the item concerned”. The following will demonstrate its usage and effect.		When creating a panel for every neighborhood, or every area, or every spatial datum of a given type, most use-cases desire that information related to that specific item is displayed or used in determining the content of that panel. For this, a new syntax can be used in TQL called an “ID” query. A specific [[ID]] in a query can be replaced by “ID” to mean as much as “(of) the item concerned”. The following will demonstrate its usage and effect.

	Update your excel sheet, make the following changes:		Update your excel sheet, make the following changes:

Rudolf@tygron.nl at 15:57, 9 May 2019

2019-05-09T15:57:23Z

← Older revision		Revision as of 15:57, 9 May 2019
Line 10:		Line 10:
	==Adding a Template Excel panel==		==Adding a Template Excel panel==
	In the editor, go to:		In the editor, go to:
	{{Editor ~~ribbon~~\|~~header=Indicators\|bar=~~Panels\|}}		{{Editor location\|Panels\|}}
	You can add a Template excel either by selecting the "Add Simple Template" option in the [[ribbon hover menu\|ribbon hover menu]], or by selecting TEMPLATE_EXCEL_PANEL in the left panel, followed by "Add".		You can add a Template excel either by selecting the "Add Simple Template" option in the [[ribbon hover menu\|ribbon hover menu]], or by selecting TEMPLATE_EXCEL_PANEL in the left panel, followed by "Add".
	The panel will be added in the Template Panels category.		The panel will be added in the Template Panels category.

Rudolf@tygron.nl at 11:56, 11 June 2018

2018-06-11T11:56:06Z

← Older revision		Revision as of 11:56, 11 June 2018
Line 1:		Line 1:
	{{learned\|what panels are\|what kind of panels are available\|how to add and configure the basic types of panels~~}}{{stub~~}}		{{learned\|what panels are\|what kind of panels are available\|how to add and configure the basic types of panels}}
	{{tutorial prerequisites		{{tutorial prerequisites
	\|tutorial=This tutorial is a continuation of the [[panels_tutorial\|panels tutorial]]. If you have not already done so, please complete that tutorial first.		\|tutorial=This tutorial is a continuation of the [[panels_tutorial\|panels tutorial]]. If you have not already done so, please complete that tutorial first.

Rudolf@tygron.nl: /* Additional attributes to update */

2018-06-11T11:55:28Z

Additional attributes to update

← Older revision		Revision as of 11:55, 11 June 2018
Line 164:		Line 164:
	# Modify the alert and the data in your project so that the threshold value differs per neighborhood. (Hint: look into creating an attribute for the neighborhoods)		# Modify the alert and the data in your project so that the threshold value differs per neighborhood. (Hint: look into creating an attribute for the neighborhoods)
	# Modify the alert so that while the threshold value for a neighborhood is not exceeded, the popup of the alert is indicative of being informative, but that when the threshold value is exceeded, the popup of the alert is indicative of there being a problem.		# Modify the alert so that while the threshold value for a neighborhood is not exceeded, the popup of the alert is indicative of being informative, but that when the threshold value is exceeded, the popup of the alert is indicative of there being a problem.

			{{Tutorial completed
			\| learned=how to create and use template panels in your project
			\| next=Panels (interaction)
			\| next-topic=buttons, and how to allow the end-user to interact with the sessions using panels
			}}

Rudolf@tygron.nl: /* Additional attributes to update */

2018-06-11T11:52:55Z

Additional attributes to update

← Older revision		Revision as of 11:52, 11 June 2018
Line 155:		Line 155:
	\| An easy way to determine which value relates to which popup model is to change the POPUP_TYPE attribute in the right panel for a visible popup, and seeing which model it displays.		\| An easy way to determine which value relates to which popup model is to change the POPUP_TYPE attribute in the right panel for a visible popup, and seeing which model it displays.
	\|}		\|}

			{{header\|level=2\|color=#c45911\|Final Assignments}}
			Using the information learned in this tutorial, you are able to create alerts for your project. An alert is a message which will appear to the end-user when something is wrong in the 3D world. These could be violations of regulations, excessive risks, inappropriate urban planning, and more.

			As preparation for this assignment, add a Heat Stress overlay to the project.
			# Create an alert using Template Excel panel, which appears to a specific stakeholder when the heat stress exceeds a threshold value.
			# Modify the alert, so that it appears when the average heat stress in that neighborhood exceeds either the threshold value or the average heat stress in the entire 3D world.
			# Modify the alert and the data in your project so that the threshold value differs per neighborhood. (Hint: look into creating an attribute for the neighborhoods)
			# Modify the alert so that while the threshold value for a neighborhood is not exceeded, the popup of the alert is indicative of being informative, but that when the threshold value is exceeded, the popup of the alert is indicative of there being a problem.

Rudolf@tygron.nl: /* Additional attributes to update */

2018-06-11T11:50:12Z

Additional attributes to update

← Older revision		Revision as of 11:50, 11 June 2018
Line 137:		Line 137:

	===Additional attributes to update===		===Additional attributes to update===
	It’s possible to update arbitrary updates for many data types. Those attributes can then be used by other panels, indicators, or other parts of the project. Some attributes hold special meaning in the context of certain data types, such as the ~~“VISIBLE”~~ for panels. The following attributes have special meaning when defined for panels.		It’s possible to update arbitrary updates for many data types. Those attributes can then be used by other panels, indicators, or other parts of the project. Some attributes hold special meaning in the context of certain data types, such as the "VISIBLE" attribute for panels. The following attributes have special meaning when defined for panels.
	{\| class='wikitable'		{\| class='wikitable'
	! Attribute		! Attribute

← Older revision		Revision as of 17:19, 30 January 2023
Line 14:		Line 14:
	[[File:panels-editor-added-templateexcelpanel.jpg\|350px\|frame\|center\|The Template excel panel has been added.]]		[[File:panels-editor-added-templateexcelpanel.jpg\|350px\|frame\|center\|The Template excel panel has been added.]]

	Generally, the configuration options for the Template panel are the same as for the other panels, with 2 important differences. It is not possible to open the panel or to place it in the ~~3D world~~ as a popup. Instead, there are options to apply the template on spatial data, such as neighborhoods or areas. This will create an instance of this panel, based on how you configured the Template Excel panel, for every spatial datum which meets your specification.		Generally, the configuration options for the Template panel are the same as for the other panels, with 2 important differences. It is not possible to open the panel or to place it in the [[project area]] as a [[popup]]. Instead, there are options to apply the template on spatial data, such as neighborhoods or areas. This will create an instance of this panel, based on how you configured the Template Excel panel, for every spatial datum which meets your specification.

	===Create an Excel file===		===Create an Excel file===
Line 41:		Line 41:

	Click “Yes”, and the panels will be created.		Click “Yes”, and the panels will be created.
	The panels will be visible in the 3D ~~world~~, and can be found in the left panel as sub-items of the Template Excel panel.		The panels will be visible in the [[3D Visualization]], and can be found in the left panel as sub-items of the Template Excel panel.
	[[File:panels-editor-applied-templateexcelpanel.jpg\|350px\|frame\|center\|The Template excel panel has been applied, and instanced of the panel have been added.]]		[[File:panels-editor-applied-templateexcelpanel.jpg\|350px\|frame\|center\|The Template excel panel has been applied, and instanced of the panel have been added.]]

Line 47:		Line 47:

	It is possible to tweak the properties of an instance of a Template Excel Panel, for example change its model or underlying excel sheet, but this is discouraged. When the Template Excel Panel is updated and reapplied, all existing instances of that Template Excel Panel are removed, and new ones are created. Any changes you have made to those instances will be lost.		It is possible to tweak the properties of an instance of a Template Excel Panel, for example change its model or underlying excel sheet, but this is discouraged. When the Template Excel Panel is updated and reapplied, all existing instances of that Template Excel Panel are removed, and new ones are created. Any changes you have made to those instances will be lost.
	Open any of the instanced panels, either by selecting them in the editor and clicking “Open Panel”, or by clicking on their popup in the 3D ~~world~~.		Open any of the instanced panels, either by selecting them in the editor and clicking “Open Panel”, or by clicking on their [[popup]] in the [[3D Visualization]].
	[[File:panels-editor-display-templateexcelpanel-1.jpg\|350px\|frame\|center\|The Template excel panel instance displays content as generated by the excel file applied to the Template excel panel.]]		[[File:panels-editor-display-templateexcelpanel-1.jpg\|350px\|frame\|center\|The Template excel panel instance displays content as generated by the excel file applied to the Template excel panel.]]

Line 129:		Line 129:
	Click on “Apply Template” to create new instances of the panels.		Click on “Apply Template” to create new instances of the panels.

	Notice that the same amount of panels have been created, as can be seen in the left panel. However, not all popups are visible in the 3D ~~world~~.		Notice that the same amount of panels have been created, as can be seen in the left panel. However, not all popups are visible in the 3D Visualization.

	In the left panel, select one of the panel instances of which the popup is visible in the 3D ~~world~~. In the right panel, select the “Attributes” tab, and notice that the “VISIBLE” attribute is a positive value.		In the left panel, select one of the panel instances of which the popup is visible in the 3D Visualization. In the right panel, select the “Attributes” tab, and notice that the “VISIBLE” attribute is a positive value.

	In the left panel, select one of the panel instances of which the popup is not visible in the 3D ~~world~~. In the right panel, select the “Attributes” tab, and notice that the “VISIBLE” attribute is a negative value.		In the left panel, select one of the panel instances of which the popup is not visible in the 3D Visualization. In the right panel, select the “Attributes” tab, and notice that the “VISIBLE” attribute is a negative value.

	===Additional attributes to update===		===Additional attributes to update===
Line 143:		Line 143:
	\|-		\|-
	\| VISIBLE		\| VISIBLE
	\| Whether the popup is visible in the 3D ~~world~~. If the panels can only be opened via the 3D ~~world~~, this directly affects whether a stakeholder can access the panel or the information in it.		\| Whether the popup is visible in the 3D Visualization. If the panels can only be opened via the 3D Visualization, this directly affects whether a stakeholder can access the panel or the information in it.
	\| Any value greater than 0 means that the popup is visible. A value of 0 or less means the popup is invisible.		\| Any value greater than 0 means that the popup is visible. A value of 0 or less means the popup is invisible.
	\|-		\|-
Line 151:		Line 151:
	\|-		\|-
	\|POPUP_TYPE		\|POPUP_TYPE
	\| Which 3D model to use for the popup in the 3D ~~world~~. This makes it possible to switch between, for example, a green check and a red X.		\| Which 3D model to use for the popup in the 3D Visualization. This makes it possible to switch between, for example, a green check and a red X.
	\| An easy way to determine which value relates to which popup model is to change the POPUP_TYPE attribute in the right panel for a visible popup, and seeing which model it displays.		\| An easy way to determine which value relates to which popup model is to change the POPUP_TYPE attribute in the right panel for a visible popup, and seeing which model it displays.
	\|}		\|}

	{{header\|level=2\|color=#c45911\|Final Assignments}}		{{header\|level=2\|color=#c45911\|Final Assignments}}
	Using the information learned in this tutorial, you are able to create alerts for your project. An alert is a message which will appear to the end-user when something is wrong in the ~~3D world~~. These could be violations of regulations, excessive risks, inappropriate urban planning, and more.		Using the information learned in this tutorial, you are able to create alerts for your project. An alert is a message which will appear in the [[3D Visualization]] of the end-user when something is wrong in the [[project area]]. These could be violations of regulations, excessive risks, inappropriate urban planning, and more.

	As preparation for this assignment, add a Heat Stress overlay to the project.		As preparation for this assignment, add a Heat Stress overlay to the project.
	# Create an alert using Template Excel panel, which appears to a specific stakeholder when the heat stress exceeds a threshold value.		# Create an alert using Template Excel panel, which appears to a specific stakeholder when the heat stress exceeds a threshold value.
	# Modify the alert, so that it appears when the average heat stress in that neighborhood exceeds either the threshold value or the average heat stress in the entire ~~3D world~~.		# Modify the alert, so that it appears when the average heat stress in that neighborhood exceeds either the threshold value or the average heat stress in the entire [[project area]].
	# Modify the alert and the data in your project so that the threshold value differs per neighborhood. (Hint: look into creating an attribute for the neighborhoods)		# Modify the alert and the data in your project so that the threshold value differs per neighborhood. (Hint: look into creating an attribute for the neighborhoods)
	# Modify the alert so that while the threshold value for a neighborhood is not exceeded, the popup of the alert is indicative of being informative, but that when the threshold value is exceeded, the popup of the alert is indicative of there being a problem.		# Modify the alert so that while the threshold value for a neighborhood is not exceeded, the popup of the alert is indicative of being informative, but that when the threshold value is exceeded, the popup of the alert is indicative of there being a problem.