RainCloudPlot Properties

Rain cloud plot appearance and behavior

Since R2026a

expand all in page

RainCloudPlot properties control the appearance and behavior of a RainCloudPlot object. By changing property values, you can modify certain aspects of the object. Use dot notation to query and set properties.

r = raincloudplot(randn(100,1));
o = r.Orientation;
r.FaceColor = [0 0.5 0.5];

Data Display

expand all

Maximum rain cloud plot width, specified as a positive scalar. DensityWidth has the same units as the positional grouping data specified by XData or XVariable.

Example: 0.5

Data Types: single | double

Orientation of the rain cloud plot, specified as "horizontal" or "vertical". By default, the rain cloud plot is horizontally oriented so that it aligns with the x-axis. Regardless of the orientation, the RainCloudPlot object stores the sample data in the YData property.

Data Types: string | char

Color and Styling

expand all

Rain cloud fill color corresponding to the upper half of the rain cloud plot, specified as an RGB triplet, hexadecimal color code, color name, or short name. Changing the FaceColor property changes both the fill color and edge color of the violin. To specify the color of the rain cloud edges separately, use the EdgeColor property. To specify the color of the swarm chart markers in the lower half of the rain cloud plot separately, use the MarkerFaceColor and MarkerEdgeColor properties.

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 from 0 to F. 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 the hexadecimal color codes.

Color NameShort NameRGB TripletHexadecimal Color CodeAppearance
"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 applicableNot applicableNot applicableNo color

This table lists the default color palettes for plots in the light and dark themes.

PalettePalette Colors

"gem" — Light theme default

Before R2025a: Most plots use these colors by default.

Sample of the "gem" color palette

"glow" — Dark theme default

Sample of the "glow" color palette

You can get the RGB triplets and hexadecimal color codes for these palettes using the orderedcolors and rgb2hex functions. For example, get the RGB triplets for the "gem" palette and convert them to hexadecimal color codes.

RGB = orderedcolors("gem");
H = rgb2hex(RGB);

Before R2023b: Get the RGB triplets using RGB = get(groot,"FactoryAxesColorOrder").

Before R2024a: Get the hexadecimal color codes using H = compose("#%02X%02X%02X",round(RGB*255)).

Example: "red"

Example: [0 0.5 0.5]

Example: "#EDB120"

How the FaceColor property is set, specified as one of these values:

  • "auto" — MATLAB® controls the value of FaceColor by using the SeriesIndex property of the RainCloudPlot object and the ColorOrder property of the axes.

  • "manual" — You set the value of FaceColor manually, either by specifying a color when you create a RainCloudPlot object or by setting FaceColor on the object after creating it.

If you change the value of FaceColor manually, MATLAB changes the value of the FaceColorMode property to "manual".

Rain cloud fill transparency corresponding to the upper half of the rain cloud plot, specified as a scalar in the range [0,1]. A value of 1 makes the rain cloud opaque, and 0 makes the rain cloud completely transparent. Values between 0 and 1 make the rain cloud semitransparent.

Example: 0.6

Rain cloud edge color, specified as an RGB triplet, hexadecimal color code, color name, or short name. To specify the edge color of the swarm chart markers in the lower half of the rain cloud plot separately, use the MarkerEdgeColor 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 from 0 to F. 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 the hexadecimal color codes.

Color NameShort NameRGB TripletHexadecimal Color CodeAppearance
"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 applicableNot applicableNot applicableNo color

This table lists the default color palettes for plots in the light and dark themes.

PalettePalette Colors

"gem" — Light theme default

Before R2025a: Most plots use these colors by default.

Sample of the "gem" color palette

"glow" — Dark theme default

Sample of the "glow" color palette

You can get the RGB triplets and hexadecimal color codes for these palettes using the orderedcolors and rgb2hex functions. For example, get the RGB triplets for the "gem" palette and convert them to hexadecimal color codes.

RGB = orderedcolors("gem");
H = rgb2hex(RGB);

Before R2023b: Get the RGB triplets using RGB = get(groot,"FactoryAxesColorOrder").

Before R2024a: Get the hexadecimal color codes using H = compose("#%02X%02X%02X",round(RGB*255)).

Example: "none"

Example: [0 0 0]

Example: "#7E2F8E"

How the EdgeColor property is set, specified as one of these values:

  • "auto" — MATLAB controls the value of EdgeColor by setting it equal to the FaceColor property of the RainCloudPlot object.

  • "manual" — You set the value of EdgeColor manually, either by specifying a color when you create a RainCloudPlot object or by setting EdgeColor on the object after creating it.

If you change the value of EdgeColor manually, MATLAB changes the value of the EdgeColorMode property to "manual".

Edge width, specified as a positive scalar in point units. This property controls both the violin plot and swarm chart marker edge width. One point equals 1/72 inch.

Series index, specified as a positive whole number or "none". This property is useful for reassigning the rain cloud face color (FaceColor), edge color (EdgeColor), marker face color (MarkerFaceColor), and marker edge color (MarkerEdgeColor) of several RainCloudPlot objects so that they match each other. By default, the SeriesIndex property of a RainCloudPlot 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 face color of the RainCloudPlot 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.

However, the following conditions must be true for the changes to have any effect:

  • The FaceColorMode property of the RainCloudPlot object is set to "auto".

  • The SeriesIndex property of the RainCloudPlot object is greater than 0.

  • The NextSeriesIndex property of the axes object is greater than 0.

Additionally, if the EdgeColorMode property of the RainCloudPlot object is set to "auto", then MATLAB updates the rain cloud edge color, marker edge color, and marker face color with the value of the face color.

Markers

expand all

Marker symbol, specified as one of the values listed in this table. Specifying a marker symbol adds markers at each data point or vertex.

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

Example: "hexagram"

Data Types: string | char

Rain cloud plot marker size, specified as a positive scalar in points squared. One point equals 1/72 inch. By default, the marker size is 6 points by 6 points, or 36 points squared.

Example: 50

Marker fill 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 color specified by MarkerFaceColor.

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 from 0 to F. 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 the hexadecimal color codes.

Color NameShort NameRGB TripletHexadecimal Color CodeAppearance
"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 applicableNot applicableNot applicableNo color

This table lists the default color palettes for plots in the light and dark themes.

PalettePalette Colors

"gem" — Light theme default

Before R2025a: Most plots use these colors by default.

Sample of the "gem" color palette

"glow" — Dark theme default

Sample of the "glow" color palette

You can get the RGB triplets and hexadecimal color codes for these palettes using the orderedcolors and rgb2hex functions. For example, get the RGB triplets for the "gem" palette and convert them to hexadecimal color codes.

RGB = orderedcolors("gem");
H = rgb2hex(RGB);

Before R2023b: Get the RGB triplets using RGB = get(groot,"FactoryAxesColorOrder").

Before R2024a: Get the hexadecimal color codes using H = compose("#%02X%02X%02X",round(RGB*255)).

Example: [0.3 0.2 0.1]

Example: "green"

Example: "#D2F9A7"

Data Types: single | double | string | char

How the MarkerFaceColor property is set, specified as one of these values:

  • "auto" — MATLAB controls the value of MarkerFaceColor by setting it equal to the MarkerFaceColor property of the RainCloudPlot object.

  • "manual" — You control the value of MarkerFaceColor manually, either by specifying a color when you create a RainCloudPlot object or by setting MarkerFaceColor on the object after creating it.

If you change the value of MarkerFaceColor manually, MATLAB changes the value of the MarkerFaceColorMode property to "manual".

Data Types: string | char

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 color specified by EdgeColor.

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 from 0 to F. 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 the hexadecimal color codes.

Color NameShort NameRGB TripletHexadecimal Color CodeAppearance
"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 applicableNot applicableNot applicableNo color

This table lists the default color palettes for plots in the light and dark themes.

PalettePalette Colors

"gem" — Light theme default

Before R2025a: Most plots use these colors by default.

Sample of the "gem" color palette

"glow" — Dark theme default

Sample of the "glow" color palette

You can get the RGB triplets and hexadecimal color codes for these palettes using the orderedcolors and rgb2hex functions. For example, get the RGB triplets for the "gem" palette and convert them to hexadecimal color codes.

RGB = orderedcolors("gem");
H = rgb2hex(RGB);

Before R2023b: Get the RGB triplets using RGB = get(groot,"FactoryAxesColorOrder").

Before R2024a: Get the hexadecimal color codes using H = compose("#%02X%02X%02X",round(RGB*255)).

Example: [0.3 0.2 0.1]

Example: "green"

Example: "#D2F9A7"

Data Types: double | single | string | char

How the MarkerEdgeColor property is set, specified as one of these values:

  • "auto" — MATLAB controls the value of MarkerEdgeColor by setting it equal to the EdgeColor property of the RainCloudPlot object.

  • "manual" — You set the value of MarkerEdgeColor manually, either by specifying a color when you create a RainCloudPlot object or by setting MarkerEdgeColor on the object after creating it.

If you change the value of MarkerEdgeColor manually, MATLAB changes the value of the MarkerEdgeColorMode property to "manual".

Data Types: string | char

Data

expand all

Positional grouping data, specified as a numeric or categorical vector. XData and YData must have the same length.

By default, XData controls the rain cloud plot position along the y-axis. However, if the Orientation property is "vertical", the XData values correspond to positions along the x-axis.

Data Types: single | double | categorical

How the XData property is set, specified as one of these values:

  • "auto" — The XData property updates automatically in either of these cases:

    • You pass a table to raincloudplot during creation. XData is based on the SourceTable and XVariable properties. If the XVariable property is empty, the function uses default values to set XData.

    • You do not pass xgroupdata to raincloudplot during creation. The function uses default values to set XData.

  • "manual" — The XData property is set directly and does not update automatically. This is the case when you pass grouping values as vectors or matrices to raincloudplot during creation.

Sample data, specified as a numeric vector. YData and XData must have the same length.

Data Types: single | double

How the YData property is set, specified as one of these values:

  • "auto" — The YData property updates automatically based on the SourceTable and YVariable properties. This is the case when you pass a table to raincloudplot during creation.

  • "manual" — The YData property is set directly and does not update automatically. This is the case when you pass data values as vectors or matrices to raincloudplot during creation.

Source table containing the data to plot, specified as a table or timetable.

Table variable containing the positional grouping data, specified using one of the indexing schemes from the following table. The variable you specify can contain numeric or categorical 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 SchemeExamples

Variable name:

  • A string scalar or character vector.

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

  • "A" or 'A' — A variable named A

  • "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 trailing 0 or false values.

  • 3 — The third variable from the table

  • [false false true] — The third variable

Variable type:

  • A vartype subscript 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 the sample data, specified using one of the indexing schemes from the following table. The variable you specify can contain numeric or categorical 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 SchemeExamples

Variable name:

  • A string scalar or character vector.

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

  • "A" or 'A' — A variable named A

  • "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 trailing 0 or false values.

  • 3 — The third variable from the table

  • [false false true] — The third variable

Variable type:

  • A vartype subscript 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 the legend command. If you do not specify the text, then legend sets the label using the form 'dataN'.

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

expand all

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.

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.

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.

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 its Selected property to "on". If the SelectionHighlight property 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 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 the Selected property is set to "on".

  • "off" — Never display selection handles, even when the Selected property is set to "on".

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, set hold 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

expand all

Mouse-click callback, specified as one of these values:

  • Function handle

  • Cell array in which the first element is a function handle and subsequent elements are the arguments to pass to the callback function

  • String scalar or character vector containing a valid MATLAB command or function, which is evaluated in the base workspace (not recommended)

The ButtonDownFcn callback executes when you click the RainCloudPlot object.

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.

Object creation function, specified as one of these values:

  • Function handle

  • Cell array in which the first element is a function handle and subsequent elements are the arguments to pass to the callback function

  • String scalar or character vector containing a valid MATLAB command or function, which is evaluated in the base workspace (not recommended)

For more information about specifying a callback as a function handle, cell array, string scalar, 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.

Object deletion function, specified as one of these values:

  • Function handle

  • Cell array in which the first element is a function handle and subsequent elements are the arguments to pass to the callback function

  • String scalar or character vector containing a valid MATLAB command or function, which is evaluated in the base workspace (not recommended)

For more information about specifying a callback as a function handle, cell array, string scalar, 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

expand all

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 set to "off", then no interruption occurs. Instead, the BusyAction 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 set to "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, or SizeChangedFcn callback, then the interruption occurs regardless of the Interruptible property value.

  • If the running callback is currently executing the waitfor function, then the interruption occurs regardless of the Interruptible property value.

  • If the interrupting callback is owned by a Timer object, then the callback executes according to schedule regardless of the Interruptible property value.

Note

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

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:

  • The running callback contains a command that processes the callback queue, such as drawnow, figure, uifigure, getframe, waitfor, or pause.

  • The value of the Interruptible property of the object that owns the running callback is set to "off".

Under these conditions, the BusyAction property of the object that owns the interrupting callback determines how MATLAB handles the interrupting callback. Specify the BusyAction property as one of these values:

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

  • "cancel" — Do not execute the interrupting callback.

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

  • 'visible' — Capture mouse clicks when visible. The Visible property must be set to 'on' and you must click a part of the RainCloudPlot object that has a defined color. You cannot click a part that has an associated color property set to 'none'. The HitTest property determines if the RainCloudPlot object responds to the click or if an ancestor does.

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

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 the ButtonDownFcn callback of the RainCloudPlot object. If you have defined the ContextMenu property, then invoke the context menu.

  • "off" — Trigger the callbacks for the nearest ancestor of the RainCloudPlot 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 RainCloudPlot object can capture mouse clicks. If it cannot, then the HitTest property has no effect.

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

expand all

Parent, specified as an Axes, Group, or Transform object.

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.

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

expand all

This property is read-only.

Type of graphics object, returned as 'raincloudplot'. Use this property to find all objects of a given type within a plotting hierarchy, such as by searching for the type using findobj.

Object identifier, specified as a string scalar or character vector. 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.

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 a Single App Designer App.

Version History

Introduced in R2026a

See Also

| | | |