addWidget

R2026b

Class: slmetric.dashboard.Layout
Namespace: slmetric.dashboard

(To be removed) Add widget to slmetric.dashboard.Layout object

expand all in page

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

newWidget = addWidget(dashboardLayout,widgetType,num)

Description

newWidget = addWidget(dashboardLayout,widgetType,num) adds a widget to an slmetric.dashboard.Layout object.

Input Arguments

expand all

slmetric.dashboard.Layout object for which you want to add widgets to customize Metrics Dashboard layout.

Specify the Type property of an slmetric.dashboard.Container, slmetric.dashboard.Widget, slmetric.dashboard.Group, or slmetric.dashboard.CustomWidget object.

Data Types: char

Placement of widget on Metrics Dashboard. Order of widgets proceeds from left to right, and then down.

Output Arguments

expand all

New widget that you are adding to Metrics Dashboard. Choose from one of these widgets:

  • slmetric.dashboard.Group

  • slmetric.dashboard.Container

  • slmetric.dashboard.Widget

  • slmetric.dashboard.Custom

Examples

expand all

You can use the Metrics Dashboard and metric APIs to obtain compliance and issues metric data on your Model Advisor configuration. To set up your Model Advisor configuration, see Use Model Advisor Configuration Editor to Customize Model Advisor. You can also use an existing check group such as the MISRA checks. After you have set up your Model Advisor configuration, follow these steps to specify the check groups for which you want to obtain compliance and issues metric data:

Open the model vdp by entering:

openExample('simulink_general/VanDerPolOscillatorExample')

Open the default configuration:

config=slmetric.config.Configuration.open()

Specify a metric family ID that you associate with those check groups:

famParamID = 'ModelAdvisorStandard';

Create a cell array consisting of the Check Group IDs that correspond to the check groups. Obtain a Check Group ID by opening up the Model Advisor Configuration Editor and selecting the folder that contains the group of checks. The folder contains a Check Group ID parameter.

values = {'maab', 'hisl_do178', '_SYSTEM_By Task_misra_c'};

The previous cell array specifies MAB, High-Integrity, and MISRA check groups. The values maab and hisl_do178 correspond to a subset of MAB and High-Integrity System checks. To include all checks, specify the value for the Check Group ID parameter from the Model Advisor Configuration Editor.

To set up the configuration, pass the values cell array into the setMetricFamilyParameterValues method.

setMetricFamilyParameterValues(config, famParamID, values);

Point the High Integrity Compliance and High Integrity Check Issues widgets to the MISRA check group. To begin, open the default configuration for the Metrics Dashboard layout.

conf = slmetric.dashboard.Configuration.open();

Obtain the slmetric.dashboard.Layout object from the slmetric.dashboard.Configuration object conf.

layout = getDashboardLayout(conf);

Obtain the widget objects that are in the layout object.

layoutWidget = getWidgets(layout);

Obtain the compliance group from the layout. This group contains two containers. The first container contains the High Integrity and MAB Compliance and Check Issues widgets. Remove the High Integrity Compliance widget.

complianceGroup = layoutWidget(3);
complianceContainers = getWidgets(complianceGroup);
complianceContainerWidgets = getWidgets(complianceContainers(1));
complianceContainers(1).removeWidget(complianceContainerWidgets(1)); 
setMetricIDs(complianceContainerWidgets(1),...
({'mathworks.metrics.ModelAdvisorCompliance._SYSTEM_By Task_misra_c'}));
complianceContainerWidgets(1).Labels = {'MISRA'};

Add a custom widget for visualizing MISRA check issues metrics to the complianceContainers slmetric.dashboard.Container object.

misraWidget = complianceContainers(1).addWidget('Custom',1); 
misraWidget.Title = ('MISRA'); 
misraWidget.VisualizationType = 'RadialGauge'; 
misraWidget.setMetricIDs('mathworks.metrics.ModelAdvisorCheckCompliance._SYSTEM_By Task_misra_c'); 
misraWidget.setWidths(slmetric.dashboard.Width.Medium);

Save the configuration objects. These commands serialize the API information to XML files.

save(config,'FileName','MetricConfig.xml');
save(conf,'Filename','DashboardConfig.xml');

Set the active configurations.

slmetric.config.setActiveConfiguration(fullfile(pwd,'MetricConfig.xml'));
slmetric.dashboard.setActiveConfiguration(fullfile(pwd,'DashboardConfig.xml'));

Open the Metrics Dashboard for the model vdp.

metricsdashboard vdp

Click the All Metrics button to run all metrics.

Version History

Introduced in R2018b

collapse all

See Also

|

Topics