Spreadsheets

A Spreadsheet is a Model entity that stores tabular data and is used by the Spreadsheet dashboard component to store and display tabular data. A Spreadsheet consists of two layers: the Dashboard component provides the user interface, while the Model stores Spreadsheet data, evaluates expressions, and synchronizes changes between users.

To use the Spreadsheet component, first define a Spreadsheet in a Model. Each record defines a single Spreadsheet that can be referenced by the component. To display it in a dashboard, configure the component to use the required model context and Spreadsheet name.

Spreadsheet availability depends on the Model Type:

  • In an absolute model, a Spreadsheet belongs to the model context itself.

  • In an instantiable model, Spreadsheets can also be available in model instances. For instantiable models, Spreadsheet definitions are propagated to instance contexts only when the allowSpreadsheetsInInstances option is enabled. For details, see Model Properties.

  • In a relative model, Spreadsheets can also be available in relative objects.

Spreadsheet Data Structures

Spreadsheet data is represented by predefined data structures. These structures are used in related sections that describe Spreadsheet values, function parameters, and event data.

Each Spreadsheet contains a data field that stores its content and configuration. This field includes cells, ranges, metadata, conditional formatting, styles, and formats.

For a full description of these structures, see Spreadsheet Data Structures.

Spreadsheet Variables

[?]

Spreadsheets

This variable defines Spreadsheets stored in the Model. Each record of this variable represents one Spreadsheet.

Variable Name:

spreadsheets

Records:

0…Unlimited

Record Format:

See Model Configuration, Spreadsheets.

Spreadsheet Status

Shows the list of the currently opened Spreadsheets in the current model context. Each record represents an active Spreadsheet session and includes Spreadsheet details, user information, and access mode.

Variable Name:

spreadsheetStatus

Records:

0…Unlimited

Record Format:

Field Name

Field Type

Field Description

spreadsheetName

String

Name. Defines the name of the opened Spreadsheet.

spreadsheetDescription

String

Description of the opened Spreadsheet.

userName

String

Name of the user who opened the Spreadsheet.

userLogin

String

User login.

userAddress

String

User IP address.

readMode

Integer

Spreadsheet access mode. Supported values:

  • 0 - Read-only

  • 1 - Edit.

Was this page helpful?