Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
_Banners
_Banners
namescreen
nopaneltrue

Overview

This page explains the screen properties. For information on how to divide a screen into different panes, and how to add components to it, see Drag-and-Drop Techniques.

Properties

Insert excerpt
_property_toolbar
_property_toolbar
nopaneltrue
 The toolbar includes the button to 
Insert excerpt
_dashboard_display
_dashboard_display
nopaneltrue
.

Insert excerpt
_parent
_parent
nopaneltrue

Basic Settings

FieldDescription
NameThe name of the dashboard.
Open Maximised

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to open the dashboard maximised.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to open the dashboard as a pop-up window.

Allow User to Resize

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to enable the application user, when running in 
Insert excerpt
_app_mode
_app_mode
nopaneltrue
, to resize the dashboard.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to keep the dashboard size fixed when running in in 
Insert excerpt
_app_mode
_app_mode
nopaneltrue
.

This option does not affect resizing the dashboard in 

Insert excerpt
_design_mode
_design_mode
nopaneltrue
.

Show Toolbar
Insert excerpt
_design_mode
_design_mode
nopaneltrue
 always has a toolbar with the dashboard name on the left and toolbar icons on the right. 

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to also display the toolbar in 
Insert excerpt
_app_mode
_app_mode
nopaneltrue
. The dashboard name is displayed. Toolbar icons are not displayed.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 is the default as the toolbar is usually not required in 
Insert excerpt
_app_mode
_app_mode
nopaneltrue
.

Show Window Button Bar

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to display a Windows-style bar at the top of the dashboard. This has a maximise/restore button and a close button.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to have no Windows-style bar at the top of the dashboard.

Always On Top

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to keep the dashboard on top of other dashboards. This is useful for a pop-up window that you want a user to complete before returning to another dashboard.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to allow other dashboards to be displayed in front. 

Keep Data

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to allow dashboard data to be referenced even after the dashboard is closed. This is useful if an application user needs access to global data available in the system.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 is the default. The dashboard data is not required once the dashboard is closed.

Preload

Dashboards, especially complex dashboards, can take some time to open, which can feel slow to the application user. Use this option when you need a dashboard to open quickly. Preloading screens adds to the time it takes PhixFlow to initially start up.  For this reason we recommend you only preload dashboards that an application user will always want to open.

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to preload the dashboard when PhixFlow first starts.  When the user then opens the dashboard, it displays immediately. The data itself may still take time to load.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 is the default. The dashboard does not need to be preloaded.

Preloading relates to the dashboard itself. Any data backing the dashboard is only loaded when the dashboard opens, and this may also take time to load.

Cache Locally

If an application user is likely to require the same dashboard in different stages of a task. Use this option so that, when the user closes and reopens the dashboard, it loads immediately. 

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to cache the dashboard on the application user's client computer when the dashboard first opens.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 is the default. The dashboard does not need to be cached.

Caching relates to the dashboard itself. Any data backing the dashboard will be reload each time the dashboard is opened.

Position

By default, new dashboards are set to Floating. If you want a dashboard to open with a fixed position, select one of the Pinned drop-down options:

  • Pinned to top
  • Pinned to bottom
  • Pinned to left
  • Pinned to right

Use the Pinned options to create a permanently visible dashboard. This is useful for a navigation area or toolbar that you want to be visible for all other dashboards. Floating dashboards do not overlap with pinned dashboards. When the user maximises a Floating dashboard, it expands only to the remaining space. 

Width

For dashboards that are not set to Open maximised, specify a dashboard width in pixels, for example 500px for a small confirmation window. The default size for a pop-up dashboard approximately 800px.
Height

For dashboards that are not set to Open maximised, specify a dashboard height in pixels, for example 150px for a small confirmation window. The default size of a pop-up dashboard is approximately 500px. 

Top

Available when Position is Floating.

For dashboards that are not set to Open maximised, set an offset value in pixels to position the dashboard where it is required. For example, to display a dashboard as a pop-up window towards the top left of the screen, set:

  • Top: 60px
  • Left: 60px
Left
Right
Bottom

Dashboard Elements

Dashboard Elements are specific sections on a screen that posses their own properties, specifically each element can be backed by a different table.

To view a list of the Screen ElementsElement for a specific screen, open the 

Insert excerpt
_property_settings
_property_settings
nopaneltrue
available from the screen toolbar. For more information on Screen ElementsElement and how to use them see: Screen ElementsElement.  

Menu Items

This section has a toolbar with standard buttons and:

  •  Image Modified Show stream-actions
  • Insert excerpt
    _filter
    _filter
    nopaneltrue

The grid contains a list of menu items. To add a menu item to the list, click 

Insert excerpt
_add
_add
nopaneltrue

  1. click 
    Insert excerpt
    _add
    _add
    nopaneltrue
  2. Select 
    • either Add a new sub-menu
    • or Add a new menu item; see Menu
  3. PhixFlow opens a new properties tab for a menu item or sub-menu; see Menu for details.

To remove a menu, use the toolbar button 

Insert excerpt
_delete
_delete
nopaneltrue
.

Mappings

This section has a toolbar with standard buttons

Components on the dashboard, such as buttons or data-components, can have actions or stream-item actions. Stream-item actions can take data from attributes in different streams or views. Where the attributes have different names, you must map the attribute, so that the stream-item action recognises the data. This grid contains a list of mappings for the components on this dashboard. 

To configure a mapping, in the dashboard, right-click a component and select 

Insert excerpt
_mapping
_mapping
nopaneltrue
.

Unreachable Actions

This section has a toolbar with standard buttons. The grid displays a list of actionflows that are linked to components on the dashboard, but do not exist yet.


Tip

Actionflows are a new way to configure actions, introduced in PhixFlow version 9.0.0; see Understanding Actionflows.

Actions

This section has a toolbar with standard buttons. The grid displays a list of actions and stream-item-actions that are linked to the dashboard.


Tip

Actions and stream-item-actions were the way to configure dashboard functionality before PhixFlow version 9.0.0; see Using Stream Table Actions and StreamRecord-item-actionsAction


Insert excerpt
_access
_access
nopaneltrue

Insert excerpt
_description
_description
nopaneltrue

Insert excerpt
_audit
_audit
nopaneltrue

Menus and Toolbars

Screen Toolbar

There is a toolbar above the screen canvas. This provides the following options:

List options

Insert excerpt
_tables
_tables
nopaneltrue

Open the repository showing the list of available streams for your application.

Insert excerpt
_screen_toolbar
_screen_toolbar
nopaneltrue
Open the repository showing the list of available dashboards for your application.
Insert excerpt
_actionflow
_actionflow
nopaneltrue
Open the repository showing the list of available actionflows for your application.
Insert excerpt
_palette
_palette
nopaneltrue
Open the list of palettes.
Insert excerpt
_styles
_styles
nopaneltrue
Open the repository showing the list of available styles for your application.
Canvas options
Insert excerpt
_help
_help
nopaneltrue
Open the help topic with details about working with dashboards.
Insert excerpt
_property_settings
_property_settings
nopaneltrue
Open the properties tab for the dashboard.

Insert excerpt
_layout_unlock
_layout_unlock
nopaneltrue

or 

Insert excerpt
_layout_lock
_layout_lock
nopaneltrue

Unlock a dashboard to edit its layout.

Lock a dashboard to prevent accidental edits and to display the data content.

Insert excerpt
_refresh
_refresh
nopaneltrue

Update the dashboard to reflect changes made elsewhere in PhixFlow, such as the dashboard properties, layer orders or shared styles.

Screen Pop-up Menu

Right-click on a screen to display its pop-up menu. The options available depend on where you click. If there are many options, some are moved onto the sub-menu

Insert excerpt
_screen
_screen
nopaneltrue
 Options.

Menu optionDescription
Insert excerpt
_layout_unlock
_layout_unlock
nopaneltrue
Unlock a dashboard to edit its layout.
Insert excerpt
_layout_lock
_layout_lock
nopaneltrue
Lock a  dashboard to prevent accidental edits and to display the data content.
Insert excerpt
_context_parameters
_context_parameters
nopaneltrue
For dashboards created in PhixFlow versions 8.3 and earlier, open a window listing the context parameters in alphabetical order.
Insert excerpt
_element_show
_element_show
nopaneltrue
For dashboards created in PhixFlow versions 8.3 and earlier, open the properties for the dashboard element.
Insert excerpt
_area_above
_area_above
nopaneltrue

Use these options to divide a dashboard into multiple, resizable panes. Select the option to add a pane relative to the currently selected pane.

To remove a pane, use the pop-up menu options 

Insert excerpt
_delete
_delete
nopaneltrue
 Pane.

Insert excerpt
_area_right
_area_right
nopaneltrue
Insert excerpt
_area_below
_area_below
nopaneltrue
Insert excerpt
_area_left
_area_left
nopaneltrue
Insert excerpt
_area_lock_width
_area_lock_width
nopaneltrue
Fix the height or width of the selected pane. You will no longer be able to resize a pane by dragging its dividing line.
Insert excerpt
_area_lock_height
_area_lock_height
nopaneltrue
Insert excerpt
_delete
_delete
nopaneltrue

When a specific component is selected, delete the component.

Other delete options that may be available relate to specific types of component in the selected pane.

Insert excerpt
_delete_item
_delete_item
nopaneltrue
 

Delete options depend on the selected item. Examples are:

  • Insert excerpt
    _delete_item
    _delete_item
    nopaneltrue
     selected objects
  • Insert excerpt
    _delete_item
    _delete_item
    nopaneltrue
     pane
  • Insert excerpt
    _delete_item
    _delete_item
    nopaneltrue
     form 
Insert excerpt
_element_delete
_element_delete
nopaneltrue
Delete a dashboard element.
Insert excerpt
_form_new
_form_new
nopaneltrue
Create a new form in the current area.
Insert excerpt
_pin_unpin
_pin_unpin
nopaneltrue

Pin a component to fix its position; see Pinning and Unpinning.

Insert excerpt
_palette
_palette
nopaneltrue

Open the palette to drag in components.
Insert excerpt
_autosize
_autosize
nopaneltrue

Toggle whether or not the currently selected component is automatically auto sized when an application window is resized by the user.

Note

Using this option, or manually resizing a component may change the state of the Layout → Style Settings → Auto Size property.


Insert excerpt
_arrange_components
_arrange_components
nopaneltrue

Options to arrange the selected components within a pane:

Insert excerpt
_align_left
_align_left
nopaneltrue

Insert excerpt
_align_right
_align_right
nopaneltrue

Insert excerpt
_align_top
_align_top
nopaneltrue

Insert excerpt
_align_bottom
_align_bottom
nopaneltrue

Insert excerpt
_distribute_horizontal
_distribute_horizontal
nopaneltrue

Insert excerpt
_distribute_vertical
_distribute_vertical
nopaneltrue


Insert excerpt
_repository_find
_repository_find
nopaneltrue

Open the repository with to see the selected component in the list. This can be useful if you want to move a component.
Insert excerpt
_screen_properties
_screen_properties
nopaneltrue
Open the properties tab for the dashboard.
Insert excerpt
_record_show
_record_show
nopaneltrue

Display information about the stream and its stream-items.

Insert excerpt
_mapping
_mapping
nopaneltrue
Opens a new mapping element properties tab where you can map attributes with different names to components.
Insert excerpt
_children
_children
nopaneltrue
For the selected parent container, select all the child components.
Insert excerpt
_table_properties
_table_properties
nopaneltrue

or Show the Stream Configuration
Open the properties for the stream.

Insert excerpt
_attributes_show
_attributes_show
nopaneltrue
...

Show the list of attributes that are bound to the component. The attributes can be from a stream or view. This is shown in the option:

  • Insert excerpt
    _attributes_show
    _attributes_show
    nopaneltrue
     
    for stream
     <name>
  • Insert excerpt
    _attributes_show
    _attributes_show
    nopaneltrue
     
    for view <name>


HTML Comment

Unreachable Actions

A workflow can have placeholder actionflows linked to a dashboard. If the actionflow has not been wired then it is listed here.

Open on Startup

You may have a screen that acts as your application's welcome window. Use this option to open a screen whenever the application starts.

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to open the screen when the application starts.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 is the default. The screen is opened by a user action within the application.