QPR ProcessAnalyzer Dashboard Designer: Difference between revisions

Latest revision as of 12:23, 9 August 2023

The dashboard designer is for viewing and editing dashboards, depending on the mode that is in use. Preview mode is for viewing the dashboard, Edit mode is for editing chart and other component settings, and Add component mode is for adding, removing, resizing and moving charts.

Viewing and Editing Dashboards

Dashboards can be viewed in the following modes:

Preview: When opening a dashboard, the Preview mode is in use. It's for viewing the dashboard without ability to change the dashboard settings. Chart settings can be changed while viewing to make temporary changes, i.e. they are not saved to the dashboard. There is no confirmation message related to the changes when going to another dashboard, so the changes are lost when opening another dashboard.
Edit: Edit mode is for making savable changes to the dashboard. The changes are saved by pressing the Save button. When exiting the Edit mode without saving changes, there is a notification about the changes that might be lost.
Add component: The Add component mode can be activated from the Edit mode. It's for adding, removing, moving, resizing, and duplicating charts. In addition, the stacking order of components can be changed. New charts are added from the tool palette. The selected chart can be removed and duplicated using the icon buttons on the top right of the chart, and the stacking order can be changed using the Bring to front, Bring forward, Send to back and Send backward buttons. Charts can be moved by selecting the chart and dragging it with the mouse. Charts can be resized by dragging the chart from the circular resize handles in the corners of the chart.

The Edit mode can be activated by clicking the Edit button in the Preview mode. Note that editing is not available, if the user doesn't have permissions to edit the dashboard. The Add component mode can be activated by clicking the Plus button in the Edit mode. It's possible to go back to the Edit mode from the Add component mode by clicking the Done button.

When there are changes made in the Preview mode and the Edit mode is activated, the changes are preserved allowing to save them in the the Edit mode. When going back to the Preview mode from the Edit mode, changes either need to be saved or discarded.

Dashboard General Settings

Name: Short name for the dashboard that doesn't need to be unique. Dashboard name cannot be empty, maximum length is 440 characters, and the name cannot contain the slash (/) character.
Identifier: Dashboard identifier that must be unique in the project where the dashboard is located. Identifiers are used to link dashboards by using the sys:dashboardIdentifier variable. Identifiers are case sensitive, the maximum length is 440 characters and they must not contain "/" characters. Dashboard identifier is an optional field.
Description: Optional descriptive text for the dashboard.

Dashboard Layout Settings

Chart margin: Horizontal and vertical space around charts in the dashboard. Defined in pixels.
Dashboard margin: Horizontal and vertical space in the outer borders of the dashboard. Defined in pixels.
Background color: Background color of the dashboard. It's possible to set transparent background by setting the alpha value (A) to 0.
Aspect ratio flex: Decimal number determining how much the dashboard's aspect ratio (width divided by height) is allowed to vary when trying to fit the dashboard to the available screen space. Minimum allowed value is 1. See more information below.

Dashboard Variables

Variables are for storing session time information and interacting between charts on other components. See the main article about the dashboard variables.

Dashboard Size Scaling

Dashboards have the following scaling options based on how the aspect ratio flex setting:

Fixed height (default): all charts have fixed height in pixels, and the height of charts doesn't change between different screen sizes. The fixed height mode is switched on by defining dashboard Aspect ratio flex to 1.
Relative height: all height adjust to the available screen height in a way that the content always takes the entire screen height so the screen is never scrollable nor there is empty space in the bottom of the screen. The relative height mode is switched on by defining dashboards Aspect Ratio Flex to a high enough number, such as 100.
Balanced: height adjusts to some degree to the available space, but there is a certain adjustable limit for dashboards' height. The hybrid mode is used when the Aspect ratio flex is set to greater than 1 but not too big number. For example 1.2 - 2.0 might be suitable. This aspect ratio flex setting is useful for charts which don't work properly if the aspect ratio stretches to too extreme.

The aspect ratio is calculated as follows:

Dashboard has a design aspect ratio which is determined by how charts are arranged during designing.
Aspect ratio calculation rule: If design aspect ratio is A and aspect ratio flex is B, the aspect ratio is allowed to change between A/B and A*B. Example: If design aspect ratio is 2 and aspect ratio flex is 4, the dashboard's aspect ratio is allowed to vary between 0.5 and 8 (2/4=0.5 and 2*4=8).
If the aspect ratio's lower limit is reached (i.e. contents is not allowed use all available space vertically), there may be empty space in the bottom. If the aspect ratio's higher limit is reached (i.e. contents doesn't fit vertically), there is a vertical scrollbar.

@@ Line 1: / Line 1: @@
-The dashboard designer is for designing and implementing dashboards by adding components from the tool palette, adjusting their sizes and positions and making settings for each component.
+The dashboard designer is for viewing and editing dashboards, depending on the mode that is in use. ''Preview mode'' is for viewing the dashboard, ''Edit mode'' is for editing chart and other component settings, and ''Add component mode'' is for adding, removing, resizing and moving charts.
-Dashboards can be seen in '''viewing mode''' and '''editor mode'''. When in editor mode, charts can only be moved and resized. Interacting with the charts (e.g. clicking buttons) is possible when the viewing mode is used.
+== Viewing and Editing Dashboards ==
+Dashboards can be viewed in the following modes:
+* '''Preview''': When opening a dashboard, the ''Preview mode'' is in use. It's for viewing the dashboard without ability to change the dashboard settings. Chart settings can be changed while viewing to make temporary changes, i.e. they are not saved to the dashboard. There is no confirmation message related to the changes when going to another dashboard, so the changes are lost when opening another dashboard.
+* '''Edit''': ''Edit mode'' is for making savable changes to the dashboard. The changes are saved by pressing the '''Save''' button. When exiting the Edit mode without saving changes, there is a notification about the changes that might be lost.
+* '''Add component''': The ''Add component mode'' can be activated from the ''Edit mode''. It's for adding, removing, moving, resizing, and duplicating charts. In addition, the stacking order of components can be changed. New charts are added from the tool palette. The selected chart can be removed and duplicated using the icon buttons on the top right of the chart, and the stacking order can be changed using the '''Bring to front''', '''Bring forward''', '''Send to back''' and '''Send backward''' buttons. Charts can be moved by selecting the chart and dragging it with the mouse. Charts can be resized by dragging the chart from the circular resize handles in the corners of the chart.
+The ''Edit mode'' can be activated by clicking the '''Edit''' button in the ''Preview mode''. Note that editing is not available, if the user doesn't have permissions to edit the dashboard. The ''Add component'' mode can be activated by clicking the '''Plus''' button in the ''Edit mode''. It's possible to go back to the ''Edit mode'' from the ''Add component'' mode by clicking the '''Done''' button.
+When there are changes made in the ''Preview mode'' and the ''Edit mode'' is activated, the changes are preserved allowing to save them in the the ''Edit mode''. When going back to the ''Preview mode'' from the ''Edit mode'', changes either need to be saved or discarded.
 == Dashboard General Settings ==
-* '''Name''': Name of the dashboard. Maximum length for the name is 100 characters.
+* '''Name''': Short name for the dashboard that doesn't need to be unique. Dashboard name cannot be empty, maximum length is 440 characters, and the name cannot contain the slash (/) character.
-* '''Identifier''': Identifier of the dashboard. The identifier is a text that must be unique in the folder where the dashboard is located. Identifiers are case sensitive, they must not contain "/" characters, and the maximum length is 2048 characters. Identifiers are used to open dashboards by using the sys:dashboardIdentifier variable.
+* '''Identifier''': Dashboard identifier that must be unique in the project where the dashboard is located. Identifiers are used to link dashboards by using the [[Dashboard_Variables#System_Variables|sys:dashboardIdentifier]] variable. Identifiers are case sensitive, the maximum length is 440 characters and they must not contain "/" characters. Dashboard identifier is an optional field.
-* '''Description''': Additional descriptive text for the dashboard.
+* '''Description''': Optional descriptive text for the dashboard.
 == Dashboard Layout Settings ==
-* '''Aspect ratio flex''': Decimal number determining how much the dashboard's aspect ratio (width divided by height) is allowed to vary.
+* '''Chart margin''': Horizontal and vertical space around charts in the dashboard. Defined in pixels.
-** Dashboard has a '''design aspect ratio''' which is determined by how presentation objects are arranged during the designing. Note that the whole available design area doesn't matter - only the actual presentation objects determine the shown area and the design aspect ratio.
+* '''Dashboard margin''': Horizontal and vertical space in the outer borders of the dashboard. Defined in pixels.
-** Aspect ratio calculation rule: If design aspect ratio is '''A''' and aspect ratio flex is '''B''', the aspect ratio is allowed to change between '''A/B''' and '''A*B'''. Example: If design aspect ratio is 2 and aspect ratio flex is 4, the dashboard's aspect ratio is allowed to vary between 0.5 and 8 (2/4=0.5 and 2*4=8).
+* '''Background color''': Background color of the dashboard. It's possible to set transparent background by setting the alpha value (A) to 0.
-** Contents always takes all available space horizontally. If the aspect ratio's lower limit is reached (i.e. contents is not allowed use all available space vertically), there may be empty space in the bottom. If the aspect ratio's higher limit is reached (i.e. contents doesn't fit vertically), there is a vertical scrollbar.
+* '''Aspect ratio flex''': Decimal number determining how much the dashboard's aspect ratio (width divided by height) is allowed to vary when trying to fit the dashboard to the available screen space. Minimum allowed value is 1. See more information [[#Dashboard Scaling to Adjust Screen|below]].
-** The aspect ratio flex is useful for charts which don't work properly if the aspect ratio stretches to too extreme.
-* '''Chart margin''': Horizontal and vertical space, in pixels, around charts in the dashboard.
-* '''Dashboard margin''': Horizontal and vertical space, in pixels, in the outer borders of the dashboard.
-* '''Background color''': Background color of the dashboard. It's possible to set transparent background by setting the value of the alpha channel in the rgba to 0 either by inputting the value or by using the rightmost slider.
-== Dashboard Scaling in Different Screen Sizes==
-Dashboards have the following scaling options based on how the aspect ratio flex value has been set:
-* '''Fixed height''': all charts have fixed height in pixels, and the height of charts doesn't change between different screen sizes. The fixed height mode is switched on by defining dashboard Aspect ratio flex to 1.
-* '''Relative height''': all height adjust to the available screen height in a way that the content always takes the entire screen height so the screen is never scrollable nor there is empty space in the bottom of the screen. The relative height mode is switched on by defining dashboards Aspect Ratio Flex to a high enough number, such as 100.
-* '''Balanced''': height adjusts to some degree to the available space, but there is a certain adjustable limit for dashboards' height. The hybrid mode is used when the Aspect ratio flex is set to greater than 1 but not too big number. For example 1.2 - 2.0 might be suitable.
 == [[Dashboard Variables]] ==
+Variables are for storing session time information and interacting between charts on other components. See the main article about the [[Dashboard Variables|dashboard variables]].
-== [[Datasets_in_QPR_ProcessAnalyzer|Datasets]] ==
+== Dashboard Size Scaling ==
+Dashboards have the following scaling options based on how the '''aspect ratio flex''' setting:
+* '''Fixed height''' (default): all charts have fixed height in pixels, and the height of charts doesn't change between different screen sizes. The fixed height mode is switched on by defining dashboard Aspect ratio flex to 1.
+* '''Relative height''': all height adjust to the available screen height in a way that the content always takes the entire screen height so the screen is never scrollable nor there is empty space in the bottom of the screen. The relative height mode is switched on by defining dashboards Aspect Ratio Flex to a high enough number, such as 100.
+* '''Balanced''': height adjusts to some degree to the available space, but there is a certain adjustable limit for dashboards' height. The hybrid mode is used when the Aspect ratio flex is set to greater than 1 but not too big number. For example 1.2 - 2.0 might be suitable. This aspect ratio flex setting is useful for charts which don't work properly if the aspect ratio stretches to too extreme.
-[[Category: QPR ProcessAnalyzer]]
+The aspect ratio is calculated as follows:
+* Dashboard has a '''design aspect ratio''' which is determined by how charts are arranged during designing.
+* Aspect ratio calculation rule: If design aspect ratio is '''A''' and aspect ratio flex is '''B''', the aspect ratio is allowed to change between '''A/B''' and '''A*B'''. Example: If design aspect ratio is 2 and aspect ratio flex is 4, the dashboard's aspect ratio is allowed to vary between 0.5 and 8 (2/4=0.5 and 2*4=8).
+* If the aspect ratio's lower limit is reached (i.e. contents is not allowed use all available space vertically), there may be empty space in the bottom. If the aspect ratio's higher limit is reached (i.e. contents doesn't fit vertically), there is a vertical scrollbar.