Layout templates allow you to configure layout components, which can be added to forms. It is often useful to build a Palette, which is a list of pre-configured layout templates, which allow you to build forms quickly using layout components which adhere to your chosen style.
The toolbar has the standard icons. For information about the sections Parent Details, Analysis Models, Description and Audit Summary, see Common Properties. For information about other property tabs, see Property Tabs.
Each layout object has the following settings:
Field | Description |
---|---|
Name | The name of the layout object. |
Display Name | This field is only available if the layout component is a stream view component or a card container. Specify a display name, which will be displayed as the heading for this component on the form. If no display name is set, The form displays the layout name. |
Cache Data | This field is only available if the layout component is a drop-down list. If ticked, the field will cache its data after the first load. |
Action | This field is only available if the layout component is a button. Specify the action to run when a user clicks the button. |
Snap Grid Size | This field is available for the following types of layout component:
Specify the grid size to use when components are snapped to the grid. |
Composite Component | Specify whether this object is part of a composite component. |
Stream Name | This field is available for the following types of layout component:
The stream that backs the layout component. |
Stream View Name | This field is only available if the layout component is a form or a card container. The name of the stream view that backs this card container or form. This can be used in order to have aggregated data in the background filter of the card container or form. |
Refresh If Not Active | This field is only available if the layout component is a stream view component or a card container. If ticked, the element will refresh even if the parent dashboard is not active (e.g. after the driving selection changes). Otherwise it will refresh as soon as it becomes active. |
Show Paging Bar | This field is only available if the layout component is a card container. If ticked, the paging bar is shown by default. |
Display Text | This field is only available if the layout component is a static text field. Enter the text you want to display on the layout component. By default the Display Text field is an expression editor. For options to format the display text as HTML, tick Use HTML Formatting. |
Use HTML Formatting | This field is only available if the layout component is a static text field. Tick to change the Display Text field from an expression editor to an HTML editor. You can then use the toolbar to apply HTML formatting to the text. |
Default Value | This field is available for the following types of layout component:
If the Dashboard that this layout component is on is opened by an action, and there are no context parameters or form mappings to populate this field, populate the field with this value. |
Date/Time Format | This field is available for the following types of layout component:
Specify the format in which to display the date or date time value. |
Number Format | This field is available for the following types of layout component:
Specify the format in which to display the number value. |
Data Type | This field is available for Dynamic Text and Drop-down Fields. The Data Type determines how the selected data will be formatted. For example if it is an Integer or Float it can have a number format, and if it is a date or date time then it can have a date-time format. |
Decimal Places | This field is only available if the layout component is dynamic text. The number of decimal places to display for numbers. |
URL | This field is only available if the layout component is a URL display. Specify the URL that you want to be displayed. |
Expression | This field is only available if the layout component is a URL display. Enter an expression which, if true, the URL will be calculated as an expression. |
Place Holder Text | This field is available for the following types of layout component:
Enter place holder text that PhixFlow will display when the input field is empty. The text is shown slightly greyed out to distinguish it from text that is entered by the user, or read-only text. |
Style Elements
A list of style elements. For details of creating style elements, see Styles and CSS Properties.
Areas, Forms and Card Containers have additional style settings which allow components inside this area to be resized and repositioned when a user resizes the dashboard:
Field | Description |
---|---|
Auto Size | If ticked this component will resize to fill the available space in the direction set on the parent. If the user resizes the dashboard the components will resize. If multiple components have auto size selected, the available space will be shared between auto sized components. Note that manually resizing the component will turn auto size off. |
Grow Factor | The number representing how much a component can resize. When you have several components, PhixFlow uses the difference in their numbers to allocate space. For example, if you have 3 components (A, B and C) with their grow factor set to:
|
Direction | If a direction is selected, components inside this container will be distributed in the selected direction.
|
Wrap | This field is only visible if a direction is selected. Wrap affects how the components wrap when there is less space available.
|
Justify | This field is only visible if a direction is selected. Justify affects the position of the components in the direction set (horizontal for row, vertical for column).
|
Align | This field is only visible if a direction is selected. Align affects the position of the components perpendicular to the direction set (vertical for row, horizontal for column).
|
Read only | If ticked this component will be marked as read only. For input fields this means that the data in them will not be editable and for buttons it will make the button unusable. If the component is a form or an area, marking it as read only will mark ALL input fields in that area / form as read only, but buttons will NOT be automatically marked as read only |
CSS Properties
A list of CSS properties. Click Add to add a new CSS style; see Styles and CSS Properties.
Shared Styles
A list of shared styles. Click Show the List of Styles to see the styles available in the repository. You can drag styles from the repository into the grid to add a shared style to this component.
Formatting Rules
A list of rules about when to apply formatting. Click Add to add a new rule; see Formatting Rule.
Position Settings
Field | Description |
---|---|
Order | |
Tab Index | |
Width | The width of the component. |
Height | The height of the component. |
Top | The top of the component. |
Left | The left of the component. |
Right | The right of the component. |
Bottom | The bottom of the component. |
Prevent Dragging | If ticked, will prevent the component from being dragged or resized using the mouse when a dashboard is in edit mode. This is useful to prevent accidental movement of components that should be in a fixed position on the page such as headers and footers. |
Advanced
Field | Description |
---|---|
Type | The type of layout component. |
View Type | The type of view this layout component can be used on. |
Menu Icon Source | The icon displayed in menus for this component. |
Template | Whether this is a template component. |
Description
Field | Description |
---|---|
Tooltip | Enter tooltip text. When using the application, if the user hovers their mouse over this component PhixFlow displays this text. If this text is in the translation table, PhixFlow can display translated text that matches the user's locale; see Translating an Application Interface. |
Description | A free format description of the component. |
Background Filter Rules
For stream view components and card containers there is a section related to background filters and their attributes.
Field | Description |
---|---|
Evaluate These Filter Rules as an Or | Ticking this field means that the background filter rules will be combined as an "or" filter as opposed to an "and" filter. |
Background Filter Rules | A grid of background filter rules which are combined together (usually as an and conjunction) to create the background filter for the layout component. |
Background filter rule attributes | |
Rule Expression | The Expression for this Filter rule, if it evaluates to true then the filter associated with this filter rule will be used. |
Filter | The Filter that will be used should the Rule Expression evaluate to true. |
Order | The order in which the filter rules for this dashboard element will be evaluated. |
Enabled | If not true, this filter will not be used. |
Stop If True | If true and the Rule Expression evaluates to true then any subsequent filter rules will not evaluated. |
Description | A Description of the filter rule. |