PhixFlow Help

Layout

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.

Each layout object has the following settings:

FieldDescription
NameThe name of the layout object.
Display Name

This only appears for

  • Stream View Component
  • Card Container

If set this name will be used as the heading for this component on the form. If it is not set the name will be used.

Cache Data

This only appears for

  • Drop Down Field

If ticked, the field will cache its data after the first load.

Action

This only appears for

  • Button

The action that is run when the button is pressed

Snap Grid Size

This only appears for

  • Form
  • Area
  • Tab Header
  • Tab Display Area
  • Labeled Number Field
  • Labeled Date Field
  • Labeled Date Time Field
  • Labeled Drop Down Field
  • Labeled True/False Field

The sizing of the grid used for snapping components to

Composite Component

Tick to indicate this component is grouped with its parent component.

It can be useful to group components together, such as a dynamic text field and the static text field that acts as its label. To do this,

  1. Create a component to act as the container, for example an area.
  2. Add the components you want to treat as a single component.
  3. Tick this option for each of the components within the container.

PhixFlow then treats the container and the components it contains, as a single, composite component. In a dashboard, when you select or drag a component, such as a text field, PhixFlow selects or moves the whole composite component. 

To select a component that is part of a composite component:

  1. Click once to select the composite component.
  2. Click again to select the specific component.
Stream Name

This only appears for

  • Form
  • Area
  • Card Container
  • Labeled Number Field
  • Labeled Date Field
  • Labeled Date Time Field
  • Labeled Drop Down Field
  • Labeled True/False Field

The stream that backs this form

Stream View Name

This only appears for

  • Card Container
  • Form

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 only appears for

  • Card Container
  • Stream View Component

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.

Display Text

This only appears for:

  • Static Text

The text to display

Default Value

This only appears for

  • True/False Field
  • Date Field
  • Date Time Field
  • Number Field
  • String Field

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 only appears for:

  • Date Field
  • Date Time Field

The Format to display the date or date time value in.

Decimal Places

This only appears for:

  • Dynamic Text

The number of decimal places to display for numbers.

URL

This only appears for:

  • URL Display

The URL to display.

Position Settings
WidthThe width of the component
HeightThe height of the component
TopThe top of the component
LeftThe left of the component
RightThe right of the component
BottomThe bottom of the component
Prevent DraggingIf 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.
Style Elements

A list of style elements. For details of creating style elements, see Style.

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:

Auto SizeIf 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.
Direction

If a direction is selected, components inside this container will be distributed in the selected direction.

  • Row - Components will be distributed as a single row. The components will shrink to fit if the window is made smaller than the width of the components.
  • Row Wrap - Components will be distributed in rows, wrapping on to multiple rows if the components fill the row.
  • Column - Components will be distributed as a single column. If the window height is made smaller only components with Auto Size ticked will be resized.
  • Column Wrap - Components will be distributed as columns and will wrap onto a new column as necessary.
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). 

  • Flex Start - Components will be positioned from the start edge of the container, with no spacing between them.
  • Flex End - Components will be positioned so the last component aligns with the end edge of the container, with no spacing between them.
  • Center - Components will be centred in the direction set, with no spacing between them, and equal spacing between the edge of the container and the first and last component.
  • Space Around - Distribute components with even spacing around each component.
  • Space Between - Distribute components with even spacing between each component, but no spacing between the component and the container.
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).

  • Flex Start - Components will be positioned from the start edge of the container, with no spacing between them.
  • Flex End - Components will be positioned so the last component aligns with the end edge of the container, with no spacing between them.
  • Center - Components will be centred, with no spacing between them, and equal spacing between the edge of the container and the first and last component.
  • Baseline - Position components so their baselines align.
  • Stretch - Components with no size set in this direction will have their size increased to fill the container in this direction.
  • Space Around - Distribute components with even spacing around each component.
Read onlyIf 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

Shared Styles

A list of shared styles. Press Show the List of Styles to bring up the list of styles, and drag styles into this list to add to the shared styles for this component.

Advanced
TypeThe type of layout component.
View TypeThe type of view this layout component can be used on.
Menu Icon SourceThe icon displayed in menus for this component.
TemplateWhether this is a template component
Description
TooltipThe description that will appear at the tool tip for this component
DescriptionA free format description of the component
Background Filter Rules (only for stream view components and card containers)
Evaluate These Filter Rules as an OrTicking this field means that the background filter rules will be combined as an "or" filter as opposed to an "and" filter
Background Filter RulesA 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 Rules have the Following 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
FilterThe Filter that will be used should the Rule Expression evaluate to true
OrderThe order in which the filter rules for this dashboard element will be evaluated
EnabledIf not true, this filter will not be used
Stop If TrueIf true and the Rule Expression evaluates to true then any subsequent filter rules will not evaluated
DescriptionA Description of the filter rule

Form icons

The form for each layout object provides the standard form icons.

See Also

Forms

Please let us know if we could improve this page feedback@phixflow.com