QPR ProcessAnalyzer Dashboard Designer: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
No edit summary
Line 3: Line 3:
Dashboards may be 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.
Dashboards may be 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.


== View Settings ==
== Dashboard Properties ==
* Properties
* '''Name''': Name of the dashboard. Maximum length for the name is 100 characters.
** '''Name''': Name of the dashboard. Maximum length for the name is 100 characters.
* '''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 views by using the sys:dashboardIdentifier variable.
** '''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 views by using the sys:dashboardIdentifier variable.
* '''Description''': Additional descriptive text for the dashboard.
** '''Description''': Additional descriptive text for the dashboard.
 
** '''Aspect ratio flex''': Decimal number determining how much the view's aspect ratio (width divided by height) is allowed to vary.
== Dashboard Layout Settings ==
*** View 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.
* '''Aspect ratio flex''': Decimal number determining how much the view's aspect ratio (width divided by height) is allowed to vary.
*** 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, panel's aspect ratio is allowed to vary between 0.5 and 8 (2/4=0.5 and 2*4=8).
** View 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.
*** 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 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, panel's aspect ratio is allowed to vary between 0.5 and 8 (2/4=0.5 and 2*4=8).
*** The aspect ratio flex is useful for charts which don't work properly if the aspect ratio stretches to too extreme.
** 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.
** '''Inner margin''': For dashboards, horizontal/vertical space, in pixels, between the charts in the dashboard.
** The aspect ratio flex is useful for charts which don't work properly if the aspect ratio stretches to too extreme.
** '''Outer margin''': For dashboards, space between the charts and the dashboard outer border, in pixels.
* '''Inner margin''': For dashboards, horizontal/vertical space, in pixels, between the charts in 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.
* '''Outer margin''': For dashboards, space between the charts and the dashboard outer border, in pixels.
** '''SVG background''': The SVG image to use as the background. The SVG image will be rendered on top of the defined background color.
* '''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 Variables]]
 
* == [[Dashboard Variables]] ==


== Dashboard Scaling in Different Screen Sizes==
== Dashboard Scaling in Different Screen Sizes==

Revision as of 20:39, 9 March 2020

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.

Dashboards may be 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.

Dashboard Properties

  • Name: Name of the dashboard. Maximum length for the name is 100 characters.
  • 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 views by using the sys:dashboardIdentifier variable.
  • Description: Additional descriptive text for the dashboard.

Dashboard Layout Settings

  • Aspect ratio flex: Decimal number determining how much the view's aspect ratio (width divided by height) is allowed to vary.
    • View 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.
    • 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, panel's aspect ratio is allowed to vary between 0.5 and 8 (2/4=0.5 and 2*4=8).
    • 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.
    • The aspect ratio flex is useful for charts which don't work properly if the aspect ratio stretches to too extreme.
  • Inner margin: For dashboards, horizontal/vertical space, in pixels, between the charts in the dashboard.
  • Outer margin: For dashboards, space between the charts and the dashboard outer border, in pixels.
  • 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

Views have the following scaling options:

  • In the fixed height mode 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.
  • In the relative height mode, 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 view or panel Aspect Ratio Flex to a high enough number, such as 100.
  • There is also a hybrid mode, where height adjust to some degree to the available space, but there is a certain adjustable limit for panels' 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.