Skip to navigation

Workbook representation example library

View as Markdown

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:

Page 1 of 6
CategoryLink
Workbook with a tableTablesView example
Workbook with a bar chartChartsView example
Workbook with a line chartChartsView example
Workbook with a KPIChartsView example
Workbook with a pie chartChartsView example
Workbook with a donut chartChartsView example
Workbook with a pivot tableTablesView example
Workbook with a containerLayoutsView example
Workbook with a text elementUI elementsView example
Workbook with an area chartChartsView example
Workbook with a scatter chartChartsView example
Workbook with a combo chartChartsView example
Workbook with a dividerUI elementsView example
Workbook with an imageUI elementsView example
Workbook with a chart with stackingChartsView example
Workbook with a page background imageWorkbook settingsView example
Workbook with a point mapChartsView example
Workbook with a geography mapChartsView example
Workbook with a region mapChartsView example
Workbook with a chart with reference marksChartsView 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.