SubReport
Use the SubReport layout element to generate nested reports.
Refer to SubReport layout element for a GitHub example.
To add a SubReport, right-click anywhere in a report's details and select Add Sub Report from the context menu.
Figure 1. Select Add Sub Report from context menu to add a SubReport.
A SubReport layout element adds the new layout element with a header, footer, and detail. Data from the nested JSON array goes in the newly added SubReport layout element's Detail section.
Figure 2. An example illustrating a SubReport layout element.
When a SubReport is deselected, only the wireframe is visible.
Properties
Property | Value | Description |
---|---|---|
detailHeight | numeric | A value indicating the height of the SubReport detail. |
headerHeight | numeric | A value indicating the height of the SubReport header. |
footerHeight | numeric | A value indicating the height of the SubReport footer. |
id | text | A value indicating the programmatic identifier of the SubReport. |
columnLayout | A value indicating how the data in the columns will be laid out. | |
columnSpacing | numeric | A value indicating the amount of space between columns. |
columns | numeric | A value indicating the number of columns the SubReport will have. |
dataName | text | The name of the data that the sub report will be based on. If the data is a single object (or record), the detail section will only be displayed once. If it is a list or collection, the detail section will be displayed once for each object in the list. |
height | numeric | A value indicating the height of the SubReport. |
rowSpacing | numeric | A value indicating the amount of space between consecutive rows in the SubReport. |
width | numeric | A value indicating the width of the SubReport. |
x | numeric | A value indicating the X coordinate of the SubReport. |
y | numeric | A value indicating the Y coordinate of the SubReport. |
SubReport Sections
A SubReport, like a Report, consists of a Header, Footer, and Detail section. Each section has it's own properties which are summarized below.
Figure 3. A SubReport layout element's sections.
Header
Property | Value | Description |
---|---|---|
id | text | A value indicating the programmatic identifier of the SubReport header. |
height | numeric | A value indicating the height of the SubReport header. |
Detail
Property | Value | Description |
---|---|---|
id | text | A value indicating the programmatic identifier of the SubReport detail. |
height | numeric | value indicating the height of the SubReport detail. |
autoSplit | true |
false |
Footer
Property | Value | Description |
---|---|---|
id | text | A value indicating the programmatic identifier of the SubReport footer. |
height | numeric | A value indicating the height of the SubReport footer. |