Skip to content

QRCode Component

Overview

A QR Code component is used to generate and display a QR Code in a report. The data field is required.

Schema

key type required description
type string required A string defining the component type as an QRCode.
data string required The string data to use in generating the QR Code. Any token or JSONata queries in the string will be resolved before the code is generated.
eccLevel string optional The QR Code Error Correction Capability. Must be one of: 'L', 'M', 'Q', or 'H'. Default value is 'M'. See https://www.qrcode.com/en/about/error_correction.html for more information.
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.
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.
debug DebugOptions optional Enables highlighting of this component in the report. Useful for debugging layout issues.
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

An example of a QR Code component:

{
    "type": "QRCode",
    "data": "https://www.jackhenry.com"
}