Build from code

Workbook representation example library (Beta)

View as Markdown

This documentation describes one or more public beta features that are in development. Beta features are subject to quick, iterative changes; therefore the current user experience in the Sigma service can differ from the information provided in this page.

This page should not be considered official published documentation until Sigma removes this notice and the beta flag on the corresponding feature(s) in the Sigma service. For the full beta feature disclaimer, see Beta features.

The Sigma programmatic API endpoints, including Create a workbook, Update a workbook from a code representation, and Get a workbook, require a specific format for the representation of the workbook. This example library shows examples of workbook representations for various configurations, using different element types and features in Sigma.

Consult these examples to:

  • Troubleshoot the formatting of a particular feature in a code representation
  • Relate a feature from the Sigma UI to its representation in code
  • Provide context to AI assistants used to create workbooks from code

Example representations

To review a specific representation, search or browse the following examples:

Feature ↕Link
Workbook with a tableView example
Workbook with a bar chartView example
Workbook with a line chartView example
Workbook with a KPIView example
Workbook with a pie chartView example
Workbook with a donut chartView example
Workbook with a pivot tableView example
Workbook with a containerView example
Workbook with a text elementView example
Workbook with an area chartView example
Workbook with a scatter chartView example
Workbook with a combo chartView example
Workbook with a dividerView example
Workbook with an imageView example
Workbook with a chart with stackingView example
Workbook with a page background imageView example
Workbook with a point mapView example
Workbook with a geography mapView example
Workbook with a region mapView example
Workbook with a chart with reference marksView example

To see the representation for a specific configuration or combination of features, you can create the workbook in the UI and then retrieve the representation using the Get a workbook endpoint with includeContents=true.