getWidths

Class: slmetric.dashboard.Widget
Package: slmetric.dashboard

Obtain widths of Metrics Dashboard widget

Syntax

Widths=getWidths(widgetName)

Description

Widths=getWidths(widgetName) returns an slmetric.dashboard.Width object array consisting of four enumerations. Use the slmetric.dashboard.Widgets.setWidths method to set the width sizes. You can set between one and four sizes. If you set just one size, the array contains four of the same enumerations. These are the possible enumeration values:

• slmetric.dashboard.Width.ExtraSmall

• slmetric.dashboard.Width.Small

• slmetric.dashboard.Width.Medium

• slmetric.dashboard.Width.Large

• slmetric.dashboard.Width.XLarge

• slmetric.dashboard.Width.XXLarge

These values correspond to the sizes that a widget can have as the screen size changes. If the widget has one value, the widget always has the same size regardless of the screen size. If the widget has four different values, the widget size can change four times as you maximize and minimize the screen.

Input Arguments

widgetName — Metrics Dashboard widget

slmetric.dashboard.Widget object

Widget for which you want to obtain widths.

Data Types: char

Output Arguments

Widths — Widget widths

slmetric.dashboard.Width enumeration array

slmetric.dashboard.Width enumeration array consisting of between one and four of these values:

• slmetric.dashboard.Width.ExtraSmall

• slmetric.dashboard.Width.Small

• slmetric.dashboard.Width.Medium

• slmetric.dashboard.Width.Large

• slmetric.dashboard.Width.XLarge

• slmetric.dashboard.Width.XXLarge

Version History

Introduced in R2018b