Create actions that modify or refresh elements

Workbooks support actions that determine column visibility, update element groupings and properties, change axis scales, refresh data, and select tabs in tabbed containers. These actions enable interacting users to quickly view and drill into different underlying data segments, tailor chart presentations, and ensure elements display the most up-to-date data.

This document explains how to configure the Modify element, Refresh element, and Select tab actions. For more information about actions in Sigma, see Intro to actions.

User requirements

📘

The following requirements apply to users who configure actions. Users who access and interact with a workbook can typically trigger all existing actions within it. Any restrictions are noted in this document.

The ability to configure actions requires the following:

• You must be assigned an account type with the Full explore or Create, edit, and publish workbooks permission enabled.

• You must be the workbook owner or be granted Can explore¹ or Can edit workbook permission.

1 If you’re granted Can explore workbook permission, you can configure actions but cannot save changes to the workbook’s published version.

Modify elements

The Modify elements action supports the following effects:

• Show columns
• Hide columns
• Move columns
• Swap columns
• Set axis scale

Show columns

Create an action that shows columns (ungrouped only) in the target element. Columns can be shown based on a static selection or when column names match selected control values in the trigger element.

1. Open a workbook in Explore or Edit mode.
2. Select the trigger element (the element users must interact with to initiate the action), then click Actions in the side navigation.
3. In the Actions panel, click Add action in an existing sequence, or click Add action sequence to create a new one.
4. In the Action modal, configure the required fields to define the response:

• Action	Select Modify element.
  Target element	Select an element to modify.
  What to modify	Select Show columns, then choose one or more columns to show in the target element. If the trigger element is a List values or Segmented control, choose an option in the secondary field: From a static selection: Allows you to select specific columns to show in the target element. When you choose All columns, user interaction triggers the target element to show all columns that existed at the time you configured the action. To show columns added post-configuration, you must update the action. With names matching control values: Dynamically shows columns in the target element when the column names match selected control values in the trigger element. When a user interacts with the control, the target element shows all columns with names that match selected control values (selected checkboxes in a List values control, or the selected segment in a Segmented control) and hides all columns with names that match unselected control values (cleared checkboxes in a List values control, or unselected segments in a Segmented control). Columns with names that don't correspond to control values are unaffected by the action and may be shown or hidden based on other configurations and actions.
  Hide unselected columns	Select the checkbox to hide the remaining columns (not selected in the What to modify field), or keep the checkbox clear to continue showing all columns already displayed in the target element.

  💡

  To set column names as the control values, use one of the following methods:

  • Enter column names in an input table column, then select that column as the control element's value source.
  • Create a manual list of column names as the control element's values source.

5. If the trigger element is a table, pivot table, or input table, configure additional settings that determine when and how user interaction triggers the action sequence:
   • To trigger the action sequence only when a user selects a cell in a specific column, click the dropdown following the On select heading and select the column. To trigger the action sequence when a user selects a cell in any column, select Any column.
   • [optional] To control whether keyboard navigation within the element can trigger action sequences on the element, click More in the Actions panel, then select Allow keyboard to trigger actions. When the option displays a checkmark, keyboard navigation and pointer events (e.g., mouse clicks) can trigger the action sequences. When the option doesn't display a checkmark (default), only pointer events can trigger them.

     💡

     Keyboard navigation as a trigger interaction can disrupt the user experience. For example, if the element's action sequences include actions that open links or other workbooks, a user can be unintentionally navigated away from their current task. This can be particularly disruptive if the action sequence can be triggered by selecting a cell in any column.

     Consider allowing keyboard navigation to trigger actions only when it facilitates the configured action sequences and is unlikely to interfere with usability.

6. If the trigger element is a plugin, select the name of the plugin configuration object under Custom plugin. In your code editor, refresh your plugin, then test the action in the workbook. For more information, see Configure plugins to use as trigger elements.
7. [optional] To execute the action sequence only when a specific condition is met, click More in the action sequence, then select Add condition and configure the criteria. For more information about conditions, see Define an action condition.

Hide columns

Create an action that hides columns (ungrouped only) in the target element. Columns can be hidden based on a static selection or when column names match selected control values in the trigger element.

1. Open a workbook in Explore or Edit mode.
2. Select the trigger element (the element users must interact with to initiate the action), then click Actions in the side navigation.
3. In the Actions panel, click Add action in an existing sequence, or click Add action sequence to create a new one.
4. In the Action modal, configure the required fields to define the response:

• Action	Select Modify element.
  Target element	Select an element to modify.
  What to modify	Select Hide columns, then choose one or more columns to hide in the target element. If the trigger element is a List values or Segmented control, choose an option in the secondary field: From a static selection: Allows you to select specific columns to hide in the target element. When you choose All columns, user interaction triggers the target element to hide all columns that existed at the time you configured the action. To hide columns added post-configuration, you must update the action. With names matching control values: Dynamically hides columns in the target element when the column names match selected control values in the trigger element. When a user interacts with the control, the target element hides all columns with names that match selected control values (selected checkboxes in a List values control, or the selected segment in a Segmented control) and shows all columns with names that match unselected control values (cleared checkboxes in a List values control, or unselected segments in a Segmented control). Columns with names that don't correspond to control values are unaffected by the action and may be shown or hidden based on other configurations and actions.
  Show unselected columns	Select the checkbox to show the remaining columns (not selected in the What to modify field), or keep the checkbox clear to continue hiding all columns already hidden in the target element.

  💡

  To set column names as the control values, use one of the following methods:

  • Enter column names in an input table column, then select that column as the control element's value source.
  • Create a manual list of column names as the control element's values source.

5. If the trigger element is a table, pivot table, or input table, configure additional settings that determine when and how user interaction triggers the action sequence:
   • To trigger the action sequence only when a user selects a cell in a specific column, click the dropdown following the On select heading and select the column. To trigger the action sequence when a user selects a cell in any column, select Any column.
   • [optional] To control whether keyboard navigation within the element can trigger action sequences on the element, click More in the Actions panel, then select Allow keyboard to trigger actions. When the option displays a checkmark, keyboard navigation and pointer events (e.g., mouse clicks) can trigger the action sequences. When the option doesn't display a checkmark (default), only pointer events can trigger them.

     💡

     Keyboard navigation as a trigger interaction can disrupt the user experience. For example, if the element's action sequences include actions that open links or other workbooks, a user can be unintentionally navigated away from their current task. This can be particularly disruptive if the action sequence can be triggered by selecting a cell in any column.

     Consider allowing keyboard navigation to trigger actions only when it facilitates the configured action sequences and is unlikely to interfere with usability.

6. If the trigger element is a plugin, select the name of the plugin configuration object under Custom plugin. In your code editor, refresh your plugin, then test the action in the workbook. For more information, see Configure plugins to use as trigger elements.
7. [optional] To execute the action sequence only when a specific condition is met, click More in the action sequence, then select Add condition and configure the criteria. For more information about conditions, see Define an action condition.

Move columns

Create an action that moves columns into or out of a table grouping, pivot table property (row, column, or value), or chart property (axis, color, tooltip, etc.) in the target element. Columns can be moved based on a static selection or when column names match selected control values in the trigger element.

📘

If the target element is a table, the Move columns option is only available when the table contains existing groupings.

If the target element is a pivot table or chart, the action doesn't remove an existing column from the target property unless the property only supports one column.

1. Open a workbook in Explore or Edit mode.
2. Select the trigger element (the element users must interact with to initiate the action), then click Actions in the side navigation.
3. In the Actions panel, click Add action in an existing sequence, or click Add action sequence to create a new one.
4. In the Action modal, configure the required fields to define the response:

• Action	Select Modify element.
  Target element	Select an element to modify.
  What to modify	Select Move columns, then select a grouping or property from the target element. The to base option moves a column out of a grouping or property and into the base underlying data . Other available groupings and properties depend on the type of target element selected
  Column to move	Most elements only support the From a static selection option, which allows you to choose a specific column to move into or out of the target grouping or property. In these cases, use the secondary column to select the column to move. If the trigger element is a List values or Segmented control, you can choose the Column names matching control values option to dynamically move columns when their names match selected control values in the trigger element.

  💡

  To set column names as the control values, use one of the following methods:

  • Enter column names in an input table column, then select that column as the control element's value source.
  • Create a manual list of column names as the control element's values source.

5. If the trigger element is a table, pivot table, or input table, configure additional settings that determine when and how user interaction triggers the action sequence:
   • To trigger the action sequence only when a user selects a cell in a specific column, click the dropdown following the On select heading and select the column. To trigger the action sequence when a user selects a cell in any column, select Any column.
   • [optional] To control whether keyboard navigation within the element can trigger action sequences on the element, click More in the Actions panel, then select Allow keyboard to trigger actions. When the option displays a checkmark, keyboard navigation and pointer events (e.g., mouse clicks) can trigger the action sequences. When the option doesn't display a checkmark (default), only pointer events can trigger them.

     💡

     Keyboard navigation as a trigger interaction can disrupt the user experience. For example, if the element's action sequences include actions that open links or other workbooks, a user can be unintentionally navigated away from their current task. This can be particularly disruptive if the action sequence can be triggered by selecting a cell in any column.

     Consider allowing keyboard navigation to trigger actions only when it facilitates the configured action sequences and is unlikely to interfere with usability.

6. If the trigger element is a plugin, select the name of the plugin configuration object under Custom plugin. In your code editor, refresh your plugin, then test the action in the workbook. For more information, see Configure plugins to use as trigger elements.
7. [optional] To execute the action sequence only when a specific condition is met, click More in the action sequence, then select Add condition and configure the criteria. For more information about conditions, see Define an action condition.

Swap columns

Create an action that swaps all columns of a table grouping, chart property (axis, color, tooltip, etc.), or pivot table property (row, column, or value). This action removes all existing columns in the target grouping or property and replaces them with the selected column.

1. Open a workbook in Explore or Edit mode.
2. Select the trigger element (the element users must interact with to initiate the action), then click Actions in the side navigation.
3. In the Actions panel, click Add action in an existing sequence, or click Add action sequence to create a new one.
4. In the Action modal, configure the required fields to define the response:

• Action	Select Modify element.
  Target element	Select an element to modify.
  What to modify	Select Swap columns, then select a grouping or property from the target element.
  Swap with	Select a column to replace the existing columns in the target grouping or property.

5. If the trigger element is a table, pivot table, or input table, configure additional settings that determine when and how user interaction triggers the action sequence:
   • To trigger the action sequence only when a user selects a cell in a specific column, click the dropdown following the On select heading and select the column. To trigger the action sequence when a user selects a cell in any column, select Any column.
   • [optional] To control whether keyboard navigation within the element can trigger action sequences on the element, click More in the Actions panel, then select Allow keyboard to trigger actions. When the option displays a checkmark, keyboard navigation and pointer events (e.g., mouse clicks) can trigger the action sequences. When the option doesn't display a checkmark (default), only pointer events can trigger them.

     💡

     Keyboard navigation as a trigger interaction can disrupt the user experience. For example, if the element's action sequences include actions that open links or other workbooks, a user can be unintentionally navigated away from their current task. This can be particularly disruptive if the action sequence can be triggered by selecting a cell in any column.

     Consider allowing keyboard navigation to trigger actions only when it facilitates the configured action sequences and is unlikely to interfere with usability.

6. If the trigger element is a plugin, select the name of the plugin configuration object under Custom plugin. In your code editor, refresh your plugin, then test the action in the workbook. For more information, see Configure plugins to use as trigger elements.
7. [optional] To execute the action sequence only when a specific condition is met, click More in the action sequence, then select Add condition and configure the criteria. For more information about conditions, see Define an action condition.

Set axis scale

Create an action to set the scale of the dependent variable (or value) axis in the target element.

1. Open a workbook in Explore or Edit mode.
2. Select the trigger element (the element users must interact with to initiate the action), then click Actions in the side navigation.
3. In the Actions panel, click Add action in an existing sequence, or click Add action sequence to create a new one.
4. In the Action modal, configure the required fields to define the response:

• Action	Select Modify element.
  Target element	Select an element to modify.
  What to modify	Select Set axis scale.
  Scale type	Select an option to determine the scale type applied to the target element’s dependent variable (or value) axis.

5. If the trigger element is a table, pivot table, or input table, configure additional settings that determine when and how user interaction triggers the action sequence:
   • To trigger the action sequence only when a user selects a cell in a specific column, click the dropdown following the On select heading and select the column. To trigger the action sequence when a user selects a cell in any column, select Any column.
   • [optional] To control whether keyboard navigation within the element can trigger action sequences on the element, click More in the Actions panel, then select Allow keyboard to trigger actions. When the option displays a checkmark, keyboard navigation and pointer events (e.g., mouse clicks) can trigger the action sequences. When the option doesn't display a checkmark (default), only pointer events can trigger them.

     💡

     Keyboard navigation as a trigger interaction can disrupt the user experience. For example, if the element's action sequences include actions that open links or other workbooks, a user can be unintentionally navigated away from their current task. This can be particularly disruptive if the action sequence can be triggered by selecting a cell in any column.

     Consider allowing keyboard navigation to trigger actions only when it facilitates the configured action sequences and is unlikely to interfere with usability.

6. If the trigger element is a plugin, select the name of the plugin configuration object under Custom plugin. In your code editor, refresh your plugin, then test the action in the workbook. For more information, see Configure plugins to use as trigger elements.
7. [optional] To execute the action sequence only when a specific condition is met, click More in the action sequence, then select Add condition and configure the criteria. For more information about conditions, see Define an action condition.

Refresh an element

Create an action to refresh the data of a target element in the current workbook. Refreshing a parent element also refreshes all child elements in the workbook.

🚧

This action doesn’t refresh the data if the element is materialized.

1. Open a workbook in Explore or Edit mode.
2. Select the trigger element (the element users must interact with to initiate the action), then click Actions in the side navigation.
3. In the Actions panel, click Add action in an existing sequence, or click Add action sequence to create a new one.
4. In the Action modal, configure the required fields to define the response:

• Action	Select Refresh element.
  Element	Select an element to refresh.

5. If the trigger element is a table, pivot table, or input table, configure additional settings that determine when and how user interaction triggers the action sequence:
   • To trigger the action sequence only when a user selects a cell in a specific column, click the dropdown following the On select heading and select the column. To trigger the action sequence when a user selects a cell in any column, select Any column.
   • [optional] To control whether keyboard navigation within the element can trigger action sequences on the element, click More in the Actions panel, then select Allow keyboard to trigger actions. When the option displays a checkmark, keyboard navigation and pointer events (e.g., mouse clicks) can trigger the action sequences. When the option doesn't display a checkmark (default), only pointer events can trigger them.

     💡

     Keyboard navigation as a trigger interaction can disrupt the user experience. For example, if the element's action sequences include actions that open links or other workbooks, a user can be unintentionally navigated away from their current task. This can be particularly disruptive if the action sequence can be triggered by selecting a cell in any column.

     Consider allowing keyboard navigation to trigger actions only when it facilitates the configured action sequences and is unlikely to interfere with usability.

6. If the trigger element is a plugin, select the name of the plugin configuration object under Custom plugin. In your code editor, refresh your plugin, then test the action in the workbook. For more information, see Configure plugins to use as trigger elements.
7. [optional] To execute the action sequence only when a specific condition is met, click More in the action sequence, then select Add condition and configure the criteria. For more information about conditions, see Define an action condition.

Select tab (beta)

🚩

This documentation describes a public beta feature and is under construction. This documentation should not be considered part of our published documentation until this notice, and the corresponding Beta flag on the feature in the Sigma service, are removed. As with any beta feature, the feature discussed below is subject to quick, iterative changes. The latest experience in the Sigma service might differ from the contents of this document.

Beta features are subject to the Beta features disclaimer.

Create an action to display a specific tab in a tabbed container element.

1. Open a workbook in Explore or Edit mode.
2. Select the trigger element (the element users must interact with to initiate the action), then click Actions in the side navigation.
3. In the Actions panel, click Add action in an existing sequence, or click Add action sequence to create a new one.
4. In the Action modal, configure the required fields to define the response:

• Action	Select Select tab.
  Tabbed container	Select a tabbed container in this workbook.
  Tab	Select the tab to display.

5. If the trigger element is a table, pivot table, or input table, configure additional settings that determine when and how user interaction triggers the action sequence:
   • To trigger the action sequence only when a user selects a cell in a specific column, click the dropdown following the On select heading and select the column. To trigger the action sequence when a user selects a cell in any column, select Any column.
   • [optional] To control whether keyboard navigation within the element can trigger action sequences on the element, click More in the Actions panel, then select Allow keyboard to trigger actions. When the option displays a checkmark, keyboard navigation and pointer events (e.g., mouse clicks) can trigger the action sequences. When the option doesn't display a checkmark (default), only pointer events can trigger them.

     💡

     Keyboard navigation as a trigger interaction can disrupt the user experience. For example, if the element's action sequences include actions that open links or other workbooks, a user can be unintentionally navigated away from their current task. This can be particularly disruptive if the action sequence can be triggered by selecting a cell in any column.

     Consider allowing keyboard navigation to trigger actions only when it facilitates the configured action sequences and is unlikely to interfere with usability.

6. If the trigger element is a plugin, select the name of the plugin configuration object under Custom plugin. In your code editor, refresh your plugin, then test the action in the workbook. For more information, see Configure plugins to use as trigger elements.
7. [optional] To execute the action sequence only when a specific condition is met, click More in the action sequence, then select Add condition and configure the criteria. For more information about conditions, see Define an action condition.