RLocusView Properties

Access root locus editor view properties

Since R2025a

RLocusView properties control the appearance and behavior of root locus plots in standalone open-loop editors.

To create an open-loop editor, use the openloopeditor function, which creates an OpenLoopEditor object. When the ViewType property of an OpenLoopEditor object is "rlocus", then the View property is a RLocusView object.

To customize the appearance of the root locus plot, modify the properties of the RLocusView object.

ole = openloopeditor(Plant=sys,ViewType="rlocus");
ole.View.FrequencyUnit = "Hz";

Units

TimeUnit — Time units

"seconds" | "milliseconds" | "minutes" | ...

Time units, specified as one of these values:

• "nanoseconds"

• "microseconds"

• "milliseconds"

• "seconds"

• "minutes"

• "hours"

• "days"

• "weeks"

• "months"

• "years"

Dependencies

By default, the response uses the time units of the plotted linear system. You can override the default units by specifying toolbox preferences. For more information, see Specify Toolbox Preferences for Linear Analysis Plots.

FrequencyUnit — Frequency units

"Hz" | "rad/s" | "rpm" | ...

Frequency units, specified as one of these values:

• "Hz"

• "rad/s"

• "rpm"

• "kHz"

• "MHz"

• "GHz"

• "rad/nanosecond"

• "rad/microsecond"

• "rad/millisecond"

• "rad/minute"

• "rad/hour"

• "rad/day"

• "rad/week"

• "rad/month"

• "rad/year"

• "cycles/nanosecond"

• "cycles/microsecond"

• "cycles/millisecond"

• "cycles/hour"

• "cycles/day"

• "cycles/week"

• "cycles/month"

• "cycles/year"

Dependencies

By default, the response uses the frequency units of the plotted linear system. You can override the default units by specifying toolbox preferences. For more information, see Specify Toolbox Preferences for Linear Analysis Plots.

Title and Axis Labels

Title — Title text and style

AxesLabel object

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

String — Text value

string | character vector

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

To specify a title with multiple lines, concatenate the lines into a single string using newline.

myplot.Title.String = "first line" + newline + "second line";

FontSize — Font size

positive scalar

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.

FontWeight — Character thickness

"bold" | "normal"

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.

FontAngle — Character slant

"normal" | "italic"

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.

FontName — Font name

string | character vector

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.

Color — Text color

[0.1294 0.1294 0.1294] (default) | RGB triplet | hexadecimal color code | color name

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. This table lists these colors and their corresponding RGB triplets and hexadecimal color codes.

Color Name	RGB Triplet	Hexadecimal 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

Interpreter — Text interpreter

"tex" (default) | "latex" | "none"

Text interpreter, specified as one of these values:

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

• "latex" — Interpret characters using LaTeX markup.

• "none" — Display literal characters.

Subtitle — Subtitle text and style

AxesLabel object

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

String — Text value

string | character vector

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

To specify a subtitle with multiple lines, concatenate the lines into a single string using newline.

myplot.Subtitle.String = "first line" + newline + "second line";

FontSize — Font size

positive scalar

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.

FontWeight — Character thickness

"bold" | "normal"

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.

FontAngle — Character slant

"normal" | "italic"

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.

FontName — Font name

string | character vector

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.

Color — Text color

[0.1294 0.1294 0.1294] (default) | RGB triplet | hexadecimal color code | color name

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. This table lists these colors and their corresponding RGB triplets and hexadecimal color codes.

Color Name	RGB Triplet	Hexadecimal 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

Interpreter — Text interpreter

"tex" (default) | "latex" | "none"

Text interpreter, specified as one of these values:

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

• "latex" — Interpret characters using LaTeX markup.

• "none" — Display literal characters.

XLabel — X-axis label text and style

AxesLabel object

X-axis label text and style, specified as an AxesLabel object with these properties.

String — Text value

string | character vector

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

To specify a label with multiple lines, concatenate the lines into a single string using newline.

myplot.XLabel.String = "first line" + newline + "second line";

FontSize — Font size

positive scalar

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.

FontWeight — Character thickness

"bold" | "normal"

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.

FontAngle — Character slant

"normal" | "italic"

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.

FontName — Font name

string | character vector

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.

Color — Text color

[0.1294 0.1294 0.1294] (default) | RGB triplet | hexadecimal color code | color name

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. This table lists these colors and their corresponding RGB triplets and hexadecimal color codes.

Color Name	RGB Triplet	Hexadecimal 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

Interpreter — Text interpreter

"tex" (default) | "latex" | "none"

Text interpreter, specified as one of these values:

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

• "latex" — Interpret characters using LaTeX markup.

• "none" — Display literal characters.

YLabel — Y-axis label text and style

AxesLabel object

Y-axis label text and style, specified as an AxesLabel object with these properties.

String — Text value

string | character vector

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

To specify a label with multiple lines, concatenate the lines into a single string using newline.

myplot.YLabel.String = "first line" + newline + "second line";

FontSize — Font size

positive scalar

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.

FontWeight — Character thickness

"bold" | "normal"

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.

FontAngle — Character slant

"normal" | "italic"

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.

FontName — Font name

string | character vector

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.

Color — Text color

[0.1294 0.1294 0.1294] (default) | RGB triplet | hexadecimal color code | color name

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. This table lists these colors and their corresponding RGB triplets and hexadecimal color codes.

Color Name	RGB Triplet	Hexadecimal 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

Interpreter — Text interpreter

"tex" (default) | "latex" | "none"

Text interpreter, specified as one of these values:

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

• "latex" — Interpret characters using LaTeX markup.

• "none" — Display literal characters.

Axes Limits

XLimits — X-axis limits

two-element vector

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

Dependencies

• When the XLimitsMode property is "auto", the X-axis limits are configured automatically based on the system dynamics.

XLimitsMode — X-axis limit selection mode

"auto" | "manual" | cell array of strings

X-axis limit selection mode, specified as one of these 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 the XLimits property, the XLimitsMode value changes to "manual".

YLimits — Y-axis limits

two-element vector

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

Dependencies

• When the YLimitsMode property is "auto", the Y-axis limits are configured automatically based on the system dynamics.

yLimitsMode — Y-axis limit selection mode

"auto" | "manual" | cell array of strings

Y-axis limit selection mode, specified as one of these 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 YLimits property.

Dependencies

• If you modify the YLimits property, the YLimitsMode value changes to "manual".

Axes Style

AxesStyle — Axes style

AxesStyle object

Axes style, specified as an AxesStyle object with these properties.

BackgroundColor — Axes background color

[1 1 1] (default) | RGB triplet | hexadecimal color code | color name

Axes background 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. This table lists these colors and their corresponding RGB triplets and hexadecimal color codes.

Color Name	RGB Triplet	Hexadecimal 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

Box — Option to display axes outline

"on" | on/off logical value

Option to display axes outline, specified as one of these 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.

BoxLineWidth — Line width of axes outline

0.5 (default) | positive scalar

Line width of axes outline and tick marks, specified as a positive scalar value in point units.

RulerColor — Ruler color

[0.1294 0.1294 0.1294] (default) | RGB triplet | hexadecimal color code | color name

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. This table lists these colors and their corresponding RGB triplets and hexadecimal color codes.

Color Name	RGB Triplet	Hexadecimal 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

FontSize — Font size for tick labels

positive scalar

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

FontWeight — Character thickness for tick labels

"bold" (default) | "normal"

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.

FontAngle — Character slant for tick labels

"normal" (default) | "italic"

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.

FontName — Font name for tick labels

string | character vector

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.

GridVisible — Option to display grid

on/off logical value

Option to display grid, specified as one of these 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.

GridType — Custom grid type

"default" | "s-plane" | "z-plane"

Custom grid type, specified as one of these values:

• "default" — Select the grid type based on the time-domain of the responses being plotted.

  • All responses are for continuous-time systems, use an s-plane grid.

  • All responses are for discrete-time systems, use a z-plane grid.

  • For a mix of continuous-time and discrete-time responses or when there are no responses, use a Cartesian grid.

• "s-plane" — Use an s-plane grid.

• "z-plane" — Use a z-plane grid.

GridColor — Grid color

[0.1294 0.1294 0.1294] (default) | RGB triplet | hexadecimal color code | color name

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. This table lists these colors and their corresponding RGB triplets and hexadecimal color codes.

Color Name	RGB Triplet	Hexadecimal 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

GridLineWidth — Grid line width

0.5 (default) | positive scalar

Grid line width, specified as a positive scalar in point units.

GridLineStyle — Grid line style

"-" | "--" | ":" | "-."

Grid line style, specified as one of these values.

Line Style	Description
"-"	Solid line
"--"	Dashed line
":"	Dotted line
"-."	Dash-dotted line

GridAlpha — Grid line transparency

0.15 (default) | scalar value in range [0,1]

Grid line transparency, specified as a scalar value in the range [0,1], where a smaller value indicates more transparency.

Dependencies

This property is supported for pole-zero plots with a default grid type and a mix of continuous-time and discrete-time responses.

GridFrequencySpec — Natural frequencies for plotting grid lines

[] | vector of positive values

Natural frequencies for plotting s-plane and z-plane grid lines, specified as a vector of positive values.

If you do not specify natural frequencies:

• s-plane grid lines use values based on the axes limits.

• z-plane grid lines use values from 0 to π/T_s in steps of 0.1*π/T_s, where T_s is the sample time specified using GridSampleTime.

the chart

Dependencies

This property is supported for pole-zero plots with a nondefault grid type or with all responses in the same time domain.

GridDampingSpec — Damping ratios for plotting grid lines

[] | vector of values in the range (0,1)

Damping ratios for plotting s-plane and z-plane grid lines, specified as a vector of values greater than 0 and less than 1.

If you do not specify damping ratios:

• s-plane grid lines use values based on the axes limits.

• z-plane grid lines use values from 0 to 1 in increments of 0.1.

Dependencies

This property is supported for pole-zero plots with a nondefault grid type or with all responses in the same time domain.

GridSampleTime — Sample time of z-plane grid

-1 | positive scalar

Sample time (T_s) of z-plane grid, specified as -1 or a positive scalar. The natural-frequency grid lines depend on the value of T_s.

When GridSampleTime is a positive scalar, then the natural-frequency grid line labels display the actual frequency values.

When GridSampleTime is -1:

• If all responses have the same sample time, then the grid sample time matches that sample time and the natural-frequency grid line labels display the actual frequency values.

• If the sample times of the responses differ or are all -1, then the grid line labels display normalized factors of w_n/T_s.

Dependencies

This property is supported for pole-zero plots with a nondefault grid type or with all responses in the same time domain.

GridLabelsVisible — Option to display grid labels

on/off logical value

Option to display grid labels, specified as one of these logical on/off values.

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

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

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

MinorGridVisible — Option to display minor grid lines

on/off logical value

Option to display minor grid lines in plots of MIMO systems, specified as one of these logical on/off values.

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

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

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

Dependencies

• This property is supported for pole-zero plots with a default grid type and a mix of continuous-time and discrete-time responses.

• Minor grid lines are not displayed by default.

MinorGridColor — Minor grid line color

[0.1294 0.1294 0.1294] (default) | RGB triplet | hexadecimal color code | color name

Minor 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. This table lists these colors and their corresponding RGB triplets and hexadecimal color codes.

Color Name	RGB Triplet	Hexadecimal 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

Dependencies

This property is supported for pole-zero plots with a default grid type and a mix of continuous-time and discrete-time responses.

MinorGridLineWidth — Width of minor grid lines

0.5 (default) | positive scalar

Width of minor grid lines, specified as a positive scalar in point units.

Dependencies

This property is supported for pole-zero plots with a default grid type and a mix of continuous-time and discrete-time responses.

MinorGridLineStyle — Minor grid line style

"-" | "--" | ":" | "-."

Minor grid line style, specified as one of these values.

Line Style	Description
"-"	Solid line
"--"	Dashed line
":"	Dotted line
"-."	Dash-dotted line

Dependencies

This property is supported for pole-zero plots with a default grid type and a mix of continuous-time and discrete-time responses.

MinorGridAlpha — Minor grid line transparency

0.15 (default) | scalar value in range [0,1]

Minor grid line transparency, specified as a scalar value in the range [0,1], where a smaller value indicates more transparency.

Dependencies

This property is supported for pole-zero plots with a default grid type and a mix of continuous-time and discrete-time responses.

Version History

Introduced in R2025a