InitialPlot Properties
InitialPlot
properties control the appearance and behavior of
initial condition plots created using initialplot
. By changing property values, you can modify certain aspects of the
plot.
ip = initialplot(sys);
ip.TransientTime.Visible = "on";
Response
Responses
— Model responses
InitialResponse
object | array of InitialResponse
objects
Model responses, specified as an InitialResponse
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 InitialResponse
object has the following fields.
SourceData
— Source data
structure
Source data for the response, specified as a structure with the following fields.
Model
— Dynamic system
dynamic system model | model array
Dynamic system, specified as a SISO or MIMO dynamic system model or array of dynamic system models. You can only use state-space models of the following types:
Continuous-time or discrete-time numeric
ss
models.Generalized or uncertain LTI models such as
genss
oruss
models. (Using uncertain models requires Robust Control Toolbox™ software.)For tunable control design blocks, the function evaluates the model at its current value for both plotting and returning response data.
For uncertain control design blocks, the function plots the nominal value and random samples of the model. When you use output arguments, the function returns response data for the nominal model only.
Sparse state-space models such as
sparss
andmechss
models. You must specify final timetFinal
for sparse state-space models.Linear time-varying (
ltvss
) and linear parameter-varying (lpvss
) models.
If sys
is an array of models, the function plots the responses of all models in the array on the same axes.
TimeSpec
— Time values
scalar | vector | []
Time steps at which to compute the response, specified as one of the following:
Positive scalar
tFinal
— Compute the response fromt = 0
tot = tFinal
.Two-element vector
[t0 tFinal]
— Compute the response fromt = t0
tot = tFinal
. (since R2023b)Vector
Ti:dt:Tf
— Compute the response for the time points specified int
.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 propertyTs
ofsys
.For discrete-time systems with an unspecified sample time (
Ts = -1
),dt
must be1
.
[]
— 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 step size 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 interpretstFinal
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
.
Bias
— Baseline input signal value
0 (default) | scalar | vector | 'u0'
Baseline input signal value, specified as a scalar or vector.
For single-input systems,
Bias
is a scalar value.For multi-input systems,
Bias
is a vector of length Nu, where Nu is the number of input channels. Each vector value corresponds to the signal value in that input channel. The functions compute the responses one input channel at a time.For state-space models with offsets, set
Bias
='u0'
to set the baseline signal to the offsets u0, u0(t) of the LTV model, or u0(t,p) of the LPV model. For LTV and LPV models, this is theu0
output of the data function. The total input signal is then u0 + u(t).
InitialCondition
— Initial condition
operating condition created using
findop
Initial condition for response, specified as an operating
condition created using findop
.
Name
— Response name
string | character vector
Response name, specified as a string or character vector and stored as a string.
Visible
— Response visibility
"on"
(default) | on/off logical value
Response visibility, specified as one of the following logical on/off values:
"on"
,1
, ortrue
— Display the response in the plot."off"
,0
, orfalse
— Do not display the response in the plot.
The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
LegendDisplay
— Option to list response in legend
"on"
(default) | on/off logical value
Option to list response in legend, specified as one of the following logical on/off values:
"on"
,1
, ortrue
— List the response in the legend."off"
,0
, orfalse
— Do not list the response in the legend.
The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
MarkerStyle
— Marker style
"none"
| "o"
| "+"
| "*"
| "."
| ...
Marker style, specified as one of the following values.
Marker | Description |
---|---|
"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 |
Color
— Plot color
RGB triplet | hexadecimal color code | color name
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. The following table lists these colors and their corresponding RGB triplets and hexadecimal color codes.
Color Name | RGB Triplet | Hexadecimal Color Code |
---|---|---|
| [1 0 0] | #FF0000 |
| [0 1 0] | #00FF00 |
| [0 0 1] | #0000FF |
| [0 1 1] | #00FFFF |
| [1 0 1] | #FF00FF |
| [1 1 0] | #FFFF00 |
| [0 0 0] | #000000 |
| [1 1 1] | #FFFFFF |
LineStyle
— Line style
"-"
| "--"
| ":"
| "-."
Line style, specified as one of the following values.
Line Style | Description |
---|---|
"-" | Solid line |
"--" | Dashed line |
":" | Dotted line |
"-." | Dash-dotted line |
MarkerSize
— Marker size
positive scalar
Marker size, specified as a positive scalar.
LineWidth
— Line width
positive scalar
Line width, specified as a positive scalar.
Characteristics
— Response characteristics
CharacteristicsManager
object
Response characteristics to display in the plot, specified as a
CharacteristicsManager
object with the following properties.
PeakResponse
— Peak response
CharacteristicOption
object
Peak response, specified as a CharacteristicOption
object with the following
property.
Visible
— Peak response visibility
"off"
(default) | on/off logical value
Peak response visibility, specified as one of the following logical on/off values:
"on"
,1
, ortrue
— Display the peak response."off"
,0
, orfalse
— Do not display the peak response.
The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
TransientTime
— Transient time
CharacteristicOption
object
Transient time, specified as a CharacteristicOption
object with the following
properties.
Threshold
— Threshold for detecting steady state
0.02
(default) | scalar value between 0 and 1
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
.
Visible
— Transient time visibility
"off"
(default) | on/off logical value
Transient time visibility, specified as one of the following logical on/off values:
"on"
,1
, ortrue
— Display the peak response."off"
,0
, orfalse
— Do not display the peak response.
The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
Normalize
— Option to normalize plot
"off"
(default) | on/off logical value
Option to normalize plot, specified as one of the following logical on/off values:
"on"
,1
, ortrue
— Normalize the plot."off"
,0
, orfalse
— Do not normalize the plot.
The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
Units
TimeUnit
— Time units
"seconds"
| "milliseconds"
| "minutes"
| ...
Time units, specified as one of the following 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.
Outputs
OutputLabels
— Output label text and style
AxesLabel
object | array of AxesLabel
objects
Output label text and style, specified as an AxesLabel
object or an
array of such objects. Each AxesLabel
object has the following
properties.
String
— Text value
string | character vector
Text value, specified as a string or character vector and stored as a string.
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.3804 0.3804 0.3804]
(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. The following table lists these colors and their corresponding RGB triplets and hexadecimal color codes.
Color Name | RGB Triplet | Hexadecimal Color Code |
---|---|---|
| [1 0 0] | #FF0000 |
| [0 1 0] | #00FF00 |
| [0 0 1] | #0000FF |
| [0 1 1] | #00FFFF |
| [1 0 1] | #FF00FF |
| [1 1 0] | #FFFF00 |
| [0 0 0] | #000000 |
| [1 1 1] | #FFFFFF |
Interpreter
— Text interpreter
"tex"
(default) | "latex"
| "none"
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.
OutputVisible
— Option to display outputs
on/off logical value | array of on/off logical values
Option to display outputs, specified as one of the following logical on/off values or an array of such values:
"on"
,1
, ortrue
— Display the corresponding output."off"
,0
, orfalse
— 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.
OutputGrouping
— Grouping of outputs
"none"
(default) | "all"
Grouping of outputs, specified as one of the following:
"none"
— Do not group outputs."all"
— Group outputs.
Title and Axis Labels
Title
— Title text and style
AxesLabel
object
Title text and style, specified as an AxesLabel
object with the following properties.
String
— Text value
string | character vector
Text value, specified as a string or character vector and stored as a string.
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. The following table lists these colors and their corresponding RGB triplets and hexadecimal color codes.
Color Name | RGB Triplet | Hexadecimal Color Code |
---|---|---|
| [1 0 0] | #FF0000 |
| [0 1 0] | #00FF00 |
| [0 0 1] | #0000FF |
| [0 1 1] | #00FFFF |
| [1 0 1] | #FF00FF |
| [1 1 0] | #FFFF00 |
| [0 0 0] | #000000 |
| [1 1 1] | #FFFFFF |
Interpreter
— Text interpreter
"tex"
(default) | "latex"
| "none"
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
— Subtitle text and style
AxesLabel
object
Subtitle text and style, specified as an
AxesLabel
object with the
following properties.
String
— Text value
string | character vector
Text value, specified as a string or character vector and stored as a string.
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. The following table lists these colors and their corresponding RGB triplets and hexadecimal color codes.
Color Name | RGB Triplet | Hexadecimal Color Code |
---|---|---|
| [1 0 0] | #FF0000 |
| [0 1 0] | #00FF00 |
| [0 0 1] | #0000FF |
| [0 1 1] | #00FFFF |
| [1 0 1] | #FF00FF |
| [1 1 0] | #FFFF00 |
| [0 0 0] | #000000 |
| [1 1 1] | #FFFFFF |
Interpreter
— Text interpreter
"tex"
(default) | "latex"
| "none"
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.
XLabel
— X-axis label text and style
AxesLabel
object
X-axis label text and style, specified as an AxesLabel
object with the following fields.
String
— Text value
string | character vector
Text value, specified as a string or character vector and stored as a string.
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. The following table lists these colors and their corresponding RGB triplets and hexadecimal color codes.
Color Name | RGB Triplet | Hexadecimal Color Code |
---|---|---|
| [1 0 0] | #FF0000 |
| [0 1 0] | #00FF00 |
| [0 0 1] | #0000FF |
| [0 1 1] | #00FFFF |
| [1 0 1] | #FF00FF |
| [1 1 0] | #FFFF00 |
| [0 0 0] | #000000 |
| [1 1 1] | #FFFFFF |
Interpreter
— Text interpreter
"tex"
(default) | "latex"
| "none"
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.
YLabel
— Y-axis label text and style
AxesLabel
object
Y-axis label text and style, specified as an AxesLabel
object with the following fields.
String
— Text value
string | character vector
Text value, specified as a string or character vector and stored as a string.
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. The following table lists these colors and their corresponding RGB triplets and hexadecimal color codes.
Color Name | RGB Triplet | Hexadecimal Color Code |
---|---|---|
| [1 0 0] | #FF0000 |
| [0 1 0] | #00FF00 |
| [0 0 1] | #0000FF |
| [0 1 1] | #00FFFF |
| [1 0 1] | #FF00FF |
| [1 1 0] | #FFFF00 |
| [0 0 0] | #000000 |
| [1 1 1] | #FFFFFF |
Interpreter
— Text interpreter
"tex"
(default) | "latex"
| "none"
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
XLimits
— X-axis limits
two-element vector | cell array of two-element vectors
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.
XLimitsMode
— X-axis limit selection mode
"auto"
(default) | "manual"
| cell array of strings
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 theXLimits
property.
Dependencies
If you modify an entry in the
XLimitsMode
property, the correspondingXLimitsMode
value changes to"manual"
.
YLimits
— Y-axis limits
two-element vector | cell array of two-element vectors
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 inOutputVisible
isoff
, then the corresponding limits are removed fromYLimits
.
YLimitsMode
— Y-axis limit selection mode
"auto"
(default) | "manual"
| cell array of strings
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 theYLimits
property.
Dependencies
If you modify an entry in the
YLimits
property, the correspondingYLimitsMode
value changes to"manual"
.YLimitsMode
contains selection modes only for visible outputs. When an entry inOutputVisible
isoff
, then the corresponding selection modes are removed fromYLimitsMode
.
AxesStyle
— Axes style
AxesStyle
object
Axes style, specified as an AxesStyle
object with the following properties.
Box
— Option to display axes outline
"on"
| on/off logical value
Option to display axes outline, specified as one of the following logical on/off values.
"on"
,1
, ortrue
— Display outline."off"
,0
, orfalse
— Hide outline.
The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
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
.
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. The following table lists these colors and their corresponding RGB triplets and hexadecimal color codes.
Color Name | RGB Triplet | Hexadecimal Color Code |
---|---|---|
| [1 0 0] | #FF0000 |
| [0 1 0] | #00FF00 |
| [0 0 1] | #0000FF |
| [0 1 1] | #00FFFF |
| [1 0 1] | #FF00FF |
| [1 1 0] | #FFFF00 |
| [0 0 0] | #000000 |
| [1 1 1] | #FFFFFF |
GridVisible
— Option to display grid
on/off logical value
Option to display grid, specified as one of the following logical on/off values.
"on"
,1
, ortrue
— Display grid."off"
,0
, orfalse
— 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.
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. The following table lists these colors and their corresponding RGB triplets and hexadecimal color codes.
Color Name | RGB Triplet | Hexadecimal Color Code |
---|---|---|
| [1 0 0] | #FF0000 |
| [0 1 0] | #00FF00 |
| [0 0 1] | #0000FF |
| [0 1 1] | #00FFFF |
| [1 0 1] | #FF00FF |
| [1 1 0] | #FFFF00 |
| [0 0 0] | #000000 |
| [1 1 1] | #FFFFFF |
GridLineWidth
— Grid line width
0.5
(default) | positive scalar
Grid line width, specified as a positive scalar.
Legend
LegendAxesMode
— Legend axes selection mode
"auto"
(default) | "manual"
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 theLegendAxes
property.
LegendAxes
— Legend axes
two-element vector
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.
LegendVisible
— Option to display the legend
"off"
(default) | on/off logical value
Option to display the legend, specified as one of the following logical on/off values:
"on"
,1
, ortrue
— Display the legend."off"
,0
, orfalse
— Hide the legend.
The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
LegendLocation
— Legend location within the axes
"northeast"
(default) | "northwest"
| "southeast"
| "southwest"
| "north"
| "south"
| "east"
| "west"
| "best"
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"
.
LegendOrientation
— Orientation for stacking legend items
"vertical"
(default) | "horizontal"
Orientation for stacking legend items, specified as one of the following values:
"vertical"
— Stack items vertically."horizontal"
— Stack items horizontally.
Chart Layout
Parent
— Parent container
Figure
object (default) | TiledChartLayout
object | UIFigure
object | UIGridLayout
object | UIPanel
object | UITab
object
Parent container of the chart, specified as one of the following objects:
Figure
TiledChartLayout
UIFigure
UIGridLayout
UIPanel
UITab
Visible
— Chart visibility
"on"
(default) | on/off logical value
Chart visibility, specified as one of the following logical on/off values:
"on"
,1
, ortrue
— Display the chart."off"
,0
, orfalse
— 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
.
HandleVisibility
— Visibility of object handle
'on'
(default) | 'off'
| 'callback'
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 theHandleVisibility
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.
Units
— Position units
'normalized'
(default) | 'inches'
| 'centimeters'
| 'characters'
| 'points'
| 'pixels'
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
.
Units | Description |
---|---|
'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:
|
'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 Linux® systems, the size of a pixel is determined by your system resolution. |
OuterPosition
— Chart size and location, including margins
[left bottom width height]
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
.
InnerPosition
— Chart size and location, excluding margins
[left bottom width height]
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
.
Position
— Chart size and location, excluding margins
[left bottom width height]
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
.
PositionConstraint
— Position to hold constant
'outerposition'
| 'innerposition'
Position property to hold constant when adding, removing, or changing decorations, specified as one of the following values:
'outerposition'
— TheOuterPosition
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 theInnerPosition
property.'innerposition'
— TheInnerPosition
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 theOuterPosition
property.
Note
Setting this property has no effect when the parent of the chart is a TiledChartLayout
.
Layout
— Layout options
empty LayoutOptions
array (default) | TiledChartLayoutOptions
| GridLayoutOptions
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];
NextPlot
— Properties to reset
"replace"
(default) | "add"
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, exceptPosition
andUnits
, to their default values before displaying the new plot.
Tips
You can also interactively modify response plot properties using the:
Property Editor — For more information, see Customize Linear Analysis Plots Using Property Editor.
Version History
Introduced in R2024b
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)