Skip to content

Row Component (DEPRECATED)

Overview

DEPRECATED. Please use RowV2 for all new reports.

A row can be used to layout other components horizontally across a page. A single Row will take up the entire width of a page, but will not expand to a new row. If there is not enough space to render the Row component across the page, a layout exception will occur.

Schemas

Row

key type required description
type string required A string defining the component type as a Row.
spacing number optional The horizontal spacing between all components in the row. Default is 0.
components RowComponent[] required An array of components that will make up the layout of the row.
sectionName string optional Marks the component, its contents, and any sub-components as a named section in the report. A section can span multiple pages. The first, last and page count of a section can be inserted into the report using tokens: e.g. $(SECTION_BEGIN_[section-name]), $(SECTION_END_[section-name]) and $(SECTION_COUNT_[section-name]).
sectionLink string optional If defined, the entire component will become a link to a named section in the report. The link will redirect the user to the beginning of the named section in the report.
debug DebugOptions optional Enables highlighting of this component in the report. Useful for debugging layout issues.
style string or Style optional Either a style identifier or a style object used to define the layout/styling options for the component. Any textOptions in the style are ignored for this component. For a more detailed explanation of the style system, see Styles.
condition Conditional optional The component will not be rendered in the report if a condition is present and it evaluates to false. For more information on conditions, see Conditionals.

RowComponent

key type required description
width number optional A fixed width for the component inside the row. Not allowed if relativeWidth is present.
relativeWidth number optional A relative width for the component inside the row. Not allowed if width is present.
component Component required The component that will be added to the row.

Example

Row example:

{
    "type": "Row",
    "components": [
        {
            "relativeWidth": 2,
            "component": {
                "type": "Text",
                "text": "Sales Report"
            }
        },
        {
            "component": {
                "type": "Text",
                "text": "Created: 08/22/2022",
            }
        },
        {
            "component": {
                "type": "Text",
                "text": "Author: Aaron Watson",
            }
        }
    ]
}

The component defined above renders as in the following image: !Row Example