Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
This page is provides the reference information

This page is provides the reference information for dashboard properties.

Overview

Create application screens by starting with a dashboard; see Creating or Opening a Screen.

PhixFlow opens existing screens locked, to prevent accidental editing. To edit a screen, 

Insert excerpt
_layout_unlock
_layout_unlock
nopaneltrue
 it:

  • either using the toolbar 
  • or right-click anywhere in the screen to display the pop-up menu.

This page has the reference documentation for dashboard properties. For information on how to divide a screen into different panes, and how to add things to a screen, see Drag-and-Drop Techniques.

See Also

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

Live Search
spaceKey@self
additionalnone
placeholderSearch all help pages
typepage

Panel
borderColor#00374F
titleColorwhite
titleBGColor#00374F
borderStylesolid
titleSections on this page

Table of Contents
maxLevel3
indent12px
stylenone


Basic Settings

PositionSpecify
FieldDescription
NameThe name of the screen.
Open Maximised

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to open the screen maximised.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to open the screen 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 screen.

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

This option does not affect resizing the screen in 

Insert excerpt
_design_mode
_design_mode
nopaneltrue
.

Show Toolbar
 

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to display a toolbar for the screen todo - currently not working??

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 

Always On Top

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

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

Keep Data

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to allow screen data to be referenced even after the screen 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 screen data is not required once the screen is closed.

Preload

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

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to preload the screen when PhixFlow first starts.  When the user then opens the screen, 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 screen does not need to be preloaded.

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

Cache Locally

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

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

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

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

Open on Startup

Todo - not yet implemented

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. 

application. 

Position

For screens that are not set to Open maximised.

By default, pop-up screens are opened floating centrally. If you want a screen to open with a fixed position, select one of the drop-down options:

  • Pinned to top
  • Pinned to bottom
  • Pinned to left: top left
  • Pinned to right: top right
  • Floating (default)

todo - check DEV-9189 as there are problems using these options

Width

Width

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

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

Top

Available when Position is Floating.Set

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

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

Dashboard Elements

This section lists the Dashboard Elements on this screen.

PhixFlow creates dashboard elements when you use the pop-up menu Add Area... options to divide up the screen. In PhixFlow version 8.3 and earlier, dashboard elements enabled different parts of the screen to be bound to different sources of data, either a stream (table) or view.

Where dashboard elements are bound to data, you can link them, so that the data in one dashboard element drives the data in another; see Linked and Driving Views.

Menu Items

This section has a toolbar with standard buttons and:

  •  Image Modified Show stream actions (record-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 Image Removed Delete Everywhere.

Mappings

This section has a toolbar with standard buttons. The grid contains a list of mappings between attributes that are the same but have different names in different streams (tables) or views. PhixFlow will evaluate
  1. true
  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 Image Added Delete Everywhere.

Mappings

This section has a toolbar with standard buttons

Components on the screen, such as buttons or data-components, can have actions. You may want an action to take data from attributes in different streams (tables) or views. Where the attributes have different names, you must map the dataset, so that the action recognises the data. This grid contains a list of mappings for components on this screen. PhixFlow evaluates all the mapped datasets when it runs an action on the dashboard. Todo - check this is the correct mapping..

You can delete a mapping from the grid.

To configure a mapping, in the screen, right-click 

Unreachable Actions

Todo - New feature related to actionflows?

Actions

This section has a toolbar with standard buttons. The grid displays a list of actions and/or (todo - check) stream item actions (record-actions) that are linked to the screen.

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 tables for your application.

Insert excerpt
_screen_toolbar
_screen_toolbar
nopaneltrue
Open the repository showing the list of available screens 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 screens.
Insert excerpt
_property_settings
_property_settings
nopaneltrue
Open the properties tab for the screen.

Insert excerpt
_layout_unlock
_layout_unlock
nopaneltrue

or 

Insert excerpt
_layout_lock
_layout_lock
nopaneltrue

Unlock a screen to edit its layout.

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

Insert excerpt
_refresh
_refresh
nopaneltrue

Update the screen to reflect changes made elsewhere in PhixFlow, such as the screen 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 screen to edit its layout.
Insert excerpt
_layout_lock
_layout_lock
nopaneltrue
Lock a screen 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 screen 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 screen.
Insert excerpt
_record_show
_record_show
nopaneltrue
Display information about the stream (table) and its (stream items) records.
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 (table).

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
    (table)<name>
  • Insert excerpt
    _attributes_show
    _attributes_show
    nopaneltrue
     
    for view <name>