Skip to main content

Document Layout Editor

Edit the layout of a report document​

Once you've created a report document, you can modify its layout with the Document Layout Editor.

alt text

Open the Document Layout Editor​

To edit the layout of a report document:

  1. In the Report Builder, open the Report documents tab.

  2. Select a report document on the left.

  3. Select View/Edit layout to open the Document Layout Editor.

alt text

Controls​

The layout of a report document is made up of controls. The purpose of each control type is to either display data or act as a container that groups other controls together. They can be stacked vertically or horizontally in a grid-like arrangement.

Controls appear as dashed boxes containing one or two "pill" shapes to represent their Label and Value fields, which are colour-coded to indicate whether their value is dynamic, static, calculated or not set.

Note

The three container controls are: Horizontal stack, Vertical stack and Repeater.

alt text

Add a control​

To add a control to the layout, select at the bottom of the document or within a container control.

Flow documents offer a range of controls for presenting different types of data. To learn more, see Flow controls.

Tabular documents are for recording raw data as a CSV file, so they only support Table controls.

alt text

Reposition a control​

Drag controls to move them around the layout. You can move a control to any position marked by a solid yellow line, in the document or within a container control.

alt text

Edit control properties​

Select a control to show its properties in the top toolbar. These determine the control's size and appearance, and the data it will display whenever the report is run.

All controls have Layout tools for setting the control's relative width and margins.

The next section displays tools unique to that control type. To learn more, see Flow controls.

alt text
Caution

In older reports (or ones created via the API), a property may be labelled as Dynamic. This indicates that its value is set according to a data source. While it's possible to set a new value, it can't be set back easily, so be careful!

Edit control description​

To customise a control's description, select it, and then select in the top toolbar to enter your text.

alt text

If it's a container control, the custom description will also appear in its top-right corner.

alt text

Remove a control​

To remove a control, select it, and then select in the top toolbar.

In the bottom-right corner, select Menu and choose an action:

  • ​ Back to documents - exit the Document Layout Editor without saving.

  • ​ Preview document - see an approximate preview of what the document will look like. Does not include data and controls may render slightly differently whenever the report is run.

  • ​ Edit document - exit the preview.

  • ​ Save layout - save your changes and exit the Document Layout Editor.