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_unlocknopaneltrue 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

Insert excerpt

	_Banners
	_Banners
name	screen
nopanel	true

stylenone

This page is for application designers who want to create screens for application users.

Overview

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

Properties

Splitting a Screen.

Insert excerpt

	_property_toolbar
	_property_toolbar
nopanel	true

The toolbar includes the button to

_dashboard_display	_dashboard_display
nopanel	true

.

Insert excerpt
_

parent

property_tabs

_parent

_property_tabs
name basic-h
nopanel true

Live Search
spaceKey @self
additional none
placeholder Search all help pages
type page

Panel

borderColor	#00374F
titleColor	white
titleBGColor	#00374F
borderStyle	solid
title	Sections on this page

Table of ContentsmaxLevel3indent12px

Insert excerpt

	_parent
	_parent
nopanel	true

Basic Settings

Field

Description

Name

The name of the screen.

Open Maximised

Insert excerpt

	_check_box_tick
	_check_box_tick
nopanel	true

to open

the screen pop-up

popup window.

Allow User to Resize

Insert excerpt

	_check_box_tick
	_check_box_tick
nopanel	true

to enable the application user, when running in

Insert excerpt

	_app_mode
	_app_mode
nopanel	true

, to resize the screen.

Insert excerpt

	_check_box_untick
	_check_box_untick
nopanel	true

to keep the screen size fixed when running in in

Insert excerpt

	_app_mode
	_app_mode
nopanel	true

.

This option does not affect resizing the screen in

Insert excerpt

	_design_mode
	_design_mode
nopanel	true

.

Show Toolbar

appapp always designdesign is designdesign

app_mode
nopanel	true

.

Show Window Button Bar

Insert excerpt

	_check_box_tick
	_check_box_tick
nopanel	true

to display a Windows-style bar at the top of the screen. This has a maximise/restore button and a close button.

Image Modified

Insert excerpt

	_check_box_untick
	_check_box_untick
nopanel	true

to have no Windows-style bar at the top of the screen.

Always On Top

Insert excerpt

	_check_box_tick
	_check_box_tick
nopanel	true

to keep the screen on top of other screens. This is useful for a

pop-up

popup window that you want a user to complete before returning to another screen.

Insert excerpt

	_check_box_untick
	_check_box_untick
nopanel	true

to allow other screens to be displayed in front.

Keep Data

Insert excerpt

	_check_box_tick
	_check_box_tick
nopanel	true

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
nopanel	true

is the default. The

screen data Screens

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
nopanel	true

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
nopanel	true

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
nopanel	true

to cache the screen on the application user's client computer when the screen first opens.

Insert excerpt

	_check_box_untick
	_check_box_untick
nopanel	true

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.

Position

For screens that are not set to Open maximised.

pop-up opened floating centrally (default)

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 height 150px of pop-up is 500px

Available when Position is Floating.

Top 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

LeftRightBottom

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.

specify a screen height in pixels, for example `150px` for a small confirmation window. The default size of a popup screen is approximately 500px.
Top	Available when Position is Floating. 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 popup window towards the top left of the screen, set: Top: `60px` Left: `60px`
Left
Right
Bottom

Screen Elements

Screen 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 elements for a specific screen, open the

Insert excerpt

	_property_settings
	_property_settings
nopanel	true

available from the screen toolbar; see Screen Element.

Menu Items

This section has a toolbar with standard buttons and:

Image Modified Show

stream actions (record)click MenuMenu

Startup Actions for details.

To remove a menu, use the toolbar button

Insert excerpt

	_delete
	_delete
nopanel	true

.

Mappings

This section has a toolbar with standard buttons.

Components on the screen, such as buttons or data-components, can have

actions streamitem Streamitem streams (tables) the streamitem recognises _mapping_mappingnopaneltrue

	_mapping
	_mapping
nopanel	true

.

Unreachable Actions

This section has a toolbar with standard buttons. The grid displays a list of actionflows that are linked to components on the screen, 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 (record-actions) that are linked to the screen.

of actions and record-actions that are linked to the screen.

Tip
Actions and record-actions were the way to configure screen functionality before PhixFlow version 9.0.0; see Using Table-Actions and Record-Action

Insert excerpt

	_

accessaccessdescriptiondescription

access
nopanel	true

Insert excerpt

	_audit
	_audit
nopanel	true

Menus and Toolbars

Screen Toolbar

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

List options

Insert excerpt

	_tables
	_tables
nopanel	true

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

Insert excerpt

	_screen_toolbar
	_screen_toolbar
nopanel	true

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

Insert excerpt

	_actionflow
	_actionflow
nopanel	true

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

Insert excerpt

	_palette
	_palette
nopanel	true

Open the list of palettes.

Insert excerpt

	_styles
	_styles
nopanel	true

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

Canvas options

Insert excerpt

	_help
	_help
nopanel	true

Open the help topic with details about working with screens.

Insert excerpt

	_property_settings
	_property_settings
nopanel	true

Open the properties tab for the screen.

Insert excerpt

	_

layout_layout_layout__layout screen to

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

Insert excerpt

	_refresh
	_refresh
nopanel	true

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

Screen

Pop-up pop-up

popup 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
nopanel	true

Options.

Menu option

Description

Insert excerpt

_layout_layout_layout_layout a screen to dashboards dashboards dashboard

screen element.

Insert excerpt

	_area_above
	_area_above
nopanel	true

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

.

To remove a pane, use the popup menu options

Insert excerpt

	_delete
	_delete
nopanel	true

Pane.

Insert excerpt

	_area_right
	_area_right
nopanel	true

Insert excerpt

	_area_below
	_area_below
nopanel	true

Insert excerpt

	_area_

deletedelete Pane.rightrightbelowbelowarea_leftarea_leftarea_lock_widtharea_lock_widthFix the height or width of the selected pane. You will no longer be able to resize a pane by dragging its dividing linearealock_heightarealock_heightdeletedelete

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 panedeleteitemdeleteitem Delete options depend on the selected item. Examples are:delete_itemdelete_itemtrue selected objectsdelete_itemdelete_item pane

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

	_

delete_itemdelete_item form elementdeleteelementdeleteDelete a dashboard elementformnewformnewnopaneltrueCreate a new form in the current areapinunpinpinunpinPin a component to fix its position; see Pinning and UnpinningpalettepaletteOpen the palette to drag in componentsautosizeautosize

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

NoteUsing this option, or manually resizing a component may change the state of the Layout → Style Settings → Auto Size propertyarrangecomponentsarrangecomponentsOptions to arrange within a pane:alignleftalignleftalignrightalignrightaligntopaligntopalign_bottomalign_bottom Insert excerpt_distribute_horizontal_distribute_horizontalnopaneltruedistribute_verticaldistribute_verticalrepositoryfindrepositoryfindOpen the repository with to see the selected component in the list. This can be useful if you want to move a componentscreenpropertiesscreenpropertiesOpen the properties tab for the screen.recordrecordDisplay information about the stream (table) and its (stream items) records.mappingmappingOpens a new mapping element properties tab where you can map attributes with different names to components. Insert excerpt_children_childrennopaneltrueFor the selected parent container, select all the child components

for view <name>

HTML Comment

Unreachable Actions

A workflow can have placeholder actionflows linked to a screen. 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

	_

tablepropertiestablepropertiesor Show the Stream ConfigurationOpen the properties for the stream (table)attributesshowattributesshow...

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_shownopaneltrue for stream (table)<name> Insert excerpt_attributes_show_attributes_shownopaneltrue 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_ticknopaneltrue to open the screen when the application starts

is the default. The screen is opened by a user interacting with the application.

Live Search
spaceKey @self
additional none
placeholder Search all help pages
type page

Panel

borderColor	#00374F
titleColor	white
titleBGColor	#00374F
borderStyle	solid
title	Sections on this page

Table of Contents

maxLevel	3
indent	12px
style	none

Learn More

For links to all pages in this topic, see Designing Screens.

Insert excerpt

	_

checkbox_untickcheckbox_untick is the default. The screen is opened by a user action within the application.

Versions Compared

Old Version 81

New Version Current

Key

Overview

Overview

See Also

Properties

Insert excerpt
_

property_tabs

_property_tabs
name basic-h
nopanel true

Live Search
spaceKey @self
additional none
placeholder Search all help pages
type page

Basic Settings

Dashboard Elements

Screen Elements

Menu Items

Mappings

Unreachable Actions

Actions

Menus and Toolbars

Screen Toolbar

Screen

Popup Menu

Unreachable Actions

Unreachable Actions

Live Search
spaceKey @self
additional none
placeholder Search all help pages
type page

Page Comparison

Versions Compared

Old Version 81

New Version Current

Key

Overview

Overview

See Also

Properties

Insert excerpt_

property_tabs

_property_tabsnamebasic-hnopaneltrue

Live SearchspaceKey@selfadditionalnoneplaceholderSearch all help pagestypepage

Basic Settings

Dashboard Elements

Screen Elements

Menu Items

Mappings

Unreachable Actions

Actions

Menus and Toolbars

Screen Toolbar

Screen

Popup Menu

Unreachable Actions

Unreachable Actions

Live SearchspaceKey@selfadditionalnoneplaceholderSearch all help pagestypepage

Insert excerpt
_

_property_tabs
name basic-h
nopanel true

Live Search
spaceKey @self
additional none
placeholder Search all help pages
type page

Live Search
spaceKey @self
additional none
placeholder Search all help pages
type page