getPosition

R2026b

Class: slmetric.dashboard.CustomWidget
Namespace: slmetric.dashboard

(To be removed) Obtain custom widget position within Metrics Dashboard

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

Num = getPosition(CustomWidget)


Description

Num = getPosition(CustomWidget) returns the position of an slmetric.dashboard.CustomWidget object within an array that holds Metrics Dashboard objects. These objects are in an slmetric.dashboard.Layout, an slmetric.dashboard.Group, or an slmetric.dashboard.Container object. The order of objects in the array corresponds to proceeding from left to right, and then down in the Metrics Dashboard.

Input Arguments

CustomWidget — Metrics Dashboard custom widget

slmetric.dashboard.CustomWidget object

Specify the slmetric.dashboard.CustomWidget object for which you get its position in the array.

Output Arguments

Num — Position of custom widget object

double

Position of slmetric.dashboard.CustomWidget object within an array that holds the Metrics Dashboard objects in an slmetric.dashboard.Layout, an slmetric.dashboard.Group, or an slmetric.dashboard.Container object.

Data Types: double

Version History

Introduced in R2018b

R2022a: Metrics Dashboard will be removed

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.