BoxChart Properties
BoxChart
properties control the appearance and behavior of a
BoxChart
object. By changing property values, you can modify certain
aspects of the object.
You can use dot notation to query and set properties. For example, you can change the box color of a box chart:
b = boxchart(rand(10,1)); b.BoxFaceColor = [0 0.5 0.5];
Data Display
BoxWidth
— Width of individual boxes
0.5
(default) | positive scalar value
Width of individual boxes, specified as a positive scalar value. Use this property
to control the separation of the boxes. The default value is
0.5
.
The default value of 0.5 means the distance between boxes is the same as the width of a single box in any of these cases:
ydata
is a matrix.The spacing between the groups in the
xgroupdata
argument ofboxchart
is 1 unit.xgroupdata
is categorical.
If you set this property to
1
, then adjacent boxes can touch.Note that if you specify both
cgroupdata
andxgroupdata
in the call toboxchart
, this description might not be true.If you use
cgroupdata
, thenboxchart
dividesBoxWidth
by the number of colors (that is, unique values in color data) specified bycgroupdata
.
Example: b = boxchart(rand(10,3),'BoxWidth',0.75)
Example: b.BoxWidth = 0.75;
JitterOutliers
— Outlier marker displacement
'off'
(default) | on/off logical value
Outlier marker displacement, 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
.
If you set the JitterOutliers
property to
'on'
, then boxchart
randomly displaces the
outlier markers along the XData
direction to help you distinguish
between outliers that have similar ydata
values. For an example,
see Visualize and Find Outliers.
Example: b = boxchart([rand(20,1);2;2;2],'JitterOutliers','on')
Example: b.JitterOutliers = 'on';
Notch
— Median comparison display
'off'
(default) | on/off logical value
Median comparison display, 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
.
If you set the Notch
property to 'on'
, then
boxchart
creates a tapered, shaded region around each median.
Box charts whose notches do not overlap have different medians at the 5% significance
level. For more information, see Box Chart (Box Plot).
Notches can extend beyond the lower and upper quartiles.
Example: b = boxchart(rand(10,2),'Notch','on')
Example: b.Notch = 'on';
Orientation
— Orientation of box charts
'vertical'
(default) | 'horizontal'
Orientation of box charts, specified as 'vertical'
or
'horizontal'
. By default, the box charts are vertically oriented,
so that the ydata
statistics are aligned with the
y-axis. Regardless of the orientation,
boxchart
stores the ydata
values in the
YData
property of the BoxChart
object.
Example: b = boxchart(rand(10,1),'Orientation','horizontal')
Example: b.Orientation = 'horizontal';
Color and Styling
BoxFaceColor
— Box color
RGB triplet | hexadecimal color code | color name | short name
Box color, specified as an RGB triplet, hexadecimal color code, color name, or short
name. The box includes the box edges and median line. To specify the color of the box
edges and median line separately, you can use the BoxEdgeColor
property. To specify the color of the median line only, use the
BoxMedianLineColor
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" |
Example: b =
boxchart(rand(10,1),'BoxFaceColor','red')
Example: b.BoxFaceColor = [0 0.5 0.5];
Example: b.BoxFaceColor = '#EDB120';
BoxFaceColorMode
— How BoxFaceColor
is set
'auto'
(default) | 'manual'
How the BoxFaceColor
property is set, specified as one of these values:
'auto'
— MATLAB controls the value ofBoxFaceColor
by using theSeriesIndex
property of theBoxChart
object and theColorOrder
property of the axes.'manual'
— You control the value ofBoxFaceColor
manually, either by specifying a color when you create aBoxChart
object, or by settingBoxFaceColor
on the object after creating it.
If you change the value of BoxFaceColor
manually, MATLAB changes the value of the BoxFaceColorMode
property to
'manual'
.
BoxEdgeColor
— Box edge color
RGB triplet | hexadecimal color code | color name | short name
Box edge color, specified as an RGB triplet, hexadecimal color code, color name, or
short name. The box edges include the median line. To specify the median line color
separately, use the BoxMedianLineColor
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" |
Example: b =
boxchart(rand(10,1),'BoxEdgeColor','none')
Example: b.BoxEdgeColor = [0 0 0];
Example: b.BoxEdgeColor = '#7E2F8E';
BoxEdgeColorMode
— How BoxEdgeColor
is set
'auto'
(default) | 'manual'
How the BoxEdgeColor
property is set, specified as one of these values:
'auto'
— MATLAB controls the value ofBoxEdgeColor
by setting it equal to theBoxFaceColor
property of theBoxChart
object.'manual'
— You control the value ofBoxEdgeColor
manually, either by specifying a color when you create aBoxChart
object, or by settingBoxEdgeColor
on the object after creating it.
If you change the value of BoxEdgeColor
manually, MATLAB changes the value of the BoxEdgeColorMode
property to
'manual'
.
BoxMedianLineColor
— Box median line color
RGB triplet | hexadecimal color code | color name | short name
Box median line color, specified as an RGB triplet, hexadecimal color code, color name, or short name.
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: b =
boxchart(rand(10,1),'BoxMedianLineColor','black')
Example: b.BoxMedianLineColor = [1 0 0];
Example: b.BoxMedianLineColor = '#7E2F8E';
BoxMedianLineColorMode
— How BoxMedianLineColor
is set
'auto'
(default) | 'manual'
How the BoxMedianLineColor
property is set, specified as one of
these values:
'auto'
— MATLAB controls the value ofBoxMedianLineColor
by setting it equal to theBoxEdgeColor
property of theBoxChart
object.'manual'
— You control the value ofBoxMedianLineColor
manually, either by specifying a color when you create aBoxChart
object, or by settingBoxMedianLineColor
on the object after creating it.
If you change the value of BoxMedianLineColor
manually,
MATLAB changes the value of the BoxMedianLineColorMode
property to 'manual'
.
WhiskerLineColor
— Whisker color
RGB triplet | hexadecimal color code | color name | short name
Whisker color, specified as an RGB triplet, hexadecimal color code, color name, or short name.
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: b =
boxchart(rand(10,1),'WhiskerLineColor','r')
Example: b.WhiskerLineColor = [0.25 0.5 0.5];
Example: b.WhiskerLineColor = '#A2142F';
BoxFaceAlpha
— Box fill transparency
0.2
(default) | scalar in range [0,1]
Box fill transparency, specified as a scalar in the range [0,1]
.
A value of 1
is opaque and 0
is completely
transparent. Values between 0
and 1
are
semitransparent.
Example: b =
boxchart(rand(10,1),'BoxFaceAlpha',0.4)
Example: b.BoxFaceAlpha = 0.4;
WhiskerLineStyle
— Whisker style
'-'
(default) | '--'
| ':'
| '-.'
| 'none'
Whisker 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 |
Example: b =
boxchart(rand(10,1),'WhiskerLineStyle','--')
Example: b.WhiskerLineStyle = '--';
LineWidth
— Box edge and whisker width
1
(default) | positive scalar
Box edge and whisker width, specified as a positive scalar in point units. One point
equals 1/72 inch. The LineWidth
value also controls the width of
the median line.
Example: b = boxchart(rand(10,1),'LineWidth',1.5)
Example: b.LineWidth = 1.5;
SeriesIndex
— Series index
positive whole number | "none"
Series index, specified as a positive whole number or "none"
.
This property is useful for reassigning the box color
(BoxFaceColor
), outlier color (MarkerColor
),
box edge color (BoxEdgeColor
), and box median line color
(BoxMedianLineColor
) of several BoxChart
objects so that they match each other. By default, the SeriesIndex
property of a BoxChart
object is a number that corresponds to the
creation order of the object, starting at 1
.
MATLAB uses the number to calculate an index for assigning colors when you call
plotting functions. The index refers to the rows of the array stored in the
ColorOrder
property of the axes. MATLAB automatically updates the box color or outlier color of the
BoxChart
object when you change its
SeriesIndex
, or when you change the
ColorOrder
property on the axes.
A SeriesIndex
value of
"none"
corresponds to a neutral color that does not participate in
the indexing scheme. (since R2023b)
However, the following conditions must be true for the changes to have any effect:
Either the
BoxFaceColorMode
or theMarkerColorMode
property of theBoxChart
object is set to'auto'
.The
SeriesIndex
property on theBoxChart
object is greater than0
.The
NextSeriesIndex
property on the axes object is greater than0
.
Additionally, if the BoxEdgeColorMode
property of the
BoxChart
object is set to 'auto'
, then MATLAB updates the box edge color with the value of the box face color. If
the BoxMedianLineColorMode
property of the
BoxChart
object is also set to 'auto'
, then
MATLAB updates the box median line color with the value of the box edge
color.
Markers
MarkerStyle
— Outlier style
'o'
(default) | '+'
| '*'
| '.'
| 'x'
| ...
Outlier style, specified as one of the options listed in this table.
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 |
Example: b = boxchart([rand(10,1);2],'MarkerStyle','x')
Example: b.MarkerStyle = 'x';
MarkerSize
— Outlier size
6
(default) | positive scalar
Outlier size, specified as a positive scalar in point units. One point equals 1/72 inch.
Example: b =
boxchart([rand(10,1);2],'MarkerSize',8)
Example: b.MarkerSize = 8;
MarkerColor
— Outlier color
RGB triplet | hexadecimal color code | color name | short name
Outlier color, specified as an RGB triplet, hexadecimal color code, color name, or short name.
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: b =
boxchart([rand(10,1);2],'MarkerColor','magenta')
Example: b.MarkerColor = [0.5 0.5 1];
Example: b.MarkerColor = '#7E2F8E';
MarkerColorMode
— How MarkerColor
is set
'auto'
(default) | 'manual'
How the MarkerColor
property is set, specified as one of these values:
'auto'
— MATLAB controls the value ofMarkerColor
by selecting a color from theColorOrder
property of the axes.'manual'
— You control the value ofMarkerColor
manually, either by specifying a color when you create aBoxChart
object, or by settingMarkerColor
on the object after creating it.
If you change the value of MarkerColor
manually, MATLAB changes the value of the MarkerColorMode
property to
'manual'
.
Data
XData
— Position data
numeric vector | categorical vector
Position data, specified as a numeric or categorical vector.
If
YData
is a vector, thenXData
is a vector of the same length asYData
. TheXData(i)
value indicates the position of the box chart created using theYData(i)
value.If
YData
is a matrix, thenXData
is a vector whose length equals the number of columns inYData
. TheXData(i)
value indicates the position of the box chart created using the columnYData(:,i)
.
By default, XData
controls the box chart positions along the
x
-axis. However, when the Orientation
property value is 'horizontal'
, the XData
values
correspond to positions along the y
-axis.
Data Types: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
| categorical
YData
— Sample data
numeric vector | numeric matrix
Sample data, specified as a numeric vector or matrix.
Data Types: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
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 BoxChart
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
This property is read-only.
Data tip content, specified as a DataTipTemplate
object. For a list
of properties, see DataTipTemplate Properties.
You can use the datatip
function to modify aspects of the data tips (see Tips). However, setting
properties with the datatip
function has no effect on the
DataTipTemplate
property.
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.
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 theBoxChart
object that has a defined color. You cannot click a part that has an associated color property set to'none'
. TheHitTest
property determines if theBoxChart
object responds to the click or if an ancestor does.'none'
— Cannot capture mouse clicks. Clicking theBoxChart
object passes the click to the object below it in the current view of the figure window. TheHitTest
property of theBoxChart
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 theBoxChart
object. If you have defined theContextMenu
property, then invoke the context menu.'off'
— Trigger the callbacks for the nearest ancestor of theBoxChart
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 BoxChart
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
'BoxChart'
This property is read-only.
Type of graphics object, returned as 'BoxChart'
. Use this
property to find all objects of a given type within a plotting hierarchy, such as by
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 in R2020aR2023b: Opt out of automatic color selection with SeriesIndex="none"
Opt out of automatic color selection for BoxChart
objects by setting the
SeriesIndex
property to "none"
. When you specify
"none"
, the BoxChart
object has a neutral
color.
To enable automatic color selection again, set the SeriesIndex
property to a positive whole number.
R2023a: Create callback functions and context menus
Specify these properties to define your own callback functions or context menus for a box chart:
ContextMenu
— Create a context menu that appears when you right-click the box chart.ButtonDownFcn
— Define a callback function that executes when you click the box chart.CreateFcn
— Define a callback function that executes when the box chart is created.DeleteFcn
andBeingDeleted
— Define a callback function that executes when the box chart is deleted, and query whether the box chart is being deleted.Interruptible
andBusyAction
— Manage callback queuing.
See Also
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)