Public Functions

[ ? ]

Inherited Functions

The Spreadsheet component is internally based on the Data Table component and inherits its Shared Functions.

Custom Functions

This section describes functions available in the Spreadsheet component.

Export Data

This function is used to export Spreadsheet data to a file.

Function Name:

exportData

Permissions:

Accessible at Observer permission level

Input Records:

1

Input Format:

Name

Type

Description

fileType

Integer

File extension used for export. Supported values:

  • 0 - .tbl

  • 3 - .csv

  • 6 - .pdf

  • 7 - .xlsx

fileName

String

Name of the exported file.

exportFormula

Boolean

If the value is true, cells will contain the formula itself instead of the formula result.

Output Records:

1

Output Format:

Name

Type

Description

filePath

String

Path to the exported Spreadsheet file.

Import Data

This function is used to import a file into the Spreadsheet.

Function Name:

importData

Permissions:

Accessible at Engineer permission level

Input Records:

1

Input Format:

Name

Type

Description

fileName

String

Name and the extension of the file to be imported. Supported formats:

  • .tbl

  • .csv

  • .xlsx.

importOptions

Data Table

CSV import options. Used only when importing data from a .csv file.

Output Records:

None

Get Spreadsheet

This function is used to return Spreadsheet data.

Function Name:

getSpreadsheet

Permissions:

Accessible at Observer permission level

Input Records:

1

Input Format:

Name

Type

Description

includeCells

Boolean

True if cell data should be included in the response.

Output Records:

1

Output Format:

see Spreadsheet Data

Save

This function is used to save the Spreadsheet.

Function Name:

save

Permissions:

Accessible at Operator permission level

Input Records:

None

Input Format:

None

Output Records:

None

Output Format:

None

Get Cells

This function is used to return Spreadsheet cell data for the specified ranges. It accepts a list of ranges for which cell data should be retrieved.

Function Name:

getCells

Permissions:

Accessible at Observer permission level

Input Records:

1

Input Format:

Name

Type

Description

ranges

Data Table

List of ranges whose cell data should be returned (see Range). In the current implementation, only the first range is processed.

Output Records:

1

Output Format:

Name

Type

Description

cells

Data Table

List of cells with data (see Cell). In the current implementation, only cells from the first range are returned.

Update Cells

This function is used to update Spreadsheet cell data.

It accepts a list of cells with data to be updated and does not return any output parameters.

Function Name:

updateCells

Permissions:

Accessible at Engineer permission level

Input Records:

1

Input Format:

see Cell

Output Records:

None

Output Format:

None

Clear Cells

This function is used to clear Spreadsheet cells in the specified ranges.

It accepts a list of ranges whose cells should be cleared and does not return any output parameters.

Function Name:

clearCells

Permissions:

Accessible at Operator permission level

Input Records:

1

Input Format:

see Range

Output Records:

None

Output Format:

None

Update Values

This function is used to update Spreadsheet cell values.

It accepts a list of cells whose values should be updated and does not return any output parameters.

Function Name:

updateValues

Permissions:

Accessible at Operator permission level

Input Records:

1

Input Format:

see Cell

Output Records:

None

Output Format:

None

Update Bindings

This function is used to update Spreadsheet bindings.

It accepts cell coordinates and binding expressions for the cells whose bindings should be updated and does not return any output parameters.

Function Name:

updateBindings

Permissions:

Accessible at Engineer permission level

Input Records:

1

Input Format:

 

 

 

Name

Type

Description

rowIndex

Integer

Row index of the cell.

columnIndex

Integer

Column index of the cell.

binding

String

Binding expression.

Output Records:

None

Output Format:

None

Update Formats

This function is used to update Spreadsheet formats.

It accepts a list of format entries that specify the target cells and the format to be applied and does not return any output parameters.

Function Name:

updateFormats

Permissions:

Accessible at Manager permission level

Input Records:

1

Input Format:

 

 

 

Name

Type

Description

rowIndex

Integer

Row index of the cell.

columnIndex

Integer

Column index of the cell.

format

String

Format of the cell.

Output Records:

None

Output Format:

None

Update Styles

This function is used to update Spreadsheet cell styles.

It accepts a list of style entries that specify the target cells and the style data to be applied and does not return any output parameters.

Function Name:

updateStyles

Permissions:

Accessible at Manager permission level

Input Records:

1

Input Format:

 

 

 

Name

Type

Description

rowIndex

Integer

Row index of the cell.

columnIndex

Integer

Column index of the cell.

styles

Data Table

Style data to be applied to the cell.

Output Records:

None

Output Format:

None

Update Comments

This function is used to update Spreadsheet comments.

It accepts a list of comment entries that specify the target cells and the comments to be applied and does not return any output parameters.

Function Name:

updateComments

Permissions:

Accessible at Manager permission level

Input Records:

1

Input Format:

 

 

 

Name

Type

Description

rowIndex

Integer

Row index of the cell.

columnIndex

Integer

Column index of the cell.

comments

Data Table

Comment data to be applied to the cell.

Output Records:

None

Output Format:

None

Merge Cells

This function is used to merge Spreadsheet cells in the specified range.

It accepts a list of ranges whose cells should be merged and does not return any output parameters.

Function Name:

mergeCells

Permissions:

Accessible at Manager permission level

Input Records:

1

Input Format:

see Range

Output Records:

None

Output Format:

None

Unmerge Cells

This function is used to unmerge Spreadsheet cells in the specified range.

It accepts a list of ranges whose cells should be unmerged and does not return any output parameters.

Function Name:

unmergeCells

Permissions:

Accessible at Manager permission level

Input Records:

1

Input Format:

see Range

Output Records:

None

Output Format:

None

Add Groups

This function is used to add Spreadsheet groups.

It accepts a list of group entries to be added and does not return any output parameters.

Function Name:

addGroups

Permissions:

Accessible at Engineer permission level

Input Records:

1

Input Format:

see Group

Output Records:

None

Output Format:

None

Remove Groups

This function is used to remove Spreadsheet groups.

It accepts a list of group entries to be removed and does not return any output parameters.

Function Name:

removeGroups

Permissions:

Accessible at Engineer permission level

Input Records:

1

Input Format:

see Group

Output Records:

None

Output Format:

None

Update Groups

This function is used to update the specified Spreadsheet groups.

It accepts a list of group entries to be updated and does not return any output parameters.

Function Name:

updateGroups

Permissions:

Accessible at Engineer permission level

Input Records:

1

Input Format:

see Group

Output Records:

None

Output Format:

None

Add Conditional Format

This function is used to add conditional formatting settings for Spreadsheet cells.

It accepts a list of conditional formatting entries to be added and does not return any output parameters.

Function Name:

addConditionalFormat

Permissions:

Accessible at Manager permission level

Input Records:

1

Input Format:

see Conditional Format

Output Records:

None

Output Format:

None

Update Conditional Format

This function is used to update conditional formatting settings for Spreadsheet cells.

It accepts a list of conditional formatting entries to be updated and does not return any output parameters.

Function Name:

updateConditionalFormat

Permissions:

Accessible at Manager permission level

Input Records:

1

Input Format:

see Conditional Format

Output Records:

None

Output Format:

None

Delete Conditional Format

This function is used to delete conditional formatting settings for Spreadsheet cells.

It accepts a list of conditional formatting entries to be deleted and does not return any output parameters.

Function Name:

deleteConditionalFormat

Permissions:

Accessible at Manager permission level

Input Records:

1

Input Format:

see Conditional Format

Output Records:

None

Output Format:

None

Evaluate

This function is used to recalculate cell formulas in the specified Spreadsheet ranges.

It accepts a list of ranges for which formulas should be recalculated. Note that this parameter is currently not used. The function does not return any output parameters.

Function Name:

evaluate

Permissions:

Accessible at Operator permission level

Input Records:

1

Input Format:

see Range

Output Records:

None

Output Format:

None

Get Spreadsheet Properties

This function is used to return Spreadsheet properties.

Function Name:

getSpreadsheetProperties

Permissions:

Accessible at Operator permission level

Input Records:

None

Input Format:

None

Output Records:

1

Output Format:

see Spreadsheet Properties

Set Spreadsheet Properties

This function is used to update Spreadsheet properties.

Function Name:

setSpreadsheetProperties

Permissions:

Accessible at Operator permission level

Input Records:

1

Input Format:

see Spreadsheet Properties

Output Records:

None

Output Format:

None

Get Conditional Formats

This function is used to return conditional formatting rules for the specified Spreadsheet ranges.

It accepts a list of ranges for which conditional formatting rules should be returned. If no ranges are specified, all conditional formatting rules are returned.

Function Name:

getConditionalFormats

Permissions:

Accessible at Operator permission level

Input Records:

1

Input Format:

see Range

Output Records:

0…Unlimited

Output Format:

see Conditional Format

Sort

This function is used to sort Spreadsheet data in the specified range.

Function Name:

sort

Permissions:

Accessible at Manager permission level

Input Records:

1

Input Format:

 

 

 

Name

Type

Description

id

String

Spreadsheet session identifier.

sortingParameter

Data Table

Sorting parameter (see Sorting Parameter).

Output Records:

None

Output Format:

None

Was this page helpful?