ImpulsePlot Properties

Access impulse plot properties

Since R2024b

expand all in page

ImpulsePlot properties control the appearance and behavior of impulse plots created using the impulseplot function. By changing property values, you can modify certain aspects of the plot.

ip = impulseplot(sys);
ip.TransientTime.Visible = "on";

Response

expand all

Model responses, specified as an ImpulseResponse 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 ImpulseResponse object has these properties.

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

Dynamic system, specified as a SISO or MIMO dynamic system model or an array of dynamic system models.

When you initially create a plot, Model matches the value you specify for sys.

Time steps at which to compute the response, specified as one of these values:

  • Positive scalar tFinal— Compute the response from t = 0 to t = tFinal.

  • Two-element vector [t0 tFinal] — Compute the response from t = t0 to t = tFinal. (since R2023b)

  • Vector Ti:dt:Tf— Compute the response for the time points specified in t.

    • For continuous-time systems, dt is the sample time of a discrete approximation to the continuous system.

    • For discrete-time systems with a specified sample time, dt must match the sample time property Ts of sys.

    • For discrete-time systems with an unspecified sample time (Ts = -1), dt must be 1.

  • [] — Automatically select time values based on system dynamics.

When you specify a time range using either tFinal or [t0 tFinal]:

  • For continuous-time systems, the function automatically determines the size of the time step and number of points based on the system dynamics.

  • For discrete-time systems with a specified sample time, the function uses the sample time of sys as the step size.

  • For discrete-time systems with unspecified sample time (Ts = -1), the function interprets tFinal as the number of sampling periods to simulate with a sample time of 1 second.

Express t using the time units specified in the TimeUnit property of sys.

If you specify a step delay td using config, the function applies the step at t = t0+td.

Response configuration options, specified as a RespConfig object.

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

Response visibility, specified as one of these 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 the response in the legend, specified as one of these 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.

Marker style, specified as one of these values.

MarkerDescription
"none"No marker
"o"Circle
"+"Plus sign
"*"Asterisk
"."Point
"x"Cross
"_"Horizontal line
"|"Vertical line
"s"Square
"d"Diamond
"^"Upward-pointing triangle
"v"Downward-pointing triangle
">"Right-pointing triangle
"<"Left-pointing triangle
"p"Pentagram
"h"Hexagram

Plot 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 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

Line style, specified as one of these values.

Line StyleDescription
"-"Solid line
"--"Dashed line
":"Dotted line
"-."Dash-dotted line

Marker size, specified as a positive scalar.

Line width, specified as a positive scalar.

Response characteristics to display in the plot, specified as a CharacteristicsManager object with these properties.

For more information on how the peak response and transient time are computed, see lsiminfo.

For more information about confidence regions for identified models, see showConfidence (System Identification Toolbox).

Peak response, specified as a CharacteristicOption object with this property.

Peak response visibility, specified as one of these logical on/off values:

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

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

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

Transient time, specified as a CharacteristicOption object with these properties.

Threshold for detecting steady state, specified as a scalar value between 0 and 1. For example, to measure when the response remains with 5% of the steady-state value, set a threshold value of 0.05.

Transient time visibility, specified as one of these logical on/off values:

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

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

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

Confidence region for identified models, specified as a CharacteristicOption object with these properties.

Confidence region visibility, specified as one of these logical on/off values:

  • "on", 1, or true — Display the confidence region.

  • "off", 0, or false — Do not display the confidence region.

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

Number of standard deviations to display for the confidence region, specified as a positive scalar.

Dependencies

ConfidenceRegion is supported only for identified models, which require System Identification Toolbox™ software.

Option to normalize plot, specified as one of these logical on/off values:

  • "on", 1, or true — Normalize the plot.

  • "off", 0, or false — Do not normalize the plot.

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

Units

expand all

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.

Inputs and Outputs

expand all

Input label text and style, specified as an AxesLabel object or an array of such objects. Each AxesLabel object has these 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. This 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 these values:

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

  • "latex" — Interpret characters using LaTeX markup.

  • "none" — Display literal characters.

Output label text and style, specified as an AxesLabel object or an array of such objects. Each AxesLabel object has these 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. This 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 these values:

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

  • "latex" — Interpret characters using LaTeX markup.

  • "none" — Display literal characters.

Option to display inputs, specified as one of these logical on/off values or an array of such values:

  • "on", 1, or true — Display the corresponding input.

  • "off", 0, or false — Hide the corresponding input.

InputVisible is an array when the plotted system has multiple inputs. By default, all inputs are visible in the plot.

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

Option to display outputs, specified as one of these logical on/off values or an array of such values:

  • "on", 1, or true — Display the corresponding output.

  • "off", 0, or false — Hide the corresponding output.

OutputVisible is an array when the plotted system has multiple outputs. By default, all outputs are visible in the plot.

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

Grouping of inputs and outputs pairs, specified as one of these values:

  • "none" — Do not group inputs or outputs.

  • "inputs" — Group only inputs.

  • "outputs" — Group only outputs.

  • "all" — Group all input-output pairs.

Title and Axis Labels

expand all

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

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";

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. This 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 these values:

  • "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 these properties.

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";

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. This 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 these values:

  • "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 these properties.

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";

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. This 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 these values:

  • "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 these properties.

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";

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. This 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 these values:

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

  • "latex" — Interpret characters using LaTeX markup.

  • "none" — Display literal characters.

Axes Limits

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.

If XLimitsSharing is:

  • "all", then XLimits is a two-element vector that specifies the X-axis limits for all visible axes in the chart.

  • "column", then XLimits is a cell array, where each element specifies the X-axis limits for one visible column of axes in the chart.

  • "none", then XLimits is a cell array, where each element specifies the X-axis limits for one visible axes in the chart.

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. For example, when an entry in InputVisible is off, the corresponding limits are removed from XLimits.

X-axis limit selection mode, specified as one of these 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

  • The dimensions of XLimitsMode match the dimensions of XLimits.

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

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

X-axis limit sharing, specified as one of these strings.

  • "all" — All axes use the same X-axis limits.

  • "column" — All axes in the same input column use the same X-axis limits.

  • "none" — Each axes uses its own X-axis limits.

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.

If YLimitsSharing is:

  • "all", then YLimits is a two-element vector that specifies the Y-axis limits for all visible axes in the chart.

  • "row", then YLimits is a cell array, where each element specifies the Y-axis limits for one visible row of axes in the chart.

  • "none", then YLimits is a cell array, where each element specifies the Y-axis limits for one visible axes in the chart.

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. For example, when an entry in OutputVisible is off, the corresponding limits are removed from YLimits.

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

Dependencies

  • The dimensions of YLimitsMode match the dimensions of YLimits.

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

  • YLimitsMode contains selection modes only for visible outputs. For example, when an entry in OutputVisible is off, the corresponding selection modes are removed from YLimitsMode.

Y-axis limit sharing, specified as one of these strings.

  • "all" — All axes use the same Y-axis limits.

  • "row" — All axes in the same output row use the same Y-axis limits.

  • "none" — Each axes uses its own Y-axis limits.

Axes Style

expand all

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

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 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 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.

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

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 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

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.

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

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

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

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. This 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

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

Grid line style, specified as one of these values.

Line StyleDescription
"-"Solid line
"--"Dashed line
":"Dotted line
"-."Dash-dotted line

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

Option to display minor grid lines, 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

Minor grid lines are not displayed by default.

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 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

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

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

Line StyleDescription
"-"Solid line
"--"Dashed line
":"Dotted line
"-."Dash-dotted line

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

Since R2025a

Active data axes for hold workflows on MIMO linear analysis plots or a SISO Bode plots, specified as a two-element vector of integers indicating the row and column of the active axes. When you first create a chart, the bottom right axes is active. If you reduce the number of visible axes, the active axes automatically updates to a visible axes if necessary.

The DataAxes property affects only hold workflows that do not include adding new responses.

Legend

expand all

Legend axes selection mode, specified as one of these 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 these 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 these 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 these values:

  • "vertical" — Stack items vertically.

  • "horizontal" — Stack items horizontally.

Complex Systems

expand all

Since R2025a

View for responses of complex systems, specified as one of these values:

  • "realimaginary" — Plot both the real and imaginary components of each response on the same axes with a diamond marker indicating the imaginary component.

  • "magnitudephase" — Plot both the magnitude and phase of each response on a single axes with two y-axes. A diamond marker indicates the phase response.

  • "complexplane" — Plot each response as a single trajectory in the complex plane, with an arrow indicating the progression of time.

Since R2025a

Option to display the real component of responses for complex systems, specified as one of these logical on/off values:

  • "on", 1, or true — Display the real component.

  • "off", 0, or false — Hide the real component.

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

Dependencies

  • This property applies only when ComplexViewType is "realimaginary".

  • This property is ignored for purely real systems.

Since R2025a

Option to display the imaginary component of responses for complex systems, specified as one of these logical on/off values:

  • "on", 1, or true — Display the imaginary component.

  • "off", 0, or false — Hide the imaginary component.

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

Dependencies

  • This property applies only when ComplexViewType is "realimaginary".

  • This property is ignored for purely real systems.

Chart Layout

expand all

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

  • Figure

  • TiledChartLayout

  • UIFigure

  • UIGridLayout

  • UIPanel

  • UITab

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

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

  • "off", 0, or false — Hide the chart without deleting it. You can still 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 these 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'

On Windows® and Macintosh systems, the size of a pixel is 1/96th of an inch. This size is independent of your system resolution.

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 these 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 these 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

expand all

See Also

|

Topics