Skip to main content
Events (Triggers)
Karl Sjöstrand avatar
Written by Karl Sjöstrand
Updated over 7 months ago

The Events section contains a variety of blocks that allow you to trigger actions based on different events within your workbook. These blocks enable dynamic responses to user interactions and changes in the application state, making your project more interactive and responsive. This section includes blocks that trigger actions on time intervals, sheet transitions, variable changes, and other significant events. Below, each block is described in detail to help you understand its functionality and use cases.

Every [Number of seconds] sec

The Every [Number of seconds] sec block triggers the execution of the connected block stack at regular intervals of 120 seconds. This is useful for periodic tasks such as refreshing data or updating UI elements.

Configuration

Inputs

Description

Number of seconds

Customize the interval by changing the number of seconds.

Child blocks

Attach the blocks you want to execute at each interval.

Drag the block to the workspace and attach the blocks you want to execute at each interval, inside the Every block. Customize the interval by changing the number of seconds.

Supports

Feature

Description

Embeds

Yes

Reporting

Not supported

Enter [Sheet]

The Enter [Sheet] block triggers the execution of the connected block stack when the user navigates to a specified sheet. This is useful for initializing content or settings when a sheet becomes active.

Configuration

Inputs

Description

Sheet

Upon entering the selected sheet, this block will trigger and initiate the execution of the connected block stack.

Select the desired sheet from the dropdown menu. Attach the blocks you want to execute upon entering the sheet.

Supports

Feature

Description

Embeds

Yes, workbook embeds only.

Reporting

Not supported

Exit [Sheet]

The Exit [Sheet] block triggers the execution of the connected block stack when the user navigates away from a specified sheet. This is useful for cleanup tasks or saving the state before leaving a sheet.

Configuration

Inputs

Description

Sheet

Upon exiting the selected sheet, this block will trigger and initiate the execution of the connected block stack.

Select the desired sheet from the dropdown menu. Attach the blocks you want to execute upon exiting the sheet.

Supports

Feature

Description

Embeds

Yes, workbook embeds only.

Reporting

Not supported

Variable change [Variable]

The Variable change [Variable] block triggers the execution of the connected block stack when a specified variable's value changes. This is useful for responding to dynamic data changes within the application.

Configuration

Inputs

Description

Variable

Select

Select the variable from the dropdown menu. Attach the blocks you want to execute when the variable changes.

NOTE: The Variable change block will not trigger if the variable is set to its current value.

Supports

Feature

Description

Embeds

Yes

Reporting

Not supported

Before workbook opens

The Before workbook opens block triggers the execution of the connected block stack before the workbook opens. This allows you to set up necessary conditions or load/writeback data before the workbook renders and the user starts interacting with it.

Configuration

Attach the blocks you want to execute before the workbook opens.

Supports

Feature

Description

Embeds

Yes, workbook embeds only.

Reporting

Not supported

On any [Applied/Pending] filter change

The On any [Applied/Pending] filter change block triggers the execution of the connected block stack whenever any filter changes to either applied or pending status. This is useful for dynamically updating the UI or performing calculations based on these filter changes.

A filter change includes actions such as adding or removing a filter value, or making other modifications to the filter, such as inverting it.

Configuration

Inputs

Description

Filter state

  • Applied - The filter change is applied and actively affects the data.

  • Pending - The filter change is in progress but not yet applied.

Attach the blocks you want to execute when any filter changes either the applied or the pending filters.

Supports

Feature

Description

Embeds

Yes

Reporting

Not supported

On [Table].[Field] filter change within [Applied/Pending] state

The On [Table].[Field] filter change within [Applied/Pending] state block triggers the execution of the connected block stack when a specific field's filter within a table changes to either applied or pending status. This is useful for dynamically updating the UI or performing calculations based on these filter changes.

A filter change includes actions such as adding or removing a filter value, or making other modifications to the filter, such as inverting it.

Configuration

Inputs

Description

Table - Field

Select the table from the Data view that contains the field to react to. Select the specific field within the configured table.

Other blocks can be used to reference a table or field by name, or the entire Table.Field block can be replaced with a block that outputs text, such as Marketing Table.Traffic Source.

Filter state

  • Applied - The filter change is applied and actively affects the data.

  • Pending - The filter change is in progress but not yet applied.

Select the table and field from the dropdown menus. Attach the blocks you want to execute when the specified filter changes.

Supports

Feature

Description

Embeds

Yes

Reporting

Not supported

On [Drill-through] change

The On [Drill-through] change block triggers the execution of the connected block stack when a drill-through event occurs. Drill-through events occur the active drill-through field changes. This is useful to display detailed data in a popup or navigate to a more detailed view related to the selected drill-through field.

Configuration

Inputs

Description

Drill-through

Select the Drill-through dimension to react to.

Attach the blocks you want to execute when a drill-through event happens.

Supports

Feature

Description

Embeds

Yes

Reporting

Not supported

By utilizing these blocks, you can create a highly interactive and responsive application that reacts to user actions and changes in the application state, providing a dynamic user experience.

Did this answer your question?