slmetric.dashboard.getActiveConfiguration

R2026b

Namespace: slmetric.dashboard

(To be removed) Obtain file path and name of XML file containing active Metrics Dashboard layout

The Metrics Dashboard app, model metrics, slmetric API, and corresponding customizations will be removed in a future release. For more information, see Migrating from Metrics Dashboard to Model Design Dashboards.

Syntax

Path = slmetric.dashboard.getActiveConfiguration

Description

Path = slmetric.dashboard.getActiveConfiguration returns the file path and name of the active Metrics Dashboard layout XML file. This file contains information on the location, size, and types of widgets in the Metrics Dashboard.

Examples

Get Default Metrics Dashboard Layout

At the MATLAB command line, enter this command to get the active metric dashboard layout:

slmetric.dashboard.getActiveConfiguration(); 

Output Arguments

Path — File path to XML file

character vector | string scalar

Full file path to folder containing XML file that contains the active Metrics Dashboard layout.

Note

Passing an empty string to the slmetric.dashboard.setActionConfiguration function (that is, slmetric.dasbhoard.setActiveConfiguration('')), resets the configuration to the default, which is the shipping configuration. If you then enter the slmetric.dashboard.getActiveConfiguration method, the method returns an empty array.

Data Types: char

Version History

Introduced in R2018b

R2022a: Warns

The Metrics Dashboard app, model metrics, slmetric API, and corresponding customizations will be removed in a future release. For more information, see Migrating from Metrics Dashboard to Model Design Dashboards.