open

Class: slmetric.dashboard.Configuration
Namespace: slmetric.dashboard

(To be removed) Create slmetric.dashboard.Configuration object associated with XML configuration file in base workspace

The Metrics Dashboard user interface, metricdashboard function, slmetric package API, and corresponding customizations will be removed in a future release. For more information, see Migrating from Metrics Dashboard to Model Maintainability Dashboard.

Syntax

Co = slmetric.dashboard.Configuration.open('FileName','myConfig.xml',... 'Location', pwd,'locale', 'ja_JP')

Description

Reads the contents of the XML file containing the Metrics Dashboard layout into memory and returns the corresponding configuration object. If you modify the contents of the configuration object, invoke the save method to write to the XML file.

Co = slmetric.dashboard.Configuration.open('FileName','myConfig.xml',... 'Location', pwd,'locale', 'ja_JP') reads a configuration file.

Note

If you do not supply an input argument, the slmetric.dashboard.Configuration.open command reads the contents of the default Metrics Dashboard layout XML file into memory and returns the corresponding slmetric.dashboard.Configuration object.

Input Arguments

FileName — Name of XML file

character vector | string scalar

Name of XML file containing custom Metrics Dashboard layout and widgets.

Data Types: char

Location — Folder containing XML file

character vector | string scalar

Name of folder containing XML file that contains Metrics Dashboard layout. This input argument is optional.

Data Types: char

locale — Name of folder containing XML file

character vector | string scalar

Name of folder containing XML file that contains Metrics Dashboard layout. This input argument is optional.

Data Types: char

Output Arguments

Co — Configuration object

character vector | string scalar

Name of slmetric.dashboard.Configuration object that you want to open.

Data Types: char

Examples

Access an Existing Configuration Object

Use the open method to add an existing slmetric.dashboard.Configuration object to the base workspace. As an input, specify the name of the XML file that contains the information in the configuration object. If you modify the information that this configuration object contains, use the save method to save this information to the XML file.

CONF = slmetric.dashboard.Configuration.open('FileName',...
 'myConfig.xml', 'Location', pwd(), 'locale', 'ja_JP'); 

Version History

Introduced in R2018b

R2022a: Metrics Dashboard will be removed

The Metrics Dashboard user interface, metricdashboard function, slmetric package API, and corresponding customizations will be removed in a future release. For more information, see Migrating from Metrics Dashboard to Model Maintainability Dashboard.