Label and Link - Revision history

Ollvihe: /* Clickable link */

2025-08-16T19:22:34Z

Clickable link

← Older revision		Revision as of 19:22, 16 August 2025
Line 20:		Line 20:

	== Clickable link ==		== Clickable link ==
	'''Link target''' field in the ~~Link & Label~~ settings defines a link to another dashboard (defined as the target [[Dashboard_Variables#System_Variables\|dashboard identifier]]) or to an external web page. The external link is identified as a external web link if it's starting with ''http://'' or ''https://''. The target dashboard opens to the same browser tab and the external web page opens to a new tab.		'''Link target''' field in the settings defines a link to another dashboard (defined as the target [[Dashboard_Variables#System_Variables\|dashboard identifier]]) or to an external web page. The external link is identified as a external web link if it's starting with ''http://'' or ''https://''. The target dashboard opens to the same browser tab and the external web page opens to a new tab.

	== Dashboard component actions ==		== Dashboard component actions ==

Ollvihe: /* Link */

2025-08-16T19:22:07Z

Link

← Older revision		Revision as of 19:22, 16 August 2025
Line 19:		Line 19:
	* '''Border corner radius''': Rounding of the border corners.		* '''Border corner radius''': Rounding of the border corners.

	== ~~Link~~ ==		== Clickable link ==
	'''Link target''' defines a link to ~~other~~ dashboard (defined as the target dashboard identifier) or to an external web page. The link is identified as a external web link if it's starting with ''http://'' or ''https://''.		'''Link target''' field in the Link & Label settings defines a link to another dashboard (defined as the target [[Dashboard_Variables#System_Variables\|dashboard identifier]]) or to an external web page. The external link is identified as a external web link if it's starting with ''http://'' or ''https://''. The target dashboard opens to the same browser tab and the external web page opens to a new tab.

	== Dashboard component actions ==		== Dashboard component actions ==

Ollvihe: /* Set variables action */

2025-08-16T19:20:13Z

Set variables action

← Older revision		Revision as of 19:20, 16 August 2025
Line 28:		Line 28:
	When the action type is '''SetVariable''', the defined dashboard variable values are set. This action type supports the '''parameters''' field which is a JSON object that defines the variables to be set. If the sys:dashboard or sys:dashboardIdentifier is among the variables, the variables are set in the session context, and otherwise in the dashboard context.		When the action type is '''SetVariable''', the defined dashboard variable values are set. This action type supports the '''parameters''' field which is a JSON object that defines the variables to be set. If the sys:dashboard or sys:dashboardIdentifier is among the variables, the variables are set in the session context, and otherwise in the dashboard context.

	Example of a ~~SetVariable~~ action:		Example of a set variables action:
	<syntaxhighlight lang="json" line>		<syntaxhighlight lang="json" line>
	[		[

Ollvihe: /* Run script action */

2025-08-16T19:20:04Z

Run script action

← Older revision		Revision as of 19:20, 16 August 2025
Line 42:		Line 42:

	=== Run script action ===		=== Run script action ===
	When the action type is '''RunScript''', the defined script is run and its return value is shown as a popup dialog or ~~sets~~ dashboard ~~variables~~. If the script returns a json object, the variable-value pairs in the json object are set as dashboard variables. If the script returns other value than a json object (such as a string), the return value is shown as a popup message. The same action parameters are supported as in the [[Actions_to_Run_Script_in_Table#Action_settings\|actions to run a script in a table]].		When the action type is '''RunScript''', the defined script is run and its return value is shown as a popup dialog or dashboard variable values are set based on the result. If the script returns a json object, the variable-value pairs in the json object are set as dashboard variables. If the script returns other value than a json object (such as a string), the return value is shown as a popup message. The same action parameters are supported as in the [[Actions_to_Run_Script_in_Table#Action_settings\|actions to run a script in a table]]. See also the [[Actions_to_Run_Script_in_Table#Example_scripts\|example scripts]].

	The parameters are passed to the script and are available as variables ~~in the script~~:		The parameters are passed to the script and are available as following script variables:
	* '''variables''': ~~A dictionary~~ of dashboard variables.		* '''variables''': Dictionary of all dashboard variables with values when the action was started.
	* '''action''': ~~A dictionary~~ containing settings of the clicked action. This is used to access the action parameters.		* '''action''': Dictionary containing settings of the clicked action. This is used to access the action parameters.
	* '''chartSettings''': ~~A dictionary~~ containing the dashboard component ~~settings~~.		* '''chartSettings''': Dictionary containing the dashboard component configuration.

	Example of a ~~RunScript~~ action:		Example of a run script action:
	<syntaxhighlight lang="json" line>		<syntaxhighlight lang="json" line>
	[		[

Ollvihe: /* Dashboard component actions */

2025-08-16T19:01:41Z

Dashboard component actions

← Older revision		Revision as of 19:01, 16 August 2025
Line 23:		Line 23:

	== Dashboard component actions ==		== Dashboard component actions ==
	It is possible to have the Label and Link component either set [[Dashboard_Variables\|variable]] values or to run a script and have the script show the return value as a popup dialog or set dashboard variables. The configuration is done as JSON. When an action is configured, the action can be run by clicking the Label and Link component in the Preview mode. Only a single action can be configured. ~~The~~ action ~~types are:~~		It is possible to have the Label and Link component either set [[Dashboard_Variables\|variable]] values or to run a script and have the script show the return value as a popup dialog or set dashboard variables. The configuration is done as JSON. When an action is configured, the action can be run by clicking the Label and Link component in the Preview mode. Only a single action can be configured.
	* '''SetVariable'''~~: Sets~~ the defined dashboard variable values. This action type supports the ~~following field:~~
	** '''parameters'''~~: A~~ JSON object that defines the variables to be set. If the sys:dashboard or sys:dashboardIdentifier is among the variables, the variables are set in the session context, and otherwise in the dashboard context.		=== Set variables action ===
	:: Example of a SetVariable action:		When the action type is '''SetVariable''', the defined dashboard variable values are set. This action type supports the '''parameters''' field which is a JSON object that defines the variables to be set. If the sys:dashboard or sys:dashboardIdentifier is among the variables, the variables are set in the session context, and otherwise in the dashboard context.
	:: <syntaxhighlight lang="json" line>
			Example of a SetVariable action:
			<syntaxhighlight lang="json" line>
	[		[
	{		{
Line 36:		Line 38:
	}		}
	}		}
	]</syntaxhighlight>		]
	* '''RunScript'''~~: Runs~~ the defined script and ~~shows~~ return value as popup dialog or sets dashboard variables. If the script returns a json object, the ~~key~~-value pairs in the json object are set as dashboard variables. If the script returns other value than a json object, the return value is shown as a popup message. The same action parameters are supported as in the [[Actions_to_Run_Script_in_Table#Action_settings\|actions to run a script in a table]]. The parameters are passed to the script and are available as variables in the script:		</syntaxhighlight>
	** '''variables''': A dictionary of dashboard variables.
	** '''action''': A dictionary containing settings of the clicked action. This is used to access the action parameters.		=== Run script action ===
	** '''chartSettings''': A dictionary containing the dashboard component settings.		When the action type is '''RunScript''', the defined script is run and its return value is shown as a popup dialog or sets dashboard variables. If the script returns a json object, the variable-value pairs in the json object are set as dashboard variables. If the script returns other value than a json object (such as a string), the return value is shown as a popup message. The same action parameters are supported as in the [[Actions_to_Run_Script_in_Table#Action_settings\|actions to run a script in a table]].
	:: Example of a RunScript action:
	:: <syntaxhighlight lang="json" line>		The parameters are passed to the script and are available as variables in the script:
			* '''variables''': A dictionary of dashboard variables.
			* '''action''': A dictionary containing settings of the clicked action. This is used to access the action parameters.
			* '''chartSettings''': A dictionary containing the dashboard component settings.

			Example of a RunScript action:
			<syntaxhighlight lang="json" line>
	[		[
	{		{
Line 52:		Line 60:
	}		}
	}		}
	]</syntaxhighlight>		]
			</syntaxhighlight>

Ollvihe: /* Dashboard component actions */

2025-08-16T18:57:09Z

Dashboard component actions

← Older revision		Revision as of 18:57, 16 August 2025
Line 26:		Line 26:
	* '''SetVariable''': Sets the defined dashboard variable values. This action type supports the following field:		* '''SetVariable''': Sets the defined dashboard variable values. This action type supports the following field:
	** '''parameters''': A JSON object that defines the variables to be set. If the sys:dashboard or sys:dashboardIdentifier is among the variables, the variables are set in the session context, and otherwise in the dashboard context.		** '''parameters''': A JSON object that defines the variables to be set. If the sys:dashboard or sys:dashboardIdentifier is among the variables, the variables are set in the session context, and otherwise in the dashboard context.
	* '''RunScript''': Runs the defined script and shows return value as popup dialog or sets dashboard variables. If the script returns a json object, the key-value pairs in the json object are set as dashboard variables. If the script returns other value than a json object, the return value is shown as a popup message. The same action parameters are supported as in the [[Actions_to_Run_Script_in_Table#Action_settings\|actions to run a script in a table]]. The parameters are passed to the script and are available as variables in the script:
	** '''variables''': A dictionary of dashboard variables.
	** '''action''': A dictionary containing settings of the clicked action. This is used to access the action parameters.
	** '''chartSettings''': A dictionary containing the dashboard component settings.
	:: Example of a SetVariable action:		:: Example of a SetVariable action:
	:: <syntaxhighlight lang="json" line>		:: <syntaxhighlight lang="json" line>
Line 41:		Line 37:
	}		}
	]</syntaxhighlight>		]</syntaxhighlight>
			* '''RunScript''': Runs the defined script and shows return value as popup dialog or sets dashboard variables. If the script returns a json object, the key-value pairs in the json object are set as dashboard variables. If the script returns other value than a json object, the return value is shown as a popup message. The same action parameters are supported as in the [[Actions_to_Run_Script_in_Table#Action_settings\|actions to run a script in a table]]. The parameters are passed to the script and are available as variables in the script:
			** '''variables''': A dictionary of dashboard variables.
			** '''action''': A dictionary containing settings of the clicked action. This is used to access the action parameters.
			** '''chartSettings''': A dictionary containing the dashboard component settings.
	:: Example of a RunScript action:		:: Example of a RunScript action:
	:: <syntaxhighlight lang="json" line>		:: <syntaxhighlight lang="json" line>

Ollvihe: /* Example scripts */

2025-08-16T18:56:36Z

Example scripts

← Older revision		Revision as of 18:56, 16 August 2025
Line 54:		Line 54:
	}		}
	]</syntaxhighlight>		]</syntaxhighlight>

	~~== Example scripts ==~~

Ollvihe at 14:36, 16 August 2025

2025-08-16T14:36:47Z

Ollvihe at 14:33, 16 August 2025

2025-08-16T14:33:42Z

← Older revision		Revision as of 14:33, 16 August 2025
Line 7:		Line 7:
	When hovered, there is a tooltip showing the text, which is useful when all text doesn't fit to the available space.		When hovered, there is a tooltip showing the text, which is useful when all text doesn't fit to the available space.

			== Visual settings ==
	Label has the following visual settings:		Label has the following visual settings:
	* '''Font size''': Size of the label text in pixels, defined in 1 pixel granularity.		* '''Font size''': Size of the label text in pixels, defined in 1 pixel granularity.
Line 14:		Line 15:
	* '''Vertical alignment''': Vertical alignment of the label text: ''Top'', ''Centered'' or ''Bottom''. If you want to see scrollbar in the text when the text doesn't fit to the visible screen, use the Top vertical alignment.		* '''Vertical alignment''': Vertical alignment of the label text: ''Top'', ''Centered'' or ''Bottom''. If you want to see scrollbar in the text when the text doesn't fit to the visible screen, use the Top vertical alignment.
	* '''Link target''': Defines a link to other dashboard (defined as the target dashboard identifier) or to an external web page. The link is identified as a external web link if it's starting with ''http://'' or ''https://''.		* '''Link target''': Defines a link to other dashboard (defined as the target dashboard identifier) or to an external web page. The link is identified as a external web link if it's starting with ''http://'' or ''https://''.
			* '''Background color''': Background color of the label area.
			* '''Border color''': Border color of the label area. Note that the border is visible when its width is not zero.
			* '''Border width''': Border width of the label area.
			* '''Border corner radius''': Rounding of the border corners.

			== Dashboard component actions ==
	* '''Dashboard component actions''': It is possible to have the Label and Link component either set [[Dashboard_Variables\|variable]] values or to run a script and have the script show the return value as a popup dialog or set dashboard variables. The configuration is done as JSON. When an action is configured, the action can be run by clicking the Label and Link component in the Preview mode. Only a single action can be configured. The action types are:		* '''Dashboard component actions''': It is possible to have the Label and Link component either set [[Dashboard_Variables\|variable]] values or to run a script and have the script show the return value as a popup dialog or set dashboard variables. The configuration is done as JSON. When an action is configured, the action can be run by clicking the Label and Link component in the Preview mode. Only a single action can be configured. The action types are:
	** '''SetVariable''': Sets the defined dashboard variable values. This action type supports the following field:		** '''SetVariable''': Sets the defined dashboard variable values. This action type supports the following field:
Line 45:		Line 52:
	}		}
	]</syntaxhighlight>		]</syntaxhighlight>
	* '''Background color''': Background color of the label area.
	* '''Border color''': Border color of the label area. Note that the border is visible when its width is not zero.		== Example scripts ==
	* '''Border width''': Border width of the label area.
	* '''Border corner radius''': Rounding of the border corners.

TeeHiet: TK-58734

2025-06-09T13:10:32Z

TK-58734

@@ Line 14: / Line 14: @@
 * '''Vertical alignment''': Vertical alignment of the label text: ''Top'', ''Centered'' or ''Bottom''. If you want to see scrollbar in the text when the text doesn't fit to the visible screen, use the Top vertical alignment.
 * '''Link target''': Defines a link to other dashboard (defined as the target dashboard identifier) or to an external web page. The link is identified as a external web link if it's starting with ''http://'' or ''https://''.
 * '''Background color''': Background color of the label area.
 * '''Border color''': Border color of the label area. Note that the border is visible when its width is not zero.
 * '''Border width''': Border width of the label area.
 * '''Border corner radius''': Rounding of the border corners.

← Older revision		Revision as of 14:36, 16 August 2025
Line 14:		Line 14:
	* '''Horizontal alignment''': Horizontal alignment of the label text: ''Left'', ''Centered'', ''Right'' or ''Justified'' (justified means that full lines take the entire width by increasing spacing between words).		* '''Horizontal alignment''': Horizontal alignment of the label text: ''Left'', ''Centered'', ''Right'' or ''Justified'' (justified means that full lines take the entire width by increasing spacing between words).
	* '''Vertical alignment''': Vertical alignment of the label text: ''Top'', ''Centered'' or ''Bottom''. If you want to see scrollbar in the text when the text doesn't fit to the visible screen, use the Top vertical alignment.		* '''Vertical alignment''': Vertical alignment of the label text: ''Top'', ''Centered'' or ''Bottom''. If you want to see scrollbar in the text when the text doesn't fit to the visible screen, use the Top vertical alignment.
	* '''Link target''': Defines a link to other dashboard (defined as the target dashboard identifier) or to an external web page. The link is identified as a external web link if it's starting with ''http://'' or ''https://''.
	* '''Background color''': Background color of the label area.		* '''Background color''': Background color of the label area.
	* '''Border color''': Border color of the label area. Note that the border is visible when its width is not zero.		* '''Border color''': Border color of the label area. Note that the border is visible when its width is not zero.
	* '''Border width''': Border width of the label area.		* '''Border width''': Border width of the label area.
	* '''Border corner radius''': Rounding of the border corners.		* '''Border corner radius''': Rounding of the border corners.

			== Link ==
			'''Link target''' defines a link to other dashboard (defined as the target dashboard identifier) or to an external web page. The link is identified as a external web link if it's starting with ''http://'' or ''https://''.

	== Dashboard component actions ==		== Dashboard component actions ==
	* '''Dashboard component actions''': It is possible to have the Label and Link component either set [[Dashboard_Variables\|variable]] values or to run a script and have the script show the return value as a popup dialog or set dashboard variables. The configuration is done as JSON. When an action is configured, the action can be run by clicking the Label and Link component in the Preview mode. Only a single action can be configured. The action types are:		It is possible to have the Label and Link component either set [[Dashboard_Variables\|variable]] values or to run a script and have the script show the return value as a popup dialog or set dashboard variables. The configuration is done as JSON. When an action is configured, the action can be run by clicking the Label and Link component in the Preview mode. Only a single action can be configured. The action types are:
	** '''SetVariable''': Sets the defined dashboard variable values. This action type supports the following field:		* '''SetVariable''': Sets the defined dashboard variable values. This action type supports the following field:
	*** '''parameters''': A JSON object that defines the variables to be set. If the sys:dashboard or sys:dashboardIdentifier is among the variables, the variables are set in the session context, and otherwise in the dashboard context.		** '''parameters''': A JSON object that defines the variables to be set. If the sys:dashboard or sys:dashboardIdentifier is among the variables, the variables are set in the session context, and otherwise in the dashboard context.
	** '''RunScript''': Runs the defined script and shows return value as popup dialog or sets dashboard variables. If the script returns a json object, the key-value pairs in the json object are set as dashboard variables. If the script returns other value than a json object, the return value is shown as a popup message. The same action parameters are supported as in the [[Actions_to_Run_Script_in_Table#Action_settings\|actions to run a script in a table]]. The parameters are passed to the script and are available as variables in the script:		* '''RunScript''': Runs the defined script and shows return value as popup dialog or sets dashboard variables. If the script returns a json object, the key-value pairs in the json object are set as dashboard variables. If the script returns other value than a json object, the return value is shown as a popup message. The same action parameters are supported as in the [[Actions_to_Run_Script_in_Table#Action_settings\|actions to run a script in a table]]. The parameters are passed to the script and are available as variables in the script:
	*** '''variables''': A dictionary of dashboard variables.		** '''variables''': A dictionary of dashboard variables.
	*** '''action''': A dictionary containing settings of the clicked action. This is used to access the action parameters.		** '''action''': A dictionary containing settings of the clicked action. This is used to access the action parameters.
	*** '''chartSettings''': A dictionary containing the dashboard component settings.		** '''chartSettings''': A dictionary containing the dashboard component settings.
	:: Example of a SetVariable action:		:: Example of a SetVariable action:
	:: <syntaxhighlight lang="json" line>		:: <syntaxhighlight lang="json" line>