Main Content

Stair Properties

Stair chart appearance and behavior

expand all in page

Stairproperties control the appearance and behavior of aStairobject. 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

expand all

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 from0toF。的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"

Sample of the color red
"green" "g" [0 1 0] "#00FF00"

Sample of the color green
"blue" "b" [0 0 1] "#0000FF"

Sample of the color blue
"cyan" "c" [0 1 1] "#00FFFF"

Sample of the color cyan
"magenta" "m" [1 0 1] "#FF00FF"

Sample of the color magenta
"yellow" "y" [1 1 0] "#FFFF00"

Sample of the color yellow
"black" "k" [0 0 0] "#000000"

Sample of the color black
"white" "w" [1 1 1] "#FFFFFF"

Sample of the color white
"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"

Sample of RGB triplet [0 0.4470 0.7410], which appears as dark blue
[0.8500 0.3250 0.0980] "#D95319"

Sample of RGB triplet [0.8500 0.3250 0.0980], which appears as dark orange
[0.9290 0.6940 0.1250] "#EDB120"

Sample of RGB triplet [0.9290 0.6940 0.1250], which appears as dark yellow
[0.4940 0.1840 0.5560] "#7E2F8E"

Sample of RGB triplet [0.4940 0.1840 0.5560], which appears as dark purple
[0.4660 0.6740 0.1880] "#77AC30"

Sample of RGB triplet [0.4660 0.6740 0.1880], which appears as medium green
[0.3010 0.7450 0.9330] "#4DBEEE"

Sample of RGB triplet [0.3010 0.7450 0.9330], which appears as light blue
[0.6350 0.0780 0.1840] "#A2142F"

Sample of RGB triplet [0.6350 0.0780 0.1840], which appears as dark red

Example:'blue'

Example:[0 0 1]

Example:'#0000FF'

Control how theColorproperty is set, specified as one of these values:

  • 'auto'— MATLAB controls the value of theColorproperty by selecting a color from theColorOrderproperty of the axes.

  • 'manual'— You control the value of theColorproperty manually, either by setting the value of theColorproperty directly on the object, or by including a color in theLineSpecargument when you call a plotting function.

If you change the value of theColorproperty manually, MATLAB changes the value of theColorModeproperty to'manual'。

Line style, specified as one of the options listed in this table.

Line Style Description Resulting Line
"-" Solid line

Sample of solid line
"--" Dashed line

Sample of dashed line
":" Dotted line

Sample of dotted line
"-." Dash-dotted line

Sample of dash-dotted line, with alternating dashes and dots
"none" No line No line

Control how theLineStyleproperty is set, specified as one of these values:

  • 'auto'— MATLAB controls the value of theLineStyleproperty by selecting a line style from theLineStyleOrderproperty of the axes.

  • 'manual'— You control the value of theLineStyleproperty manually, either by setting the value of theLineStyleproperty directly on the object, or by specifying theLineSpecargument when you call a plotting function.

If you change the value of theLineStyleproperty manually, MATLAB changes the value of theLineStyleModeproperty to'manual'。

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.

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

Series index, specified as a whole number greater than or equal to0。This property is useful for reassigning the colors, line styles, or markers of severalStairobjects so that they match each other. By default, theSeriesIndex财产的Stairobject is a number that corresponds to its order of creation, starting at1。

MATLAB uses the number to calculate indices for assigning color, line style, or markers when you call plotting functions. The indices refer to the rows of the arrays stored in theColorOrderandLineStyleOrderproperties of the axes.

MATLAB automatically updates the color, line style, or markers of theStairobject when you change itsSeriesIndex, or when you changeColorOrderorLineStyleOrderproperties on the axes. However, the following conditions must be true for the changes to have any effect:

  • At least one of the following properties on theStairobject is set to'auto':ColorMode,LineStyleMode, orMarkerMode。

  • 的SeriesIndexproperty on theStairobject is greater than0。

  • 的NextSeriesIndexproperty on the axes object is greater than0。

Markers

expand all

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

Sample of circle marker
"+" Plus sign

Sample of plus sign marker
"*" Asterisk

Sample of asterisk marker
"." Point

Sample of point marker
"x" Cross

Sample of cross marker
"_" Horizontal line

Sample of horizontal line marker
"|" Vertical line

Sample of vertical line marker
"square" Square

Sample of square marker
"diamond" Diamond

Sample of diamond line marker
"^" Upward-pointing triangle

Sample of upward-pointing triangle marker
"v" Downward-pointing triangle

Sample of downward-pointing triangle marker
">" Right-pointing triangle

Sample of right-pointing triangle marker
"<" Left-pointing triangle

Sample of left-pointing triangle marker
"pentagram" Pentagram

Sample of pentagram marker
"hexagram" Hexagram

Sample of hexagram marker
"none" No markers Not applicable

Control how theMarkerproperty is set, specified as one of these values:

  • 'auto'— MATLAB controls the value of the object'sMarkerproperty.

  • 'manual'— You control the value of theMarkerproperty manually, either by setting the value of theMarkerproperty directly on the object, or by including a marker in theLineSpecargument when you call a plotting function.

If you change the value of theMarkerproperty manually, MATLAB changes the value of theMarkerModeproperty to'manual'。

Marker size, specified as a positive value in points, where 1 point = 1/72 of an inch.

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

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 from0toF。的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"

Sample of the color red
"green" "g" [0 1 0] "#00FF00"

Sample of the color green
"blue" "b" [0 0 1] "#0000FF"

Sample of the color blue
"cyan" "c" [0 1 1] "#00FFFF"

Sample of the color cyan
"magenta" "m" [1 0 1] "#FF00FF"

Sample of the color magenta
"yellow" "y" [1 1 0] "#FFFF00"

Sample of the color yellow
"black" "k" [0 0 0] "#000000"

Sample of the color black
"white" "w" [1 1 1] "#FFFFFF"

Sample of the color white
"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"

Sample of RGB triplet [0 0.4470 0.7410], which appears as dark blue
[0.8500 0.3250 0.0980] "#D95319"

Sample of RGB triplet [0.8500 0.3250 0.0980], which appears as dark orange
[0.9290 0.6940 0.1250] "#EDB120"

Sample of RGB triplet [0.9290 0.6940 0.1250], which appears as dark yellow
[0.4940 0.1840 0.5560] "#7E2F8E"

Sample of RGB triplet [0.4940 0.1840 0.5560], which appears as dark purple
[0.4660 0.6740 0.1880] "#77AC30"

Sample of RGB triplet [0.4660 0.6740 0.1880], which appears as medium green
[0.3010 0.7450 0.9330] "#4DBEEE"

Sample of RGB triplet [0.3010 0.7450 0.9330], which appears as light blue
[0.6350 0.0780 0.1840] "#A2142F"

Sample of RGB triplet [0.6350 0.0780 0.1840], which appears as dark red

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 theColorproperty 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 from0toF。的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"

Sample of the color red
"green" "g" [0 1 0] "#00FF00"

Sample of the color green
"blue" "b" [0 0 1] "#0000FF"

Sample of the color blue
"cyan" "c" [0 1 1] "#00FFFF"

Sample of the color cyan
"magenta" "m" [1 0 1] "#FF00FF"

Sample of the color magenta
"yellow" "y" [1 1 0] "#FFFF00"

Sample of the color yellow
"black" "k" [0 0 0] "#000000"

Sample of the color black
"white" "w" [1 1 1] "#FFFFFF"

Sample of the color white
"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"

Sample of RGB triplet [0 0.4470 0.7410], which appears as dark blue
[0.8500 0.3250 0.0980] "#D95319"

Sample of RGB triplet [0.8500 0.3250 0.0980], which appears as dark orange
[0.9290 0.6940 0.1250] "#EDB120"

Sample of RGB triplet [0.9290 0.6940 0.1250], which appears as dark yellow
[0.4940 0.1840 0.5560] "#7E2F8E"

Sample of RGB triplet [0.4940 0.1840 0.5560], which appears as dark purple
[0.4660 0.6740 0.1880] "#77AC30"

Sample of RGB triplet [0.4660 0.6740 0.1880], which appears as medium green
[0.3010 0.7450 0.9330] "#4DBEEE"

Sample of RGB triplet [0.3010 0.7450 0.9330], which appears as light blue
[0.6350 0.0780 0.1840] "#A2142F"

Sample of RGB triplet [0.6350 0.0780 0.1840], which appears as dark red

Coordinate Data

expand all

xvalues, specified as a vector. The input argumentXto thestairsfunction sets thexvalues. If you do not specify thexvalues, thenstairsuses the indices ofYData。XDataandYDatamust have equal lengths.

Example:1:10

Data Types:single|double|int8|int16|int32|int64|uint8|uint16|uint32|uint64|categorical|datetime|duration

Control how theXDataproperty is set, specified as one of these values:

  • 'auto'— MATLAB controls the value of theXDataproperty. TheXDatavalue can be:

    • 的indices of the values inYData。

    • 的values in a table variable. TheSourceTableproperty specifies the table, and theXVariableproperty specifies the variable. If either theSourceTableorXVariableproperties are empty, theYDataindices are used.

  • 'manual'— TheXDataproperty is set directly and does not update automatically. This is the case when you plot vectors or matrices of coordinates.

Variable linked toXData, specified as a character vector or string containing a MATLAB workspace variable name. MATLAB evaluates the variable in the base workspace to generate theXData。

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 theXDatavalues immediately. To force an update of the data values, use therefreshdatafunction.

Note

如果你改变一个数据源variab财产le 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'

yvalues, specified as a vector. The input argumentYto thestairsfunction sets theyvalues.XDataandYDatamust have equal lengths.

Example:1:10

Data Types:single|double|int8|int16|int32|int64|uint8|uint16|uint32|uint64|categorical|datetime|duration

Control how theYDataproperty is set, specified as one of these values:

  • 'auto'— TheYDataproperty updates automatically based on theSourceTableandYVariableproperties. This is the case when you pass a table to a plotting function.

  • 'manual'— TheYDataproperty is set directly and does not update automatically. This is the case when you plot vectors or matrices of coordinates.

Variable linked toYData, specified as a character vector or string containing a MATLAB workspace variable name. MATLAB evaluates the variable in the base workspace to generate theYData。

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 theYDatavalues immediately. To force an update of the data values, use therefreshdatafunction.

Note

如果你改变一个数据源variab财产le 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)

expand all

Source table containing the data to plot. Specify this property as a table or a timetable.

Table variable containing thex-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 theXDataproperty.

This table lists the different indexing schemes you can use to specify the table variable.

Indexing Scheme Examples

Variable name:

  • A string scalar or character vector.

  • Apatternobject. The pattern object must refer to only one variable.

  • "A"or'A'— A variable calledA

  • "Var"+digitsPattern(1)— The variable with the name"Var"followed by a single digit

Variable index:

  • An index number that refers to the location of a variable in the table.

  • A logical vector. Typically, this vector is the same length as the number of variables, but you can omit trailing0orfalsevalues.

  • 3— The third variable from the table

  • [false false true]— The third variable

Variable type:

  • Avartypesubscript that selects a table variable of a specified type. The subscript must refer to only one variable.

  • vartype("double")— The variable containing double values

Table variable containing they-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 theYDataproperty.

This table lists the different indexing schemes you can use to specify the table variable.

Indexing Scheme Examples

Variable name:

  • A string scalar or character vector.

  • Apatternobject. The pattern object must refer to only one variable.

  • "A"or'A'— A variable calledA

  • "Var"+digitsPattern(1)— The variable with the name"Var"followed by a single digit

Variable index:

  • An index number that refers to the location of a variable in the table.

  • A logical vector. Typically, this vector is the same length as the number of variables, but you can omit trailing0orfalsevalues.

  • 3— The third variable from the table

  • [false false true]— The third variable

Variable type:

  • Avartypesubscript that selects a table variable of a specified type. The subscript must refer to only one variable.

  • vartype("double")— The variable containing double values

Legend

expand all

Legend label, specified as a character vector or string scalar. The legend does not display until you call thelegendcommand. If you do not specify the text, thenlegendsets the label using the form'dataN'。

Include object in the legend, specified as anAnnotationobject. Set the underlyingIconDisplayStyleproperty of theAnnotationobject to one of these values:

  • "on"——包括传说中的对象(默认)。

  • "off"— Do not include the object in the legend.

For example, to exclude theStairobject calledobjfrom the legend, set theIconDisplayStyleproperty to"off"。

obj.Annotation.LegendInformation.IconDisplayStyle ="off";

Alternatively, you can control the items in a legend using thelegendfunction. 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

expand all

State of visibility, specified as"on"or"off", or as numeric or logical1(true) or0(false). A value of"on"相当于true, and"off"相当于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 typematlab.lang.OnOffSwitchState。

  • "on"— Display the object.

  • "off"— Hide the object without deleting it. You still can access the properties of an invisible object.

Data tip content, specified as aDataTipTemplateobject. You can control the content that appears in a data tip by modifying the properties of the underlyingDataTipTemplateobject. For a list of properties, seeDataTipTemplate Properties。

For an example of modifying data tips, see克雷亚te Custom Data Tips。

Note

的DataTipTemplate返回的对象不是findobjorfindall, and it is not copied bycopyobj。

Context menu, specified as aContextMenuobject. Use this property to display a context menu when you right-click the object. Create the context menu using theuicontextmenufunction.

Note

如果PickablePartsproperty is set to'none'or if theHitTestproperty is set to'off', then the context menu does not appear.

Selection state, specified as'on'or'off', or as numeric or logical1(true) or0(false). A value of'on'相当于true, and'off'相当于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 typematlab.lang.OnOffSwitchState。

  • 'on'— Selected. If you click the object when in plot edit mode, then MATLAB sets itsSelectedproperty to'on'。如果SelectionHighlightproperty also is set to'on', then MATLAB displays selection handles around the object.

  • 'off'— Not selected.

Display of selection handles when selected, specified as'on'or'off', or as numeric or logical1(true) or0(false). A value of'on'相当于true, and'off'相当于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 typematlab.lang.OnOffSwitchState。

  • 'on'— Display selection handles when theSelectedproperty is set to'on'。

  • 'off'— Never display selection handles, even when theSelectedproperty is set to'on'。

Clipping of the object to the axes limits, specified as'on'or'off', or as numeric or logical1(true) or0(false). A value of'on'相当于true, and'off'相当于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 typematlab.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.

的Clippingproperty 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 theClippingproperty of the axes.

Callbacks

expand all

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克雷亚te Callbacks for Graphics Objects。

Note

如果PickablePartsproperty is set to'none'or if theHitTestproperty is set to'off', then this callback does not execute.

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克雷亚te 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克雷亚teFcncallback. If you do not specify the克雷亚teFcnproperty, then MATLAB executes a default creation function.

Setting the克雷亚teFcnproperty 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 thegcbofunction to access the object.

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克雷亚te Callbacks for Graphics Objects。

This property specifies a callback function to execute when MATLAB deletes the object. MATLAB executes theDeleteFcncallback before destroying the properties of the object. If you do not specify theDeleteFcnproperty, 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 thegcbofunction to access the object.

Callback Execution Control

expand all

Callback interruption, specified as'on'or'off', or as numeric or logical1(true) or0(false). A value of'on'相当于true, and'off'相当于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 typematlab.lang.OnOffSwitchState。

This property determines if a running callback can be interrupted. There are two callback states to consider:

  • 的runningcallback is the currently executing callback.

  • 的interruptingcallback 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 includedrawnow,figure,uifigure,getframe,waitfor, andpause。

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

如果running callback does contain one of these commands, then theInterruptibleproperty of the object that owns the running callback determines if the interruption occurs:

  • 如果value ofInterruptibleis'off', then no interruption occurs. Instead, theBusyActionproperty of the object that owns the interrupting callback determines if the interrupting callback is discarded or added to the callback queue.

  • 如果value ofInterruptibleis'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:

  • 如果interrupting callback is aDeleteFcn,关闭RequestFcn, orSizeChangedFcncallback, then the interruption occurs regardless of theInterruptibleproperty value.

  • 如果running callback is currently executing thewaitforfunction, then the interruption occurs regardless of theInterruptibleproperty value.

  • 如果interrupting callback is owned by aTimerobject, then the callback executes according to schedule regardless of theInterruptibleproperty value.

Note

When an interruption occurs, MATLAB does not save the state of properties or the display. For example, the object returned by thegcaorgcfcommand might change when another callback executes.

Callback queuing, specified as'queue'or'cancel'。的BusyActionproperty determines how MATLAB handles the execution of interrupting callbacks. There are two callback states to consider:

  • 的runningcallback is the currently executing callback.

  • 的interruptingcallback is a callback that tries to interrupt the running callback.

的BusyActionproperty determines callback queuing behavior only when both of these conditions are met:

  • 的running callback contains a command that processes the callback queue, such asdrawnow,figure,uifigure,getframe,waitfor, orpause。

  • 的value of theInterruptibleproperty of the object that owns the running callback is'off'。

Under these conditions, theBusyActionproperty of the object that owns the interrupting callback determines how MATLAB handles the interrupting callback. These are possible values of theBusyActionproperty:

  • 'queue'— Puts the interrupting callback in a queue to be processed after the running callback finishes execution.

  • 'cancel'— Does not execute the interrupting callback.

Ability to capture mouse clicks, specified as one of these values:

  • 'visible'— Capture mouse clicks when visible. TheVisibleproperty must be set to'on'and you must click a part of theStairobject that has a defined color. You cannot click a part that has an associated color property set to'none'。如果plot contains markers, then the entire marker is clickable if either the edge or the fill has a defined color. TheHitTestproperty determines if theStairobject responds to the click or if an ancestor does.

  • 'none'— Cannot capture mouse clicks. Clicking theStairobject passes the click to the object below it in the current view of the figure window. TheHitTestproperty of theStairobject has no effect.

Response to captured mouse clicks, specified as'on'or'off', or as numeric or logical1(true) or0(false). A value of'on'相当于true, and'off'相当于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 typematlab.lang.OnOffSwitchState。

  • 'on'— Trigger theButtonDownFcncallback of theStairobject. If you have defined theContextMenuproperty, then invoke the context menu.

  • 'off'— Trigger the callbacks for the nearest ancestor of theStairobject that has one of these:

    • HitTestproperty set to'on'

    • PickablePartsproperty set to a value that enables the ancestor to capture mouse clicks

Note

的PickablePartsproperty determines if theStairobject can capture mouse clicks. If it cannot, then theHitTestproperty has no effect.

This property is read-only.

Deletion status, returned as an on/off logical value of typematlab.lang.OnOffSwitchState。

MATLAB sets theBeingDeletedproperty to'on'when theDeleteFcncallback begins execution. TheBeingDeletedproperty remains set to'on'until the component object no longer exists.

Check the value of theBeingDeleted属性来验证that the object is not about to be deleted before querying or modifying it.

Parent/Child

expand all

Parent, specified as anAxes,Group, orTransformobject.

Children, returned as an emptyGraphicsPlaceholderarray or aDataTipobject array. Use this property to view a list of data tips that are plotted on the chart.

You cannot add or remove children using theChildrenproperty. To add a child to this list, set theParentproperty of theDataTipobject to the chart object.

Visibility of the object handle in theChildrenproperty 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. Set theHandleVisibilityto"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.

如果object is not listed in theChildrenproperty 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 theget,findobj,gca,gcf,gco,newplot,cla,clf, andclosefunctions.

Hidden object handles are still valid. Set the rootShowHiddenHandlesproperty to"on"to list all object handles regardless of theirHandleVisibilityproperty setting.

Identifiers

expand all

This property is read-only.

类型的图形对象, returned as'stair'。Use this property to find all objects of a given type within a plotting hierarchy, such as searching for the type usingfindobj。

Object identifier, specified as a character vector or string scalar. You can specify a uniqueTagvalue to serve as an identifier for an object. When you need access to the object elsewhere in your code, you can use thefindobjfunction to search for the object based on theTagvalue.

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 theUserDataproperty. For more information, seeShare Data Within App Designer Apps。

Version History

Introduced before R2006a

expand all

See Also

Topics