Get [Object] [Property]
The Get [Object] [Property] block retrieves specific properties of an object, such as object configuration, layout settings or display options. It allows users to select an object and fetch various attributes related to its configuration, appearance and structure. Outputs string, number or boolean depending on which property is selected
Configuration
Inputs | Description |
Object | Select a sheet from the workbook or use a block that outputs a sheet name as a string. |
Property | See section below. |
Properties
Property | Description |
Frame | Refer to the Frame Properties section below for detailed information. |
Margin | Retrieves the margin of the objects container (Top, Right, Bottom, or Left). The value is returned in pixels. |
Padding | Retrieves the padding of the objects container (Top, Right, Bottom, or Left). The value is returned in pixels. |
Position | Retrieves the position of the object on the sheet (Top or Left). The position is given as a relative value between 0 and 1, indicating its location on the sheet. |
Size | Retrieves the dimensions of the object (Height or Width). The size is returned as a relative value between 0 and 1, representing its proportion relative to the sheet size. |
Titles | Retrieves the Text or Visibility status of the selected title type (Title, Subtitle, or Footer). |
Visibility | Retrieves the Visibility status of the object, determining whether it is visible or hidden on the worksheet. |
Frame properties
Frame property | Description |
Background | Retrieves the background color of the object. |
Border | Retrieves the border properties including color, line style (solid, dashed and dotted), and size (width in pixels). |
Radius | Retrieves the object radius in pixels, indicating how rounded the corners of the object are. |
Supports
Feature | Description |
Embeds | Yes |
Reporting | Yes |
Set [Object] [Property]
The Set [Object] [Property] block allows users to modify specific properties of an object, such as its configuration, layout settings, or display options. Users can select an object and define various attributes related to its appearance, structure, and behavior. The block accepts strings, numbers, or booleans depending on the property being set.
Configuration
Inputs | Description |
Object | Select a sheet from the workbook or use a block that outputs a sheet name as a string. |
Property | See section below. |
Properties
Property | Description |
Frame | Allows you to set the frame properties of the object. Refer to the Frame Properties section for more details. |
Margin | Sets the margin of the object. You can set all margins at once or individually for Top, Right, Bottom, or Left. The value is specified in pixels. |
Padding | Sets the padding of the object. You can set all padding at once or individually for Top, Right, Bottom, or Left. The value is specified in pixels. |
Position | Sets the position of the object on the sheet (Top or Left). The position is defined as a relative value between 0 and 1, indicating its location on the sheet. |
Size | Sets the dimensions of the object (Height or Width). The size is defined as a relative value between 0 and 1, representing its proportion relative to the sheet size. |
Titles | Sets the Text or Visibility for the selected title type (Title, Subtitle, or Footer). |
Visibility | Sets the Visibility status of the object, determining whether it is visible or hidden on the worksheet. |
Frame properties
Frame property | Description |
Background | Sets the background color of the object. You can specify the color in hex code or named colors. |
Border | Sets the border properties, including the color, line style, and size (width in pixels). Line style options include: Custom, Dashed, Dotted, Double, None, and Solid. |
Radius | Retrieves the object radius in pixels, indicating how rounded the corners of the object are. |
Supports
Feature | Description |
Embeds | Yes |
Reporting | Yes |
Get export data from [Object]
The Get export data from [Object] block retrieves all data from a selected data object and outputs a list of row values. Each row of the selected data object is returned as a list, respecting all object-specific settings such as filters, export limit, sorting, and other configurations. Additionally, the global filtering state applied to the workbook will also affect the data retrieved by this block. This makes it a powerful tool for extracting customized, filtered data for further processing.
The data object must be visible on the active sheet for the block to successfully retrieve the data. When used in reporting, ensure that the report has navigated to the sheet where the data object exists and is visible. Additionally, the data export is limited to a maximum of 10,000 rows.
Configuration
Inputs | Description |
Data object | Choose the data object from which to export the data. The available objects are listed in the dropdown menu. |
This block is typically used when you need to extract data for further processing, export, or transformation. It simplifies fetching structured data for use in calculations, reports, or other workflows, while ensuring that the output respects all object settings (filters, sorting) as well as the global filtering state applied across the workbook.
Supports
Feature | Description |
Embeds | Yes |
Reporting | Yes |
Get [Sheet] [Property]
Select the desired sheet from the dropdown menu or use another block that outputs the desired sheet name.
Configuration
Inputs | Description |
Sheet | Select a sheet from the workbook or use a block that outputs a sheet name as a string. |
Property | See section below. |
Properties
Property | Description |
Display title | Get the display title of the specified sheet. |
Visibility | Get the visibility of the specified sheet. |
Supports
Feature | Description |
Embeds | Yes, workbook embeds only. |
Reporting | Yes |
Set [Sheet] [Property]
Select the desired sheet from the dropdown menu or use another block that outputs the desired sheet name. Attach the block to an event or condition to trigger the navigation
Configuration
Inputs | Description |
Object | Select a sheet from the workbook or use a block that outputs a sheet name as a string. |
Property | See section below. |
Properties
Property | Description |
Display title | Set the display title of the specified sheet. |
Visibility | Set the visibility of the specified sheet. |
Supports
Feature | Description |
Embeds | Yes, workbook embeds only. |
Reporting | Yes |