Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

FieldDescription
NameThe name of the layout object
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 ComponentWhether this object is to be used as part of a composite component
Stream Name

This only appears for

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

The stream that backs this form

Display Text

This only appears for:

  • Static Text

The text to display

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.

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

...