This page is provides the reference information for dashboard properties.

Todo - decide if this should be renamed to Screen. Link in Phixflow will need to be updated.

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,

Error rendering macro 'excerpt-include' : No link could be created for '_layout_unlock'.

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.

Properties

Property Pane Toolbar

For information about the toolbar options, see the Common Properties page, Toolbars and Controls section.

The toolbar includes the button to Display Screen.

Parent Details

If this item is within or belongs to another, it's parent name is shown here. See the Common Properties page, Parent Details section for more details.

Basic Settings

Field	Description
Name	The name of the screen.
Open Maximised	Tick to open the screen maximised. Untick to open the screen as a pop-up window.
Allow User to Resize	Tick to enable the application user, when running in Application Mode, to resize the screen. Untick to keep the screen size fixed when running in in Application Mode. This option does not affect resizing the screen in Design Mode.
Show Toolbar	Tick to display a toolbar for the screen todo - currently not working?? Untick
Always On Top	Tick 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. Untick to allow other screens to be displayed in front.
Keep Data	Tick 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. Untick 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. Tick 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. Untick 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. Tick to cache the screen on the application user's client computer when the screen first opens. Untick 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. Tick to open the screen when the application starts. Untick is the default. The screen is opened by a user action within the application.
Position	By default, 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	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 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 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:

Show stream actions (record-actions)
Filter

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

click Add New
Select
- either Add a new sub-menu
- or Add a new menu item; see Menu
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 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 all the mapped datasets when it runs an action on the dashboard. Todo - check this is the correct mapping.

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.

Security Tab

Access Permissions

See the Common Properties page, Access Permissions section.

Description

We recommend that you always enter a description to explain the purpose of this item.

Audit Tab

Audit Summary

See the Common Properties page, Audit Summary section.

Menus and Toolbars

Screen Toolbar

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

List options
Table	Open the repository showing the list of available tables for your application.
Screen	Open the repository showing the list of available screens for your application.
Actionflow	Open the repository showing the list of available actionflows for your application.
Palette	Open the list of palettes.
Style	Open the repository showing the list of available styles for your application.
Canvas options
Help	Open the help topic with details about working with screens.
Properties	Open the properties tab for the screen.
Error rendering macro 'excerpt-include' : No link could be created for '_layout_unlock'. or Error rendering macro 'excerpt-include' : No link could be created for '_layout_lock'.	Unlock a screen to edit its layout. Lock a screen to prevent accidental edits and to display the data content.
Refresh	Update the screen to reflect changes made elsewhere in PhixFlow, such as the screen properties, layer orders or shared styles.

Screen Context 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 Screen Options.

Menu option	Description
Error rendering macro 'excerpt-include' : No link could be created for '_layout_unlock'.	Unlock a screen to edit its layout.
Error rendering macro 'excerpt-include' : No link could be created for '_layout_lock'.	Lock a screen to prevent accidental edits and to display the data content.
Show Context Parameters	For dashboards created in PhixFlow versions 8.3 and earlier, open a window listing the context parameters in alphabetical order. todo- check if going away
Show Element Details	For dashboards created in PhixFlow versions 8.3 and earlier, open the properties for the dashboard element.
Add Area Above	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 Delete Pane.
Add Area on Right
Add Area Below
Add Area on Left
Lock Width	Fix the height of the selected pane.
Lock Height	Fix the width of the selected pane.
Delete	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.
Delete	Delete options depend on the selected item. Examples are: Delete selected objects Delete pane Delete form
Delete Element	Delete a dashboard element.
Create New Form	Create a new form in the current area.
Pin/Unpin Selected Objects	Fix the position of selected objects. todo- check ifgoing away
Palette	Open the palette to drag in components.
Turn Auto Size Off/On	Toggle whether or not the currently selected component is automatically auto sized when an application window is resized by the user. Using this option, or manually resizing a component may change the state of the Layout → Style Settings → Auto Size property.
Arrange the selected items	Options to arrange the selected components within a pane: Align Objects to Left Align Objects to Right Align Objects to Top Align to base Error rendering macro 'excerpt-include' : No link could be created for '_distribute_horizontal'. Error rendering macro 'excerpt-include' : No link could be created for '_distribute_vertical'.
Find in Repository change to Show in layers??	Open the repository with to see the selected component in the list. This can be useful if you want to move a component.
Screen Properties	Open the properties tab for the screen.
Show Record Details	Display information about the stream (table) and its (stream items) records. todo - Check this option's name has changed??
Add component mapping	Opens a new Mapping Element properties tab where you can map
Select all children	For the selected parent container, select all the child components too.
Show Attributes for <table name>	Open the list of attributes for the table. This option is available when a screen is backed by a table.
Show Attributes for <view name>	Open the list of attributes for the view. This option is available when a screen is backed by a view.

Dashboard