Group Component (DEPRECATED)

Overview

This component has been deprecated and should no longer be used. Column can be used as a direct replacement.

A group is used to define an area of the report that includes other components. It is most useful for elements in a report that should repeat. The number of repeating groups will be controlled by the data provided at time of render. It can also be used to filter data for a section of a report using JSONata queries.

For a detailed explanation of how group data works, see grouping data.

Schema

key	type	required	description
type	string	required	A string defining the component type as a Group.
dataQuery	string	required	A JSONata query that will be used as the data source for this group. If repeating is true, the query must resolve to an array of JSON objects.
repeating	boolean	optional	If true, all components in the Group will repeat for each element in the array returned by dataQuery. Default is true.
pageBreak	boolean	optional	A boolean indicating whether to add a page break after each repeated group. Default is false.
components	Component[]	required	An array of components that will make up the layout of the group. Each component in the array will be rendered n times according to the data returned by the dataQuery.
gridRow	integer	optional	The grid row to place the component. Only applicable when inside a GridV2 component.
gridColumn	integer	optional	The grid column to place the component. Only applicable when inside a GridV2 component.
gridRowSpan	integer	optional	The number of rows to span inside the grid. Only applicable when inside a GridV2 component. Default value is 1.
gridColumnSpan	integer	optional	The number of columns to span inside the grid. Only applicable when inside a GridV2 component. Default value is 1.
rowWidth	float	optional	A fixed width for the component inside the row. Only applicable when inside a RowV2 component.
rowRelativeWidth	float	optional	A proportional width for the component inside the row. Only applicable when inside a RowV2 component.
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.

Example

For examples of Group components, see grouping data.