Stair Properties
Stair chart appearance and behavior
Stair
properties control the appearance and
behavior of a Stair
object. By changing property
values, you can modify certain aspects of the stair chart. Use dot notation to query and
set properties.
s = stairs(1:10); s.Color = 'red';
Color and Styling
Color
— Line color
[0 0 0]
(default) | RGB triplet | hexadecimal color code | "r"
| "g"
| "b"
| ...
Line color, specified as an RGB triplet, a hexadecimal color code, a color name, or a
short name. The default value of [0 0 0]
corresponds to black.
For a custom color, specify an RGB triplet or a hexadecimal color code.
An RGB triplet is a three-element row vector whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range
[0,1]
, for example,[0.4 0.6 0.7]
.A hexadecimal color code is a string scalar or character vector that starts with a hash symbol (
#
) followed by three or six hexadecimal digits, which can range from0
toF
. The values are not case sensitive. Therefore, the color codes"#FF8800"
,"#ff8800"
,"#F80"
, and"#f80"
are equivalent.
Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.
Color Name | Short Name | RGB Triplet | Hexadecimal Color Code | Appearance |
---|---|---|---|---|
"red" | "r" | [1 0 0] | "#FF0000" | |
"green" | "g" | [0 1 0] | "#00FF00" | |
"blue" | "b" | [0 0 1] | "#0000FF" | |
"cyan"
| "c" | [0 1 1] | "#00FFFF" | |
"magenta" | "m" | [1 0 1] | "#FF00FF" | |
"yellow" | "y" | [1 1 0] | "#FFFF00" | |
"black" | "k" | [0 0 0] | "#000000" | |
"white" | "w" | [1 1 1] | "#FFFFFF" | |
"none" | Not applicable | Not applicable | Not applicable | No color |
Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB® uses in many types of plots.
RGB Triplet | Hexadecimal Color Code | Appearance |
---|---|---|
[0 0.4470 0.7410] | "#0072BD" | |
[0.8500 0.3250 0.0980] | "#D95319" | |
[0.9290 0.6940 0.1250] | "#EDB120" | |
[0.4940 0.1840 0.5560] | "#7E2F8E" | |
[0.4660 0.6740 0.1880] | "#77AC30" | |
[0.3010 0.7450 0.9330] | "#4DBEEE" | |
[0.6350 0.0780 0.1840] | "#A2142F" |
Example: "blue"
Example: [0 0 1]
Example: "#0000FF"
ColorMode
— Control how Color
is set
"auto"
(default) | "manual"
Control how the Color
property is set, specified as one of these values:
"auto"
— MATLAB controls the value of theColor
property by using theSeriesIndex
property of theStair
object and theColorOrder
property of the axes."manual"
— You set the value of theColor
property directly, or indirectly as a function argument when you create theStair
object.
If you change the value of the Color
property manually,
MATLAB changes the value of the ColorMode
property to
"manual"
.
LineStyle
— Line style
"-"
(default) | "--"
| ":"
| "-."
| "none"
Line style, specified as one of the options listed in this table.
Line Style | Description | Resulting Line |
---|---|---|
"-" | Solid line |
|
"--" | Dashed line |
|
":" | Dotted line |
|
"-." | Dash-dotted line |
|
"none" | No line | No line |
LineStyleMode
— Control how LineStyle
is set
"auto"
(default) | "manual"
Control how the LineStyle
property is set, specified as one of
these values:
"auto"
— MATLAB controls the value of theLineStyle
property by using theSeriesIndex
property of theStair
object and theLineStyleOrder
property of the axes."manual"
— You set the value of theLineStyle
property directly, or indirectly as a function argument when you create theStair
object.
If you change the value of the LineStyle
property manually,
MATLAB changes the value of the LineStyleMode
property to
"manual"
.
LineWidth
— Line width
0.5
(default) | positive value
Line width, specified as a positive value in points, where 1 point = 1/72 of an inch. If the line has markers, then the line width also affects the marker edges.
The line width cannot be thinner than the width of a pixel. If you set the line width to a value that is less than the width of a pixel on your system, the line displays as one pixel wide.
SeriesIndex
— Series index
positive whole number (default) | "none"
Series index, specified as a positive whole number or "none"
. This
property is useful for reassigning the colors, line styles, or markers of
Stair
objects so that they match other objects.
By default, the SeriesIndex
property is a number that corresponds
to the order in which the Stair
object was created, starting at
1
. MATLAB uses the number to calculate indices for automatically assigning color,
line style, or markers when you call plotting functions. The indices refer to the rows
of the arrays stored in the ColorOrder
and
LineStyleOrder
properties of the axes. Any objects in the axes
that have the same SeriesIndex
number also have the same color (and
line style and markers, if applicable).
A SeriesIndex
value of "none"
corresponds to a
solid line with a neutral color that does not participate in the indexing scheme.
How Manually Setting Colors, Line Styles, or Markers Overrides SeriesIndex
Behavior
To manually control the color, line style, and markers, set the
Color
, LineStyle
, and
Marker
properties of the Stair
object.
When you manually set these properties of an object, MATLAB disables automatic color, line style, and marker selection for that
object and allows your selection to persist, regardless of the value of the
SeriesIndex
property. The ColorMode
,
LineStyleMode
, and MarkerMode
properties indicate whether the colors, line styles, and markers have been set
manually (by you) or automatically. For each of these mode properties, a value of
"manual"
indicates manual selection, and a value of
"auto"
indicates automatic selection.
To enable automatic selection again, set the ColorMode
,
LineStyleMode
, MarkerMode
, or all
three properties to "auto"
, and set the
SeriesIndex
property to a positive whole number.
In some cases, MATLAB sets the SeriesIndex
property to
0
, which also disables automatic selection.
Markers
Marker
— Marker symbol
"none"
(default) | "o"
| "+"
| "*"
| "."
| ...
Marker symbol, specified as one of the values listed in this table. By default, the object does not display markers. Specifying a marker symbol adds markers at each data point or vertex.
Marker | Description | Resulting Marker |
---|---|---|
"o" | Circle |
|
"+" | Plus sign |
|
"*" | Asterisk |
|
"." | Point |
|
"x" | Cross |
|
"_" | Horizontal line |
|
"|" | Vertical line |
|
"square" | Square |
|
"diamond" | Diamond |
|
"^" | Upward-pointing triangle |
|
"v" | Downward-pointing triangle |
|
">" | Right-pointing triangle |
|
"<" | Left-pointing triangle |
|
"pentagram" | Pentagram |
|
"hexagram" | Hexagram |
|
"none" | No markers | Not applicable |
MarkerMode
— Control how Marker
is set
"auto"
(default) | "manual"
Control how the Marker
property is set, specified as one of these values:
"auto"
— MATLAB controls the value of the object'sMarker
property by using theSeriesIndex
property of theStair
object and theLineStyleOrder
property of the axes."manual"
— You set the value of theMarker
property directly, or indirectly as a function argument when you create theStair
object.
If you change the value of the Marker
property manually,
MATLAB changes the value of the MarkerMode
property to
"manual"
.
MarkerSize
— Marker size
6
(default) | positive value
Marker size, specified as a positive value in points, where 1 point = 1/72 of an inch.
MarkerEdgeColor
— Marker outline color
"auto"
(default) | RGB triplet | hexadecimal color code | "r"
| "g"
| "b"
| ...
Marker outline color, specified as "auto"
, an RGB triplet, a
hexadecimal color code, a color name, or a short name. The default value of
"auto"
uses the same color as the Color
property.
For a custom color, specify an RGB triplet or a hexadecimal color code.
An RGB triplet is a three-element row vector whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range
[0,1]
, for example,[0.4 0.6 0.7]
.A hexadecimal color code is a string scalar or character vector that starts with a hash symbol (
#
) followed by three or six hexadecimal digits, which can range from0
toF
. The values are not case sensitive. Therefore, the color codes"#FF8800"
,"#ff8800"
,"#F80"
, and"#f80"
are equivalent.
Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.
Color Name | Short Name | RGB Triplet | Hexadecimal Color Code | Appearance |
---|---|---|---|---|
"red" | "r" | [1 0 0] | "#FF0000" | |
"green" | "g" | [0 1 0] | "#00FF00" | |
"blue" | "b" | [0 0 1] | "#0000FF" | |
"cyan"
| "c" | [0 1 1] | "#00FFFF" | |
"magenta" | "m" | [1 0 1] | "#FF00FF" | |
"yellow" | "y" | [1 1 0] | "#FFFF00" | |
"black" | "k" | [0 0 0] | "#000000" | |
"white" | "w" | [1 1 1] | "#FFFFFF" | |
"none" | Not applicable | Not applicable | Not applicable | No color |
Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB uses in many types of plots.
RGB Triplet | Hexadecimal Color Code | Appearance |
---|---|---|
[0 0.4470 0.7410] | "#0072BD" | |
[0.8500 0.3250 0.0980] | "#D95319" | |
[0.9290 0.6940 0.1250] | "#EDB120" | |
[0.4940 0.1840 0.5560] | "#7E2F8E" | |
[0.4660 0.6740 0.1880] | "#77AC30" | |
[0.3010 0.7450 0.9330] | "#4DBEEE" | |
[0.6350 0.0780 0.1840] | "#A2142F" |
MarkerFaceColor
— Marker fill color
"none"
(default) | "auto"
| RGB triplet | hexadecimal color code | "r"
| "g"
| "b"
| ...
Marker fill color, specified as "auto"
, an RGB triplet, a hexadecimal
color code, a color name, or a short name. The "auto"
option uses the
same color as the Color
property of the parent axes. If you specify
"auto"
and the axes plot box is invisible, the marker fill color is
the color of the figure.
For a custom color, specify an RGB triplet or a hexadecimal color code.
An RGB triplet is a three-element row vector whose elements specify the intensities of the red, green, and blue components of the color. The intensities must be in the range
[0,1]
, for example,[0.4 0.6 0.7]
.A hexadecimal color code is a string scalar or character vector that starts with a hash symbol (
#
) followed by three or six hexadecimal digits, which can range from0
toF
. The values are not case sensitive. Therefore, the color codes"#FF8800"
,"#ff8800"
,"#F80"
, and"#f80"
are equivalent.
Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.
Color Name | Short Name | RGB Triplet | Hexadecimal Color Code | Appearance |
---|---|---|---|---|
"red" | "r" | [1 0 0] | "#FF0000" | |
"green" | "g" | [0 1 0] | "#00FF00" | |
"blue" | "b" | [0 0 1] | "#0000FF" | |
"cyan"
| "c" | [0 1 1] | "#00FFFF" | |
"magenta" | "m" | [1 0 1] | "#FF00FF" | |
"yellow" | "y" | [1 1 0] | "#FFFF00" | |
"black" | "k" | [0 0 0] | "#000000" | |
"white" | "w" | [1 1 1] | "#FFFFFF" | |
"none" | Not applicable | Not applicable | Not applicable | No color |
Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB uses in many types of plots.
RGB Triplet | Hexadecimal Color Code | Appearance |
---|---|---|
[0 0.4470 0.7410] | "#0072BD" | |
[0.8500 0.3250 0.0980] | "#D95319" | |
[0.9290 0.6940 0.1250] | "#EDB120" | |
[0.4940 0.1840 0.5560] | "#7E2F8E" | |
[0.4660 0.6740 0.1880] | "#77AC30" | |
[0.3010 0.7450 0.9330] | "#4DBEEE" | |
[0.6350 0.0780 0.1840] | "#A2142F" |
Coordinate Data
XData
— x values
[]
(default) | vector
x values, specified as a vector. The input argument
X
to the stairs
function sets the
x values. If you do not specify the
x values, then stairs
uses the
indices of YData
. XData
and
YData
must have equal lengths.
Example: 1:10
Data Types: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
| categorical
| datetime
| duration
XDataMode
— Control how XData
is set
'auto'
| 'manual'
Control how the XData
property is set, specified as one of these values:
'auto'
— MATLAB controls the value of theXData
property. TheXData
value can be:The indices of the values in
YData
.The values in a table variable. The
SourceTable
property specifies the table, and theXVariable
property specifies the variable. If either theSourceTable
orXVariable
properties are empty, theYData
indices are used.
'manual'
— TheXData
property is set directly and does not update automatically. This is the case when you plot vectors or matrices of coordinates.
XDataSource
— Variable linked to XData
''
(default) | character vector | string
Variable linked to XData
, specified as a character vector or string
containing a MATLAB workspace variable name. MATLAB evaluates the variable in the base workspace to generate the
XData
.
By default, there is no linked variable so the value is an empty
character vector, ''
. If you link a variable, then MATLAB does
not update the XData
values immediately. To force
an update of the data values, use the refreshdata
function.
Note
If you change one data source property to a variable that contains data of a different dimension, you might cause the function to generate a warning and not render the graph until you have changed all data source properties to appropriate values.
Example: 'x'
YData
— y values
[]
(default) | vector
y values, specified as a vector. The input argument
Y
to the stairs
function sets the
y values. XData
and
YData
must have equal lengths.
Example: 1:10
Data Types: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
| categorical
| datetime
| duration
YDataMode
— Control how YData
is set
'auto'
| 'manual'
Control how the YData
property is set, specified as one of these values:
'auto'
— TheYData
property updates automatically based on theSourceTable
andYVariable
properties. This is the case when you pass a table to a plotting function.'manual'
— TheYData
property is set directly and does not update automatically. This is the case when you plot vectors or matrices of coordinates.
YDataSource
— Variable linked to YData
''
(default) | character vector | string
Variable linked to YData
, specified as a character vector or string
containing a MATLAB workspace variable name. MATLAB evaluates the variable in the base workspace to generate the
YData
.
By default, there is no linked variable so the value is an empty
character vector, ''
. If you link a variable, then MATLAB does
not update the YData
values immediately. To force
an update of the data values, use the refreshdata
function.
Note
If you change one data source property to a variable that contains data of a different dimension, you might cause the function to generate a warning and not render the graph until you have changed all data source properties to appropriate values.
Example: 'y'
Table Data (Since R2022b)
SourceTable
— Source table
table | timetable
Source table containing the data to plot. Specify this property as a table or a timetable.
XVariable
— Table variable containing x-coordinates
string scalar | character vector | pattern | numeric scalar | logical vector | vartype()
Table variable containing the x-coordinates, specified using one of the
indexing schemes from the following table. The variable you specify can contain numeric,
categorical, datetime, or duration values. When you set this property, MATLAB updates the XData
property.
This table lists the different indexing schemes you can use to specify the table variable.
Indexing Scheme | Examples |
---|---|
Variable name:
|
|
Variable index:
|
|
Variable type:
|
|
YVariable
— Table variable containing y-coordinates
string scalar | character vector | pattern | numeric scalar | logical vector | vartype()
Table variable containing the y-coordinates, specified using one of the
indexing schemes from the following table. The variable you specify can contain numeric,
categorical, datetime, or duration values. When you set this property, MATLAB updates the YData
property.
This table lists the different indexing schemes you can use to specify the table variable.
Indexing Scheme | Examples |
---|---|
Variable name:
|
|
Variable index:
|
|
Variable type:
|
|
Legend
DisplayName
— Legend label
''
(default) | character vector | string scalar
Legend label, specified as a character vector or string scalar. The legend does not
display until you call the legend
command. If you do not specify
the text, then legend
sets the label using the form
'dataN'
.
Annotation
— Include object in legend
Annotation
object
Include the object in the legend, specified as an Annotation
object. Set the underlying IconDisplayStyle
property of the
Annotation
object to one of these values:
"on"
— Include the object in the legend (default)."off"
— Do not include the object in the legend.
For example, to exclude the Stair
object named
obj
from the legend, set the IconDisplayStyle
property to "off"
.
obj.Annotation.LegendInformation.IconDisplayStyle = "off";
Alternatively, you can control the items in a legend using the legend
function. Specify the first input argument as a vector of the
graphics objects to include. If you do not specify an existing graphics object in the
first input argument, then it does not appear in the legend. However, graphics objects
added to the axes after the legend is created do appear in the legend. Consider creating
the legend after creating all the plots to avoid extra items.
Interactivity
Visible
— State of visibility
"on"
(default) | on/off logical value
State of visibility, specified as "on"
or "off"
, or as
numeric or logical 1
(true
) or
0
(false
). A value of "on"
is equivalent to true
, and "off"
is equivalent to
false
. Thus, you can use the value of this property as a logical
value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
"on"
— Display the object."off"
— Hide the object without deleting it. You still can access the properties of an invisible object.
DataTipTemplate
— Data tip content
DataTipTemplate
object
Data tip content, specified as a DataTipTemplate
object. You can
control the content that appears in a data tip by modifying the properties of the
underlying DataTipTemplate
object. For a list of properties, see
DataTipTemplate Properties.
For an example of modifying data tips, see Create Custom Data Tips.
Note
The DataTipTemplate
object is not returned by
findobj
or findall
, and it is not
copied by copyobj
.
ContextMenu
— Context menu
empty GraphicsPlaceholder
array (default) | ContextMenu
object
Context menu, specified as a ContextMenu
object. Use this property
to display a context menu when you right-click the object. Create the context menu using
the uicontextmenu
function.
Note
If the PickableParts
property is set to
'none'
or if the HitTest
property is set
to 'off'
, then the context menu does not appear.
Selected
— Selection state
'off'
(default) | on/off logical value
Selection state, specified as 'on'
or 'off'
, or as
numeric or logical 1
(true
) or
0
(false
). A value of 'on'
is equivalent to true, and 'off'
is equivalent to
false
. Thus, you can use the value of this property as a logical
value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
'on'
— Selected. If you click the object when in plot edit mode, then MATLAB sets itsSelected
property to'on'
. If theSelectionHighlight
property also is set to'on'
, then MATLAB displays selection handles around the object.'off'
— Not selected.
SelectionHighlight
— Display of selection handles
'on'
(default) | on/off logical value
Display of selection handles when selected, specified as 'on'
or
'off'
, or as numeric or logical 1
(true
) or 0
(false
). A
value of 'on'
is equivalent to true, and 'off'
is
equivalent to false
. Thus, you can use the value of this property as
a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
'on'
— Display selection handles when theSelected
property is set to'on'
.'off'
— Never display selection handles, even when theSelected
property is set to'on'
.
Clipping
— Clipping of object to axes limits
'on'
(default) | on/off logical value
Clipping of the object to the axes limits, specified as 'on'
or
'off'
, or as numeric or logical 1
(true
) or 0
(false
). A
value of 'on'
is equivalent to true, and 'off'
is
equivalent to false
. Thus, you can use the value of this property as
a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
A value of
'on'
clips parts of the object that are outside the axes limits.A value of
'off'
displays the entire object, even if parts of it appear outside the axes limits. Parts of the object might appear outside the axes limits if you create a plot, sethold on
, freeze the axis scaling, and then create the object so that it is larger than the original plot.
The Clipping
property of the axes that contains the object must be set to
'on'
. Otherwise, this property has no effect. For more
information about the clipping behavior, see the Clipping
property of the
axes.
Callbacks
ButtonDownFcn
— Mouse-click callback
''
(default) | function handle | cell array | character vector
Mouse-click callback, specified as one of these values:
Function handle
Cell array containing a function handle and additional arguments
Character vector that is a valid MATLAB command or function, which is evaluated in the base workspace (not recommended)
Use this property to execute code when you click the object. If you specify this property using a function handle, then MATLAB passes two arguments to the callback function when executing the callback:
Clicked object — Access properties of the clicked object from within the callback function.
Event data — Empty argument. Replace it with the tilde character (
~
) in the function definition to indicate that this argument is not used.
For more information on how to use function handles to define callback functions, see Create Callbacks for Graphics Objects.
Note
If the PickableParts
property is set to 'none'
or
if the HitTest
property is set to 'off'
,
then this callback does not execute.
CreateFcn
— Creation function
''
(default) | function handle | cell array | character vector
Object creation function, specified as one of these values:
Function handle.
Cell array in which the first element is a function handle. Subsequent elements in the cell array are the arguments to pass to the callback function.
Character vector containing a valid MATLAB expression (not recommended). MATLAB evaluates this expression in the base workspace.
For more information about specifying a callback as a function handle, cell array, or character vector, see Create Callbacks for Graphics Objects.
This property specifies a callback function to execute when MATLAB creates the object. MATLAB initializes all property values before executing the CreateFcn
callback. If you do not specify the CreateFcn
property, then MATLAB executes a default creation function.
Setting the CreateFcn
property on an existing component has no effect.
If you specify this property as a function handle or cell array, you can access the object that is being created using the first argument of the callback function. Otherwise, use the gcbo
function to access the object.
DeleteFcn
— Deletion function
''
(default) | function handle | cell array | character vector
Object deletion function, specified as one of these values:
Function handle.
Cell array in which the first element is a function handle. Subsequent elements in the cell array are the arguments to pass to the callback function.
Character vector containing a valid MATLAB expression (not recommended). MATLAB evaluates this expression in the base workspace.
For more information about specifying a callback as a function handle, cell array, or character vector, see Create Callbacks for Graphics Objects.
This property specifies a callback function to execute when MATLAB deletes the object. MATLAB executes the DeleteFcn
callback before destroying the
properties of the object. If you do not specify the DeleteFcn
property, then MATLAB executes a default deletion function.
If you specify this property as a function handle or cell array, you can access the object that is being deleted using the first argument of the callback function. Otherwise, use the gcbo
function to access the object.
Callback Execution Control
Interruptible
— Callback interruption
'on'
(default) | on/off logical value
Callback interruption, specified as 'on'
or 'off'
, or as
numeric or logical 1
(true
) or
0
(false
). A value of 'on'
is equivalent to true
, and 'off'
is equivalent to
false
. Thus, you can use the value of this property as a logical
value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
This property determines if a running callback can be interrupted. There are two callback states to consider:
The running callback is the currently executing callback.
The interrupting callback is a callback that tries to interrupt the running callback.
MATLAB determines callback interruption behavior whenever it executes a command that
processes the callback queue. These commands include drawnow
, figure
, uifigure
, getframe
, waitfor
, and pause
.
If the running callback does not contain one of these commands, then no interruption occurs. MATLAB first finishes executing the running callback, and later executes the interrupting callback.
If the running callback does contain one of these commands, then the
Interruptible
property of the object that owns the running
callback determines if the interruption occurs:
If the value of
Interruptible
is'off'
, then no interruption occurs. Instead, theBusyAction
property of the object that owns the interrupting callback determines if the interrupting callback is discarded or added to the callback queue.If the value of
Interruptible
is'on'
, then the interruption occurs. The next time MATLAB processes the callback queue, it stops the execution of the running callback and executes the interrupting callback. After the interrupting callback completes, MATLAB then resumes executing the running callback.
Note
Callback interruption and execution behave differently in these situations:
If the interrupting callback is a
DeleteFcn
,CloseRequestFcn
, orSizeChangedFcn
callback, then the interruption occurs regardless of theInterruptible
property value.If the running callback is currently executing the
waitfor
function, then the interruption occurs regardless of theInterruptible
property value.If the interrupting callback is owned by a
Timer
object, then the callback executes according to schedule regardless of theInterruptible
property value.
BusyAction
— Callback queuing
'queue'
(default) | 'cancel'
Callback queuing, specified as 'queue'
or 'cancel'
. The BusyAction
property determines how MATLAB handles the execution of interrupting callbacks. There are two callback states to consider:
The running callback is the currently executing callback.
The interrupting callback is a callback that tries to interrupt the running callback.
The BusyAction
property determines callback queuing behavior only
when both of these conditions are met:
Under these conditions, the BusyAction
property of the
object that owns the interrupting callback determines how MATLAB handles the interrupting callback. These are possible values of the
BusyAction
property:
'queue'
— Puts the interrupting callback in a queue to be processed after the running callback finishes execution.'cancel'
— Does not execute the interrupting callback.
PickableParts
— Ability to capture mouse clicks
'visible'
(default) | 'none'
Ability to capture mouse clicks, specified as one of these values:
'visible'
— Capture mouse clicks when visible. TheVisible
property must be set to'on'
and you must click a part of theStair
object that has a defined color. You cannot click a part that has an associated color property set to'none'
. If the plot contains markers, then the entire marker is clickable if either the edge or the fill has a defined color. TheHitTest
property determines if theStair
object responds to the click or if an ancestor does.'none'
— Cannot capture mouse clicks. Clicking theStair
object passes the click to the object below it in the current view of the figure window. TheHitTest
property of theStair
object has no effect.
HitTest
— Response to captured mouse clicks
'on'
(default) | on/off logical value
Response to captured mouse clicks, specified as 'on'
or
'off'
, or as numeric or logical 1
(true
) or 0
(false
). A
value of 'on'
is equivalent to true, and 'off'
is
equivalent to false
. Thus, you can use the value of this property as
a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState
.
'on'
— Trigger theButtonDownFcn
callback of theStair
object. If you have defined theContextMenu
property, then invoke the context menu.'off'
— Trigger the callbacks for the nearest ancestor of theStair
object that meets one of these conditions:HitTest
property is set to'on'
.PickableParts
property is set to a value that enables the ancestor to capture mouse clicks.
Note
The PickableParts
property determines if
the Stair
object can capture
mouse clicks. If it cannot, then the HitTest
property
has no effect.
BeingDeleted
— Deletion status
on/off logical value
This property is read-only.
Deletion status, returned as an on/off logical value of type matlab.lang.OnOffSwitchState
.
MATLAB sets the BeingDeleted
property to
'on'
when the DeleteFcn
callback begins
execution. The BeingDeleted
property remains set to
'on'
until the component object no longer exists.
Check the value of the BeingDeleted
property to verify that the object is not about to be deleted before querying or modifying it.
Parent/Child
Parent
— Parent
Axes
object | Group
object | Transform
object
Parent, specified as an Axes
, Group
,
or Transform
object.
Children
— Children
empty GraphicsPlaceholder
array | DataTip
object array
Children, returned as an empty GraphicsPlaceholder
array or a
DataTip
object array. Use this property to view a list of data tips
that are plotted on the chart.
You cannot add or remove children using the Children
property. To add a
child to this list, set the Parent
property of the
DataTip
object to the chart object.
HandleVisibility
— Visibility of object handle
"on"
(default) | "off"
| "callback"
Visibility of the object handle in the Children
property
of the parent, specified as one of these values:
"on"
— Object handle is always visible."off"
— Object handle is invisible at all times. This option is useful for preventing unintended changes by another function. SetHandleVisibility
to"off"
to temporarily hide the handle during the execution of that function."callback"
— 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 at the command line, but permits callback functions to access it.
If the object is not listed in the Children
property of the parent, then
functions that obtain object handles by searching the object hierarchy or querying
handle properties cannot return it. Examples of such functions include the
get
, findobj
, gca
, gcf
, gco
, newplot
, cla
, clf
, and close
functions.
Hidden object handles are still valid. Set the root ShowHiddenHandles
property to "on"
to list all object handles regardless of their
HandleVisibility
property setting.
Identifiers
Type
— Type of graphics object
'stair'
This property is read-only.
Type of graphics object, returned as 'stair'
. Use this
property to find all objects of a given type within a plotting hierarchy,
such as searching for the type using findobj
.
Tag
— Object identifier
''
(default) | character vector | string scalar
Object identifier, specified as a character vector or string scalar. You can specify a unique Tag
value to serve as an identifier for an object. When you need access to the object elsewhere in your code, you can use the findobj
function to search for the object based on the Tag
value.
UserData
— User data
[]
(default) | array
User data, specified as any MATLAB array. For example, you can specify a scalar, vector, matrix, cell array, character array, table, or structure. Use this property to store arbitrary data on an object.
If you are working in App Designer, create public or private properties in the app to share data instead of using the UserData
property. For more information, see Share Data Within App Designer Apps.
Version History
Introduced before R2006aR2023b: Opt out of automatic color and line style selection with
SeriesIndex="none"
Opt out of automatic color and line style selection for Stair
objects
by setting the SeriesIndex
property to "none"
. When
you specify "none"
, the Stair
object has a solid
line style and a neutral color with no markers.
To enable automatic selection again, set the SeriesIndex
property to a positive whole number.
R2022b: Properties that support plotting from tables
Modify plots created with table data using the SourceTable
,
XVariable
, YVariable
, and
ZVariable
properties.
The YDataMode
and ZDataMode
properties
control how MATLAB manages your data.
R2020a: Control automatic color and line style selection with the SeriesIndex
property
Set the SeriesIndex
property of any Stair
object to control how the objects vary in color, line style, and marker symbol. Changing the value of this property is useful when you want to match the colors, line styles, and markers of different objects in the axes.
R2020a: UIContextMenu
property is not recommended
Setting or getting UIContextMenu
property is not recommended. Instead,
use the ContextMenu
property, which accepts the same type of input and behaves the same way as the
UIContextMenu
property.
There are no plans to remove the UIContextMenu
property, but it is no
longer listed when you call the set
, get
, or
properties
functions on the Stair
object.
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)