Use your organization's plugins

With Sigma, you can add plugin elements to workbooks, to support custom functionality that isn't standard with Sigma's deployment. You only have access to plugins registered with your organization. Plugins are third-party applications built to add additional functionality into an existing product. For example, a software developer in your organization may create a plugin that lets you display your data in a chart type not otherwise supported in Sigma.

This document covers how to add plugin elements to a workbook.

User requirements

To add or edit a workbook element through a plugin:

• You must be an organization admin, or be assigned an account type with the Manage plugins workbook permission.
• You must have Can Edit access to the workbook.
• To set a plugin background color, the usePluginStyle hook needs to be implemented for your organization's plugins. See the Sigma plugins repository README.

Add an element to a workbook through a plugin

Plugin-based elements only accept data elements as data sources. The source data element must be in the same workbook as the plugin. The workbook must be in Edit mode when adding a plugin.

1. From the Add element bar, select UI, then select Plugin.
2. Search and select your desired plugin from the list of your organization's plugins. Your new blank plugin-based element will appear on the workbook page.
3. Configure your element’s values using the editor panel. Each individual plugin will have different options available in the editor panel:

• Properties tab: Configure your plugin's data source.
• Format tab: In Plugin style, you can select a Background color for your plugin element using the available color palette or color picker. Selecting Auto automatically applies the background color of your workbook theme.
• Actions tab: You can use plugins as target or trigger elements for workbook actions. See Configure plugins to work with actions.

📘

Plugins only have access to the first 25,000 rows in a data source. You can group and aggregate data to reduce the total number of rows. If your data source already contains groupings, the editor panel prompts you to select an aggregate level. To load additional data beyond 25,000 rows, see the fetchMoreElementData() method in the Sigma plugins repository README.