Main Content

HSVPlot Properties

Access Hankel singular value plot properties

Since R2024b

expand all in page

HSVPlot properties control the appearance and behavior of Hankel singular value (HSV) plots created using view (balanced), view (ncf), or view (pod). By changing property values, you can modify certain aspects of the plot.

R = reducespec(sys,"balanced");
hsvp = view(R)
hsvp.YScale = "linear";

For more information, see Customize Linear Analysis Plots at Command Line.

Response

expand all

Model responses, specified as an HSVResponse object or an array of such objects. Use this property to modify the dynamic system model or appearance for each response in the plot. Each HSVResponse object has the following fields.

Source data for the response, specified as a structure with the following fields.

Model order reduction specification, specified as a BalancedTruncation, NCFBalancedTruncation, or SparseBalancedTruncation, or ProperOrthogonalDecomposition object.

Plot type, specified as one of the following.

  • "sigma" — Bar chart of Hankel singular values and associated error bound

  • "energy" — Bar chart of normalized energies

Response name, specified as a string or character vector and stored as a string.

Response visibility, specified as one of the following logical on/off values:

  • "on", 1, or true — Display the response in the plot.

  • "off", 0, or false — Do not display the response in the plot.

The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

Option to list response in legend, specified as one of the following logical on/off values:

  • "on", 1, or true — List the response in the legend.

  • "off", 0, or false — Do not list the response in the legend.

The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

Response characteristics, specified as []. HSV plots have no characteristics to display.

Scaling

expand all

Scale for Y-axis, specified as either 'log' or 'linear'.

Title and Axis Labels

expand all

Title text and style, specified as an AxesLabel object with the following properties.

Text value, specified as a string or character vector and stored as a string.

Font size in point units, specified as positive scalar. One point equals 1/72 inch.

Dependencies

The default font size depends on the toolbox preferences. For more information, see Specify Toolbox Preferences for Linear Analysis Plots.

Character thickness, specified as "bold" or "normal".

Not all fonts have a bold weight. Therefore, the bold font might look the same as the normal font.

Dependencies

The default font weight depends on the toolbox preferences. For more information, see Specify Toolbox Preferences for Linear Analysis Plots.

Character slant, specified as "normal" or "italic".

Not all fonts have an italic font styles. Therefore, the italic font might look the same as the normal font.

Dependencies

The default font angle depends on the toolbox preferences. For more information, see Specify Toolbox Preferences for Linear Analysis Plots.

Font name, specified as a string or character vector containing the name of a system-supported font name. The default font depends on the specific operating system and locale. To view a list of available system fonts, use listfonts.

Text color, specified as an RGB triplet or a hexadecimal color code and stored as an RGB triplet.

Alternatively, you can specify some common colors by name. The following table lists these colors and their corresponding RGB triplets and hexadecimal color codes.

Color NameRGB TripletHexadecimal Color Code

"red" or "r"

[1 0 0]#FF0000

"green" or "g"

[0 1 0]#00FF00

"blue" or "b"

[0 0 1]#0000FF

"cyan" or "c"

[0 1 1]#00FFFF

"magenta" or "m"

[1 0 1]#FF00FF

"yellow" or "y"

[1 1 0]#FFFF00

"black" or "k"

[0 0 0]#000000

"white" or "w"

[1 1 1]#FFFFFF

Text interpreter, specified as one of the following:

  • "tex" — Interpret characters using a subset of TeX markup.

  • "latex" — Interpret characters using LaTeX markup.

  • "none" — Display literal characters.

Subtitle text and style, specified as an AxesLabel object with the following properties.

Text value, specified as a string or character vector and stored as a string.

Font size in point units, specified as positive scalar. One point equals 1/72 inch.

Dependencies

The default font size depends on the toolbox preferences. For more information, see Specify Toolbox Preferences for Linear Analysis Plots.

Character thickness, specified as "bold" or "normal".

Not all fonts have a bold weight. Therefore, the bold font might look the same as the normal font.

Dependencies

The default font weight depends on the toolbox preferences. For more information, see Specify Toolbox Preferences for Linear Analysis Plots.

Character slant, specified as "normal" or "italic".

Not all fonts have an italic font styles. Therefore, the italic font might look the same as the normal font.

Dependencies

The default font angle depends on the toolbox preferences. For more information, see Specify Toolbox Preferences for Linear Analysis Plots.

Font name, specified as a string or character vector containing the name of a system-supported font name. The default font depends on the specific operating system and locale. To view a list of available system fonts, use listfonts.

Text color, specified as an RGB triplet or a hexadecimal color code and stored as an RGB triplet.

Alternatively, you can specify some common colors by name. The following table lists these colors and their corresponding RGB triplets and hexadecimal color codes.

Color NameRGB TripletHexadecimal Color Code

"red" or "r"

[1 0 0]#FF0000

"green" or "g"

[0 1 0]#00FF00

"blue" or "b"

[0 0 1]#0000FF

"cyan" or "c"

[0 1 1]#00FFFF

"magenta" or "m"

[1 0 1]#FF00FF

"yellow" or "y"

[1 1 0]#FFFF00

"black" or "k"

[0 0 0]#000000

"white" or "w"

[1 1 1]#FFFFFF

Text interpreter, specified as one of the following:

  • "tex" — Interpret characters using a subset of TeX markup.

  • "latex" — Interpret characters using LaTeX markup.

  • "none" — Display literal characters.

X-axis label text and style, specified as an AxesLabel object with the following fields.

Text value, specified as a string or character vector and stored as a string.

Font size in point units, specified as positive scalar. One point equals 1/72 inch.

Dependencies

The default font size depends on the toolbox preferences. For more information, see Specify Toolbox Preferences for Linear Analysis Plots.

Character thickness, specified as "bold" or "normal".

Not all fonts have a bold weight. Therefore, the bold font might look the same as the normal font.

Dependencies

The default font weight depends on the toolbox preferences. For more information, see Specify Toolbox Preferences for Linear Analysis Plots.

Character slant, specified as "normal" or "italic".

Not all fonts have an italic font styles. Therefore, the italic font might look the same as the normal font.

Dependencies

The default font angle depends on the toolbox preferences. For more information, see Specify Toolbox Preferences for Linear Analysis Plots.

Font name, specified as a string or character vector containing the name of a system-supported font name. The default font depends on the specific operating system and locale. To view a list of available system fonts, use listfonts.

Text color, specified as an RGB triplet or a hexadecimal color code and stored as an RGB triplet.

Alternatively, you can specify some common colors by name. The following table lists these colors and their corresponding RGB triplets and hexadecimal color codes.

Color NameRGB TripletHexadecimal Color Code

"red" or "r"

[1 0 0]#FF0000

"green" or "g"

[0 1 0]#00FF00

"blue" or "b"

[0 0 1]#0000FF

"cyan" or "c"

[0 1 1]#00FFFF

"magenta" or "m"

[1 0 1]#FF00FF

"yellow" or "y"

[1 1 0]#FFFF00

"black" or "k"

[0 0 0]#000000

"white" or "w"

[1 1 1]#FFFFFF

Text interpreter, specified as one of the following:

  • "tex" — Interpret characters using a subset of TeX markup.

  • "latex" — Interpret characters using LaTeX markup.

  • "none" — Display literal characters.

Y-axis label text and style, specified as an AxesLabel object with the following fields.

Text value, specified as a string or character vector and stored as a string.

Font size in point units, specified as positive scalar. One point equals 1/72 inch.

Dependencies

The default font size depends on the toolbox preferences. For more information, see Specify Toolbox Preferences for Linear Analysis Plots.

Character thickness, specified as "bold" or "normal".

Not all fonts have a bold weight. Therefore, the bold font might look the same as the normal font.

Dependencies

The default font weight depends on the toolbox preferences. For more information, see Specify Toolbox Preferences for Linear Analysis Plots.

Character slant, specified as "normal" or "italic".

Not all fonts have an italic font styles. Therefore, the italic font might look the same as the normal font.

Dependencies

The default font angle depends on the toolbox preferences. For more information, see Specify Toolbox Preferences for Linear Analysis Plots.

Font name, specified as a string or character vector containing the name of a system-supported font name. The default font depends on the specific operating system and locale. To view a list of available system fonts, use listfonts.

Text color, specified as an RGB triplet or a hexadecimal color code and stored as an RGB triplet.

Alternatively, you can specify some common colors by name. The following table lists these colors and their corresponding RGB triplets and hexadecimal color codes.

Color NameRGB TripletHexadecimal Color Code

"red" or "r"

[1 0 0]#FF0000

"green" or "g"

[0 1 0]#00FF00

"blue" or "b"

[0 0 1]#0000FF

"cyan" or "c"

[0 1 1]#00FFFF

"magenta" or "m"

[1 0 1]#FF00FF

"yellow" or "y"

[1 1 0]#FFFF00

"black" or "k"

[0 0 0]#000000

"white" or "w"

[1 1 1]#FFFFFF

Text interpreter, specified as one of the following:

  • "tex" — Interpret characters using a subset of TeX markup.

  • "latex" — Interpret characters using LaTeX markup.

  • "none" — Display literal characters.

Axes Limits and Style

expand all

X-axis limits, specified as a two-element vector of the form [min,max] or a cell array of such vectors, where min is the minimum axis limit and max is the maximum axis limit.

Dependencies

  • When an entry in the XLimitsMode property is "auto", the corresponding x-axis limits are configured automatically based on the system dynamics.

  • XLimits contains limits only for visible inputs. When an entry in InputVisible is off, then the corresponding limits are removed from XLimits.

X-axis limit selection mode, specified as one of the following strings or a cell array of such strings.

  • "auto" — Enable automatic limit selection, which is based on the total span of the plotted data.

  • "manual" — Manually specify the axis limits by setting the XLimits property.

Dependencies

  • If you modify an entry in the XLimits property, the corresponding XLimitsMode value changes to "manual".

  • XLimitsMode contains selection modes only for visible inputs. When an entry in InputVisible is off, then the corresponding selection modes are removed from XLimitsMode.

Y-axis limits, specified as a two-element vector of the form [min,max] or a cell array of such vectors, where min is the minimum axis limit and max is the maximum axis limit.

Dependencies

  • When an entry in the YLimits property is "auto", the corresponding y-axis limits are configured automatically based on the system dynamics.

  • YLimits contains limits only for visible outputs. When an entry in OutputVisible is off, then the corresponding limits are removed from YLimits.

Y-axis limit selection mode, specified as one of the following values:

  • "auto" — Enable automatic limit selection, which is based on the total span of the plotted data.

  • "manual" — Manually specify the axis limits by setting the YLimits property.

Dependencies

  • If you modify an entry in the YLimits property, the corresponding YLimitsMode value changes to "manual".

  • YLimitsMode contains selection modes only for visible inputs. When an entry in OutputVisible is off, then the corresponding selection modes are removed from YLimitsMode.

Axes style, specified as an AxesStyle object with the following properties.

Option to display axes outline, specified as one of the following logical on/off values.

  • "on", 1, or true — Display outline.

  • "off", 0, or false — Hide outline.

The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

Font size for tick labels in point units, specified as positive scalar. One point equals 1/72 inch.

Character thickness for tick labels, specified as "bold" or "normal".

Not all fonts have a bold weight. Therefore, the bold font might look the same as the normal font.

Character slant for tick labels, specified as "normal" or "italic".

Not all fonts have an italic font styles. Therefore, the italic font might look the same as the normal font.

Font name for tick labels, specified as a string or character vector containing the name of a system-supported font name. The default font depends on the specific operating system and locale. To view a list of available system fonts, use listfonts.

Ruler color, specified as an RGB triplet or a hexadecimal color code and stored as an RGB triplet. The ruler color affects axes lines, tick marks, and tick labels.

Alternatively, you can specify some common colors by name. The following table lists these colors and their corresponding RGB triplets and hexadecimal color codes.

Color NameRGB TripletHexadecimal Color Code

"red" or "r"

[1 0 0]#FF0000

"green" or "g"

[0 1 0]#00FF00

"blue" or "b"

[0 0 1]#0000FF

"cyan" or "c"

[0 1 1]#00FFFF

"magenta" or "m"

[1 0 1]#FF00FF

"yellow" or "y"

[1 1 0]#FFFF00

"black" or "k"

[0 0 0]#000000

"white" or "w"

[1 1 1]#FFFFFF

Option to display grid, specified as one of the following logical on/off values.

  • "on", 1, or true — Display grid.

  • "off", 0, or false — Hide grid.

The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

Dependencies

The default grid visibility depends on the toolbox preferences. For more information, see Specify Toolbox Preferences for Linear Analysis Plots.

Grid color, specified as an RGB triplet or a hexadecimal color code and stored as an RGB triplet.

Alternatively, you can specify some common colors by name. The following table lists these colors and their corresponding RGB triplets and hexadecimal color codes.

Color NameRGB TripletHexadecimal Color Code

"red" or "r"

[1 0 0]#FF0000

"green" or "g"

[0 1 0]#00FF00

"blue" or "b"

[0 0 1]#0000FF

"cyan" or "c"

[0 1 1]#00FFFF

"magenta" or "m"

[1 0 1]#FF00FF

"yellow" or "y"

[1 1 0]#FFFF00

"black" or "k"

[0 0 0]#000000

"white" or "w"

[1 1 1]#FFFFFF

Grid line width, specified as a positive scalar.

Legend

expand all

Legend axes selection mode, specified as one of the following values:

  • "auto" — Show the legend in the northeast visible axes.

  • "manual" — Show the legend in the axes indicated by the LegendAxes property.

Legend axes, specified as a two element vector of integers indicating the row and column of the axes in which to display the legend.

Dependencies

When LegendAxesMode is "auto", LegendAxes contains the row and column of the northeast visible axis.

Option to display the legend, specified as one of the following logical on/off values:

  • "on", 1, or true — Display the legend.

  • "off", 0, or false — Hide the legend.

The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

Legend location within the axes, specified as one of the following values:

  • "northeast" — Top-right corner

  • "northwest" — Top-left corner

  • "southeast" — Bottom-left corner

  • "southwest" — Bottom-right corner

  • "north" — Top

  • "south" — Bottom

  • "east" — Right side

  • "west" — Left side

  • "best" — Location where the least conflict occurs with the plot data at the time that you create the legend. If the plot data changes, you might need to reset the location to "best".

Orientation for stacking legend items, specified as one of the following values:

  • "vertical" — Stack items vertically.

  • "horizontal" — Stack items horizontally.

Chart Layout

expand all

Parent container of the chart, specified as one of the following objects:

  • Figure

  • TiledChartLayout

  • UIFigure

  • UIGridLayout

  • UIPanel

  • UITab

Chart visibility, specified as one of the following logical on/off values:

  • "on", 1, or true — Display the chart.

  • "off", 0, or false — Hide the chart without deleting it. You still can access the properties of chart when it is not visible.

The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

Visibility of the chart object handle in the list of children for its parent, specified as one of the following values:

  • 'on' — Chart object handle is always visible.

  • 'off' — Chart object handle is invisible at all times. This option is useful for preventing unintended changes to the chart by another function. To temporarily hide the handle during the execution of that function, set the HandleVisibility to 'off'.

  • 'callback' — Chart object handle is visible from within callbacks or functions invoked by callbacks, but not from within functions invoked from the command line. This option blocks access to the object in the Command Window, but it allows callback functions to access it.

Position units, specified as a value from the following table. To change the position of the chart in specific units, set the Units property before specifying the Position property. If you specify the Units and Position properties in a single command (using name-value pairs), be sure to specify Units before Position.

UnitsDescription
'normalized'Normalized with respect to the parent container, which is typically the figure, panel, or tab. The lower left corner of the container maps to (0,0), and the upper right corner maps to (1,1).
'inches'Inches
'centimeters'Centimeters
'characters'

Based on the default font of the graphics root object:

  • Character width = width of letter x.

  • Character height = distance between the baselines of two lines of text.

'points'Typography points. One point equals 1/72 inch.
'pixels'

Distances in pixels are independent of your system resolution on Windows® and Macintosh systems:

  • On Windows systems, a pixel is 1/96th of an inch.

  • On Macintosh systems, a pixel is 1/72nd of an inch.

On Linux® systems, the size of a pixel is determined by your system resolution.

Chart size and location, including the margins for decorations such as axis labels and tick marks. Specify this property as a vector of form [left bottom width height]. The values are in the units specified by the Units property.

  • left — Distance from the left edge of the parent container to the outer-left edge of the chart that includes the margins. Typically, the parent container is a figure, panel, or tab.

  • bottom — Distance from the bottom edge of the parent container to the outer-bottom edge of the chart that includes the margins.

  • width — Width of chart, including the margins.

  • height — Height of chart, including the margins.

Note

Setting this property has no effect when the parent of the chart is a TiledChartLayout.

Chart size and location, excluding the margins for decorations such as axis labels and tick marks. Specify this property as a vector of form [left bottom width height]. The values are in the units specified by the Units property.

  • left — Distance from the left edge of the parent container to the inner-left edge of the chart that excludes the margins. Typically, the parent container is a figure, panel, or tab.

  • bottom — Distance from the bottom edge of the parent container to the inner-bottom edge of the chart that excludes the margins.

  • width — Width of the chart, excluding the margins.

  • height — Height of the chart, excluding the margins.

Note

Setting this property has no effect when the parent of the chart is a TiledChartLayout.

Chart size and location, excluding the margins for decorations such as axis labels and tick marks. Specify this property as a vector of form [left bottom width height]. This property is equivalent to the InnerPosition property.

Note

Setting this property has no effect when the parent of the chart is a TiledChartLayout.

Position property to hold constant when adding, removing, or changing decorations, specified as one of the following values:

  • 'outerposition' — The OuterPosition property remains constant when you add, remove, or change decorations such as a title or an axis label. If any positional adjustments are needed, MATLAB® adjusts the InnerPosition property.

  • 'innerposition' — The InnerPosition property remains constant when you add, remove, or change decorations such as a title or an axis label. If any positional adjustments are needed, MATLAB adjusts the OuterPosition property.

Note

Setting this property has no effect when the parent of the chart is a TiledChartLayout.

Layout options, specified as a TiledChartLayoutOptions object or GridLayoutOptions object. This property specifies options when an instance of your chart is a child of a tiled chart layout or gridded layout. If the instance is not a child of one of these layouts (for example, it is a child of a figure or panel), then this property is empty and has no effect. Otherwise, you can position the chart within the layout by configuring the layout options.

This code places chart object c into the third tile of a tiled chart layout and makes the chart span 2 rows and 3 columns.

c.Layout.Tile = 3;
c.Layout.TileSpan = [2 3];

This code places chart object c into row 2 of a gridded layout and makes the chart span columns 3 and 4.

c.Layout.Row = 2;
c.Layout.Column = [3 4];

Properties to reset when adding a new plot to the chart, specified as one of the following values:

  • 'add' — Add new plots to the existing chart. Do not delete existing plots or reset axes properties before displaying the new plot.

  • 'replace' — Delete existing plots and reset chart properties, except Position and Units, to their default values before displaying the new plot.

Tips

You can also interactively modify response plot properties using the:

Version History

Introduced in R2024b

See Also

| |

Topics