QPR ProcessAnalyzer Dashboard Designer: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 9: Line 9:
** '''Description''': Description of the view/panel/repeater. The description is not visible for the dashboard viewers, but it can be used e.g. to include documentation for the dashboard designer users.
** '''Description''': Description of the view/panel/repeater. The description is not visible for the dashboard viewers, but it can be used e.g. to include documentation for the dashboard designer users.
* Presentation
* Presentation
Common settings for all containers (view, panel, repeater):
** '''Aspect ratio flex''': Decimal number determining how much panel content's aspect ratio (width divided by height) is allowed to vary. Note that this setting doesn't affect the aspect ratio of the panel itself in a view (it's determined in the view designer), but only its contents.
** '''Aspect ratio flex''': Decimal number determining how much panel content's aspect ratio (width divided by height) is allowed to vary. Note that this setting doesn't affect the aspect ratio of the panel itself in a view (it's determined in the view designer), but only its contents.
*** Panel has a '''design aspect ratio''' which is determined by how presentation objects are arranged in the panel designer. Note that the whole available design area doesn't matter - only the actual presentation objects determine the shown area and the design aspect ratio.
*** Panel has a '''design aspect ratio''' which is determined by how presentation objects are arranged in the panel designer. Note that the whole available design area doesn't matter - only the actual presentation objects determine the shown area and the design aspect ratio.

Revision as of 16:20, 25 February 2020

A QPR UI view is the topmost area consisting of panels that have presentation objects inside them. The location and size of the panels within the view can be edited.

View and Panel Settings

  • Properties
    • Version: Version of the view/panel (read-only information). For panels it's also shown, whether the view is linked to the latest version of the panel. For example, if a view is linked to the latest version of a panel, and the current latest version is 1, when a new version of that panel is created, the view uses the version 2.
    • Path: The path of the panel (read-only information). Shown for panels which are added to the view via using the "Latest version using path" option described below.
    • Name: Name of the view/panel/repeater. Note that it's not possible to use tags in view and repeater names. Tags can be used in panel names. View name is visible in workspaces screens and view header. Panel name is visible in panel header (if it's set visible). Maximum length for the name field is 100 characters.
    • Identifier: Identifier of the view/panel. The identifier is a text that must be unique in the folder where the view/panel 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 or to define the default view to be opened when a user logs in. For panel identifiers, the identifier is visible in the Select panel to be added to view dialog for better identification.
    • Description: Description of the view/panel/repeater. The description is not visible for the dashboard viewers, but it can be used e.g. to include documentation for the dashboard designer users.
  • Presentation
    • Aspect ratio flex: Decimal number determining how much panel content's aspect ratio (width divided by height) is allowed to vary. Note that this setting doesn't affect the aspect ratio of the panel itself in a view (it's determined in the view designer), but only its contents.
      • Panel has a design aspect ratio which is determined by how presentation objects are arranged in the panel designer. 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, panel's 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).
      • Panel contents always takes all available space horizontally. If the aspect ratio's lower limit is reached (i.e. panel contents is not allowed use all available space vertically), there may be empty space in the bottom of the panel. If the aspect ratio's higher limit is reached (i.e. panel contents doesn't fit vertically), the panel has a vertical scrollbar.
      • The aspect ratio flex is useful e.g. for presentation objects which don't work properly if the aspect ratio stretches to too extreme.
    • Inner margin: For views, horizontal/vertical space between the panels in the view. For panels, horizontal/vertical space between the presentation objects in the panel. Defined in pixels.
    • Outer margin: For views, space between the panels and the view outer border. For panels, space between the presentation object(s) and the panel border. Defined in pixels.
    • Background color: Background color of the view/panel/repeater. Panels inside the view may have other background colors than the view. 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. For panels, the background color doesn't affect the panel header background, which is always white. Note that presentation objects inside the panel may be transparent or have other background color than the panel.
    • SVG background: The SVG image to use as the panel background. The SVG image will be rendered on top of the defined panel Background color. The SVG image is defined in the same way as with SVG Presentation Objects, except that the SVG image used as the panel background cannot contain actions.
  • Context

View and Panel Scaling in Different Screen Sizes

Views and panels have the following scaling options:

  • In the fixed height mode all panels have fixed height in pixels, and the height of panels doesn't change between different screen sizes. The fixed height mode is switched on by defining view or panel Aspect ratio flex to 1 (more information about Aspect Ratio Flex).
  • In the relative height mode, all panels 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 panels' 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.

View and panel width is always determined by the relative height principle. The views and panels are never scrollable horizontally, but the content always takes the whole available space.

Template:MBDViewAndEditModes