How to create an Excel Sheet using the add matrix endpoint

From Tygron Support wiki
Jump to navigation Jump to search

The API endpoint Api session event editor excelsheet add matrix can be used to create an Excel Sheet using text input arguments that represent a matrix of cell content, a matrix of named cells and the name of created excel sheet.

Content format

The endpoint requires four input parameters:

  1. The name of the created excel sheet; Must be lower-case underscored.
  2. A row-major matrix with the content for each cell; The content can be number, or text.
  3. A row-major matrix with names put on particular cells. Empty names are ignored.

Named Cells

Names can be assigned to cells in Excel. Generally these names are used to reference the content of a cell inside an excel sheet. These references can be used directly in excel formulas. Additionally, named cells are used by the Tygron Platform to put data into and obtain data out of an instance of an Excel Sheet.

The following names can be used for input and output:

  • TQL
  • Indicator specific, for example: EXPLANATION and SCORE
  • Panel specific, for example: EXPLANATION

Example


Notes

  • Formula cells are provided as text, starting with a "="-sign.
  • Numbers cells can also be provided as text using a formula; For example: "=5.14";
  • Use empty strings for empty cells; ""

How-to's

See also

API Endpoints