Spreadsheet

R2026b

Spreadsheet in Safety Analysis Manager

Since R2023b

Description

Spreadsheet objects represent spreadsheets in the Safety Analysis Manager. Use Spreadsheet objects to configure spreadsheets you use for safety analyses.

Creation

To create a Spreadsheet object:

• Use the safetyAnalysisMgr.newSpreadsheet function to create a new spreadsheet in the Safety Analysis Manager.

• Use the safetyAnalysisMgr.openDocument function to open a spreadsheet in the Safety Analysis Manager.

• Use the safetyAnalysisMgr.getOpenDocuments function to retrieve the open spreadsheets in the Safety Analysis Manager.

• In the Safety Analysis Manager, select the spreadsheet and use the safetyAnalysisMgr.getCurrentDocument function. (since R2026b)

• Use the getSpreadsheet function on a SpreadsheetCell object.

• Use the getSpreadsheet function on a SpreadsheetRow object (since R2024b).

Properties

FileName — Folder of spreadsheet

Read-only: character vector

This property is read-only.

Folder of the spreadsheet file, represented as a character vector.

Example: 'C:/Documents/mySpreadsheet'

Data Types: char

Rows — Number of rows in spreadsheet

Read-only: integer

This property is read-only.

Number of rows in the spreadsheet, represented as an integer.

Data Types: uint64

Columns — Number of columns in spreadsheet

Read-only: integer

This property is read-only.

Number of columns in the spreadsheet, represented as an integer.

Data Types: uint64

Description — Spreadsheet description

'' (default) | string scalar | character vector

Spreadsheet description, specified as a string scalar or character vector.

Data Types: char | string

Object Functions

acceptAllChanges	Accept detected changes to linked artifacts in Safety Analysis Manager
addCallback	Add custom callback to Safety Analysis Manager spreadsheets
addColumn	Add column to spreadsheet in Safety Analysis Manager
addDocumentAttribute	Add document attribute to spreadsheet in Safety Analysis Manager
addRow	Add row to spreadsheet in Safety Analysis Manager
clearFlags	Clear flags in Safety Analysis Manager spreadsheet and fault tree document elements
close	Close document in Safety Analysis Manager
deleteCallback	Delete custom callback from Safety Analysis Manager documents
deleteColumn	Delete column in spreadsheet in Safety Analysis Manager
deleteDocumentAttribute	Delete document attributes in spreadsheet in Safety Analysis Manager
deleteRow	Delete row in spreadsheet in Safety Analysis Manager
detectChanges	Detect changes to linked artifacts in Safety Analysis Manager document
enableCallback	Enable or disable callbacks in Safety Analysis Manager spreadsheets
export	Export Safety Analysis Manager spreadsheet to Excel
find	Find cells in Safety Analysis Manager spreadsheets containing specific values
getCallback	Retrieve spreadsheet callback code in Safety Analysis Manager
getCell	Retrieve spreadsheet cells
getChanges	Get changed artifacts linked to artifacts in Safety Analysis Manager
getColumnFormula	Get derived column formula from spreadsheet in Safety Analysis Manager
getColumnLabels	Retrieve column labels in spreadsheet in Safety Analysis Manager
getColumnTypes	Retrieve column types in spreadsheet in Safety Analysis Manager
getCustomCallbackNames	Retrieve names of custom callbacks in Safety Analysis Manager documents
getDocumentAttribute	Retrieve document attribute values in Safety Analysis Manager documents
getDocumentAttributeProperties	Retrieve document attribute properties in Safety Analysis Manager document
getFlags	Retrieve flags from Safety Analysis Manager documents
getRow	Retrieve spreadsheet rows
isCallbackEnabled	Determine whether custom callbacks are enabled
refreshDerivedValues	Recalculate values in spreadsheet derived columns
refreshLinks	(Removed) Refresh link resolved status in Safety Analysis Manager documents
renameCallback	Rename custom callbacks in Safety Analysis Manager spreadsheets
renameDocumentAttribute	Rename document attributes in Safety Analysis Manager documents
runAnalysis	Execute callback script on Safety Analysis Manager document
save	Save Safety Analysis Manager document
saveTemplate	Save Safety Analysis Manager document as a template
setCallback	Assign code to Safety Analysis Manager document callback
setColumnFormula	Specify derived column formulas in spreadsheet in Safety Analysis Manager
setColumnLabel	Adjust column label of spreadsheet in Safety Analysis Manager
setDocumentAttribute	Set document attributes in Safety Analysis Manager documents
setValue	Write values to spreadsheet cells

Examples

Create New Spreadsheet in the Safety Analysis Manager

Create a new spreadsheet in the Safety Analysis Manager.

mySpreadsheet = safetyAnalysisMgr.newSpreadsheet

mySpreadsheet = 

  Spreadsheet with properties:

    FileName: ''
        Rows: 1
     Columns: 1
 Description: ''

Retrieve Spreadsheet Object from Safety Analysis Manager

Suppose that you load only one spreadsheet in the Safety Analysis Manager. The spreadsheet file is named mySpreadsheet, is saved in C:\myFolder, and contains two rows and two columns. Retrieve the Spreadsheet object of the open spreadsheet in the Safety Analysis Manager.

mySpreadsheet = safetyAnalysisMgr.getOpenDocuments

mySpreadsheet = 

  Spreadsheet with properties:

    FileName: 'C:\myFolder\mySpreadsheet.mldatx'
        Rows: 2
     Columns: 2
 Description: ''

Create, Save, and Close Spreadsheet in Safety Analysis Manager

Create a new spreadsheet in the Safety Analysis Manager.

mySpreadsheet = safetyAnalysisMgr.newSpreadsheet;

Add three rows to the spreadsheet.

addRow(mySpreadsheet,Count=3)

Add a text and check box column to the spreadsheet.

addColumn(mySpreadsheet)
addColumn(mySpreadsheet,Type="checkbox")

Update the column labels.

setColumnLabel(mySpreadsheet,"text column",1);
setColumnLabel(mySpreadsheet,"new text column",2);
setColumnLabel(mySpreadsheet,"checkbox column",3);

Save the spreadsheet with the name myNewSpreadsheet to the current folder.

save(mySpreadsheet,"myNewSpreadsheet.mldatx")

Close the spreadsheet.

close(mySpreadsheet);

Limitations

• The Spreadsheet objects that you use in derived column formulas are read-only.

Version History

Introduced in R2023b

R2024b: Track changes to artifacts linked to spreadsheets in a project

If you have Requirements Toolbox™, identify changes to links or artifacts linked to cells and rows in a spreadsheet contained in a project.

• Use the detectChanges function on the spreadsheet.

• Accept the changes in the spreadsheet by using the acceptAllChanges function.

• Retrieve more information about the changes with the ChangeInformation object. Create ChangeInformation objects by using the getChanges function on the spreadsheet.

R2024b: SpreadsheetRow Support

Retrieve spreadsheet rows by using the getRow function on Spreadsheet objects.