PolarAxes Properties

Font name, specified as a supported font name or "FixedWidth". To display and print text properly, you must choose a font that your system supports. The default font depends on your operating system and locale.

To use a fixed-width font that looks good in any locale, use "FixedWidth". The fixed-width font relies on the root FixedWidthFontName property. Setting the root FixedWidthFontName property causes an immediate update of the display to use the new font.

Font size, specified as a scalar numeric value. The font size affects the title and tick labels. It also affects any legends or colorbars associated with the axes. The default font size depends on the specific operating system and locale. By default, the font size is measured in points. To change the units, set the FontUnits property.

MATLAB^® automatically scales some of the text to a percentage of the axes font size.

Example: ax.FontSize = 12

Selection mode for the font size, specified as one of these values:

Character thickness, specified as 'normal' or 'bold'.

MATLAB uses the FontWeight property to select a font from those available on your system. Not all fonts have a bold weight. Therefore, specifying a bold font weight can still result in the normal font weight.

Character slant, specified as 'normal' or 'italic'.

Not all fonts have both font styles. Therefore, the italic font might look the same as the normal font.

Scale factor for the title font size, specified as a numeric value greater than 0. The scale factor is applied to the value of the FontSize property to determine the font size for the title.

Title character thickness, specified as one of these values:

Subtitle character thickness, specified as one of these values:

Font size units, specified as one of these values.

To set both the font size and the font units in a single function call, you first must set the FontUnits property so that the Axes object correctly interprets the specified font size.

Font smoothing, 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.

Radius tick values, specified as a vector of increasing values. The radius tick values are the locations along the r-axis where the circular lines appear. The radius tick labels are the labels that you see next to each line. Use the RTickLabels property to specify the associated labels.

Example: ax.RTick = [0 2 4 6];

Alternatively, use the rticks function to specify the tick values.

Selection mode for the radius tick values, specified as one of these values:

Example: ax.RTickMode = 'auto'

Radius tick labels, specified as a cell array of character vectors, string array, or categorical array. If you do not want tick labels to show, then specify an empty cell array {}. If you do not specify enough labels for all the ticks values, then the labels repeat.

Tick labels support TeX and LaTeX markup. See the TickLabelInterpreter property for more information.

If you specify this property as a categorical array, MATLAB uses the values in the array, not the categories.

Example: ax.RTickLabel = {'one','two','three','four'};

Alternatively, use the rticklabels function.

Selection mode for the RTickLabel property value, specified as one of these values:

Angles at which to display lines extending from the origin, specified as a vector of increasing values. MATLAB labels the lines with the appropriate angle values, unless you specify different labels using the ThetaTickLabel property.

MATLAB interprets the values in units determined by the ThetaAxisUnits property.

Example: ax.ThetaTick = [0 90 180 270];

Alternatively, specify the values using the thetaticks function.

Selection mode for the ThetaTick property value, specified as one of these values:

Labels for angle lines, specified as a cell array of character vectors, string array, or categorical array.

If you do not specify enough labels for all the lines, then the labels repeat. Labels support TeX and LaTeX markup. See the TickLabelInterpreter property for more information.

If you specify this property as a categorical array, MATLAB uses the values in the array, not the categories.

Example: ax.ThetaTickLabel = {'right','top','left','bottom'};

Alternatively, specify the values using the thetaticklabels function.

Selection mode for the ThetaTickLabel property value, specified as one of these values:

Rotation of r-axis tick labels, specified as a scalar value in degrees. Positive values give counterclockwise rotation. Negative values give clockwise rotation.

Example: ax.RTickLabelRotation = 45;

Alternatively, use the rtickangle function.

Selection mode for the r-axis tick label rotation, specified as one of these values:

Minor tick marks along r-axis, 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.

Example: ax.RMinorTick = 'on';

Minor tick marks between angle lines, 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.

Location of the zero reference axis, specified as one of the values in this table.

Example: ax.ThetaZeroLocation = 'left';

Tick mark direction, specified as one of these values:

Selection mode for the TickDir property, specified as one of these values:

Example: ax.TickDirMode = 'auto'

Tick label interpreter, specified as one of these values:

TeX Markup

By default, MATLAB supports a subset of TeX markup. Use TeX markup to add superscripts and subscripts, modify the text type and color, and include special characters in the labels.

Modifiers remain in effect until the end of the text. Superscripts and subscripts are an exception because they modify only the next character or the characters within the curly braces. When you set the interpreter to 'tex', the supported modifiers are as follows.

This table lists the supported special characters for the 'tex' interpreter.

LaTeX Markup

To use LaTeX markup, set the TickLabelInterpreter property to 'latex'. Use dollar symbols around the labels, for example, use '$\int_1^{20} x^2 dx$' for inline mode or '$$\int_1^{20} x^2 dx$$' for display mode.

The displayed text uses the default LaTeX font style. The FontName, FontWeight, and FontAngle properties do not have an effect. To change the font style, use LaTeX markup within the text. The maximum size of the text that you can use with the LaTeX interpreter is 1200 characters. For multiline text, the maximum size of the text reduces by about 10 characters per line.

For examples that use TeX and LaTeX, see Greek Letters and Special Characters in Chart Text. For more information about the LaTeX system, see The LaTeX Project website at https://www.latex-project.org/.

Tick mark length, specified as a two-element vector. The first element determines the tick length. The second element is ignored.

Example: ax.TickLength = [0.02 0];

Minimum and maximum radius limits, specified as a two-element vector of the form [rmin rmax], where rmax is a numeric value greater than rmin. You can specify both limits, or specify one limit and let the axes automatically calculate the other.

Alternatively, use the rlim function to set the limits.

Example: ax.RLim = [0 6];

Selection mode for the RLim property value, specified as one of these values:

Minimum and maximum angle values, specified as a two-element vector of the form [thmin thmax]. If the difference between the values is less than 360 degrees, then the theta-axis is a partial circle.

MATLAB interprets the values in units determined by the ThetaAxisUnits property.

Example: ax.ThetaLim = [0 180];

Selection mode for the ThetaLim property value, specified as one of these values:

Component that controls the appearance and behavior of the r-axis, returned as a ruler object. When MATLAB creates polar axes, it automatically creates a ruler for the r-axis. Modify the appearance and behavior of this axis by accessing the associated ruler and setting ruler properties. For a list of options, see NumericRuler Properties.

For example, change the color of the r-axis to red.

ax = polaraxes;
ax.RAxis.Color = 'r';

Use the RAxis properties to access the ruler objects and set ruler properties. If you want to set polar axes properties, set them directly on the PolarAxes object.

Component that controls the appearance and behavior of the theta-axis, returned as a ruler object. When MATLAB creates polar axes, it automatically creates a numeric ruler for the theta-axis. Modify the appearance and behavior of this axis by accessing the associated ruler and setting ruler properties. For a list of options, see NumericRuler Properties.

For example, change the color of the theta-axis to red.

ax = polaraxes;
ax.ThetaAxis.Color = 'r';

Use the ThetaAxis property to access the ruler object and set ruler properties. If you want to set polar axes properties, set them directly on the PolarAxes object.

Location of the r-axis, specified a scalar angle value. MATLAB interprets the values in units determined by the ThetaAxisUnits property.

Example: ax.RAxisLocation = 90;

Selection mode for the RAxisLocation property value, specified as one of these values:

Color of the r-axis, including the r-axis grid lines, tick marks, and tick labels. Specify this value as an RGB triplet, a hexadecimal color code, a color name, or a short name.

For a custom color, specify an RGB triplet or a hexadecimal color code.

Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.

Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB uses in many types of plots.

For example, ax.RColor = 'r' changes the color to red.

Property for setting r-axis grid color, specified 'auto' or 'manual'. The mode value only affects the r-axis grid color. The r-axis tick labels always use the RColor value, regardless of the mode.

The r-axis grid color depends on both the RColorMode property and the GridColorMode property, as shown here.

The r-axis minor grid color depends on both the RColorMode property and the MinorGridColorMode property, as shown here.

Color of the theta-axis, including the theta-axis grid lines, tick marks, tick labels. Specify this value as an RGB triplet, a hexadecimal color code, a color name, or a short name.

For a custom color, specify an RGB triplet or a hexadecimal color code.

Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.

Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB uses in many types of plots.

For example, ax.ThetaColor = 'r' changes the color to red.

Property for setting theta-axis grid color, specified 'auto' or 'manual'. The mode value only affects the theta-axis grid color. The theta-axis line, tick marks, and labels always use the ThetaColor value, regardless of the mode.

The theta-axis grid color depends on both the ThetaColorMode property and the GridColorMode property, as shown here.

The theta-axis minor grid color depends on both the ThetaColorMode property and the MinorGridColorMode property, as shown here.

Direction of increasing values along the r-axis, specified as one of these values:

Example: ax.RDir = 'reverse';

Direction of increasing angles, specified as one of the values in this table.

Example: ax.ThetaDir = 'clockwise';

Units for angle values, specified as one of these values:

Example: ax.ThetaAxisUnits = 'radians';

Display of r-axis grid lines, 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.

Example: ax.RGrid = 'off';

Display of theta-axis grid lines, 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.

Example: ax.ThetaGrid = 'off';

Placement of grid lines and tick marks in relation to graphic objects, specified as one of these values:

This property affects only 2-D views.

Example: ax.Layer = 'top'

Line style used for grid lines, specified as one of the line styles in this table.

To display grid lines, use the grid on command or set the ThetaGrid or RGrid property to 'on'.

Example: ax.GridLineStyle = '--';

Color of the grid lines, specified as an RGB triplet, a hexadecimal color code, a color name, or a short name. The actual grid color depends on the values of the GridColorMode, ThetaColorMode, and RColorMode properties. See GridColorMode for more information.

For a custom color, specify an RGB triplet or a hexadecimal color code.

Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.

Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB uses in many types of plots.

Example: ax.GridColor = [0 0 1]

Example: ax.GridColor = 'blue'

Example: ax.GridColor = '#0000FF'

Property for setting the grid color, specified as one of these values:

Grid-line transparency, specified as a value in the range [0,1]. A value of 1 means opaque and a value of 0 means completely transparent.

Example: ax.GridAlpha = 0.5

Selection mode for the GridAlpha property, specified as one of these values:

Example: ax.GridAlphaMode = 'auto'

Display of r-axis minor grid lines, 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.

Example: ax.RMinorGrid = 'on';

Display of theta-axis minor grid lines, 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.

Example: ax.ThetaMinorGrid = 'on';

Line style used for minor grid lines, specified as one of the line styles in this table.

To display the grid lines, use the grid minor command or set the ThetaMinorGrid or RMinorGrid property to 'on'.

Example: ax.MinorGridLineStyle = '-.';

Color of minor grid lines, specified as an RGB triplet, a hexadecimal color code, a color name, or a short name. The actual grid color depends on the values of the MinorGridColorMode, ThetaColorMode, and RColorMode properties. See MinorGridColorMode for more information.

For a custom color, specify an RGB triplet or a hexadecimal color code.

Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.

Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB uses in many types of plots.

Example: ax.MinorGridColor = [0 0 1]

Example: ax.MinorGridColor = 'blue'

Example: ax.MinorGridColor = '#0000FF'

Property for setting the minor grid color, specified as one of these values:

Minor grid line transparency, specified as a value in the range [0,1]. A value of 1 means opaque and a value of 0 means completely transparent.

Example: ax.MinorGridAlpha = 0.5

Selection mode for the MinorGridAlpha property, specified as one of these values:

Example: ax.MinorGridAlphaMode = 'auto'

Text object for the axes title. To add a title, set the String property of the text object. To change the title appearance, such as the font style or color, set other properties. For a complete list, see Text Properties.

ax = gca;
ax.Title.String = 'My Title';
ax.Title.FontWeight = 'normal';

Alternatively, use the title function to add a title and control the appearance.

title('My Title','FontWeight','normal')

Text object for the axes subtitle. To add a subtitle, set the String property of the text object. To change its appearance, such as the font angle, set other properties. For a complete list, see Text Properties.

ax = gca;
ax.Subtitle.String = 'An Insightful Subtitle';
ax.Subtitle.FontAngle = 'italic';

Alternatively, use the subtitle function to add a subtitle and control the appearance.

subtitle('An Insightful Subtitle','FontAngle','italic')

Or use the title function, and specify two character vector input arguments and two output arguments. Then set properties on the second text object returned by the function.

[t,s] = title('Clever Title','An Insightful Subtitle');
s.FontAngle = 'italic';

Title and subtitle horizontal alignment with an invisible box that circumscribes the polar axes, specified as one of the following values:

This property is read-only.

Legend associated with the axes, specified as a legend object. You can use this property to determine if the axes has a legend.

ax = gca;
lgd = ax.Legend
if ~isempty(lgd)
    disp('Legend Exists')
end

You also can use this property to access properties of an existing legend. For a list of properties, see Legend Properties.

polarplot(1:10)
legend({'Line 1'},'FontSize',12)
ax = gca;
ax.Legend.TextColor = 'red';

Color order, specified as a three-column matrix of RGB triplets. This property defines the palette of colors MATLAB uses to create plot objects such as Line, Scatter, and Bar objects. Each row of the array is an RGB triplet. An RGB triplet is a three-element vector whose elements specify the intensities of the red, green, and blue components of a color. The intensities must be in the range [0, 1]. This table lists the default colors.

This table lists the default colors.

MATLAB assigns colors to objects according to their order of creation. For example, when plotting lines, the first line uses the first color, the second line uses the second color, and so on. If there are more lines than colors, then the cycle repeats.

Changing the Color Order Before or After Plotting

You can change the color order in either of the following ways:

Color order index, specified as a positive integer. This property specifies the next color MATLAB selects from the axes ColorOrder property when it creates the next plot object such as a Line, Scatter, or Bar object.

Line style order, specified as a character vector, a cell array of character vectors, or a string array. This property lists the line styles that MATLAB uses to display multiple plot lines in the axes. MATLAB assigns styles to lines according to their order of creation. By default, it changes to the next line style only after cycling through all the colors in the ColorOrder property with the current line style. Set the LineStyleCyclingMethod property to "withcolor" to cycle through both together or to "beforecolor" to cycle through the line styles first. The default LineStyleOrder has only one line style, "-".

To customize the line style order, create a cell array of character vectors or a string array. Specify each element of the array as a line specifier or marker specifier from the following tables. You can combine a line and a marker specifier into a single element, such as "-*".

Changing Line Style Order Before or After Plotting

You can change the line style order before or after plotting into the axes. When you set the LineStyleOrder property to a new value, MATLAB updates the styles of any lines that are in the axes. If you continue plotting into the axes, your plotting commands continue using the line styles from the updated list.

Since R2023a

How to cycle through the line styles when there are multiple lines in the axes, specified as one of the values from this table.

The examples in this table were created using the default colors in the ColorOrder property and three line styles (["-","-o","--"]) in the LineStyleOrder property.

This property is read-only.

SeriesIndex value for the next plot object added to the axes, returned as a whole number greater than or equal to 0. This property is useful when you want to track how the objects cycle through the colors and line styles. This property maintains a count of the objects in the axes that have a numeric SeriesIndex property value. MATLAB uses it to assign a SeriesIndex value to each new object. The count starts at 1 when you create the axes, and it increases by 1 for each additional object. Thus, the count is typically n+1, where n is the number of objects in the axes.

If you manually change the ColorOrderIndex or LineStyleOrderIndex property on the axes, the value of the NextSeriesIndex property changes to 0. As a consequence, objects that have a SeriesIndex property no longer update automatically when you change the ColorOrder or LineStyleOrder properties on the axes.

Properties to reset when adding a new plot to the axes, specified as one of these values:

Figures also have a NextPlot property. Alternatively, you can use the newplot function to prepare figures and axes for subsequent graphics commands.

Order for rendering objects, specified as one of these values:

Line style order index, specified as a positive integer. This property specifies the next line style MATLAB selects from the axes LineStyleOrder property to create the next plot line.

Color map, specified as an m-by-3 array of RGB (red, green, blue) triplets that define m individual colors.

Example: ax.Colormap = [1 0 1; 0 0 1; 1 1 0] sets the color map to three colors: magenta, blue, and yellow.

MATLAB accesses these colors by their row number.

Alternatively, use the colormap function to change the color map.

Scale for color mapping, specified as one of these values:

Color limits for the colormap, specified as a two-element vector of the form [cmin cmax].

If the associated mode property is set to 'auto', then MATLAB chooses the color limits. If you assign a value to this property, then MATLAB sets the mode to 'manual' and does not automatically choose the color limits.

Selection mode for the CLim property, specified as one of these values:

Transparency map, specified as an array of finite alpha values that progress linearly from 0 to 1. The size of the array can be m-by-1 or 1-by-m. MATLAB accesses alpha values by their index in the array. An alphamap can be any length.

Scale for transparency mapping, specified as one of these values:

Alpha limits for alphamap, specified as a two-element vector of the form [amin amax].

If the associated mode property is set to 'auto', then MATLAB chooses the alpha limits. If you set this property, then MATLAB sets the mode to 'manual' and does not automatically choose the alpha limits.

Selection mode for the ALim property, specified as one of these values:

Background color, specified as an RGB triplet, a hexadecimal color code, a color name, or a short name.

For a custom color, specify an RGB triplet or a hexadecimal color code.

Alternatively, you can specify some common colors by name. This table lists the named color options, the equivalent RGB triplets, and hexadecimal color codes.

Here are the RGB triplets and hexadecimal color codes for the default colors MATLAB uses in many types of plots.

Example: ax.Color = 'none'

Width of circular and angle lines, specified as a scalar value in point units. One point equals 1/72 inch.

Example: ax.LineWidth = 1.5

Outline around the polar axes, 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.

The difference between the values is most noticeable when the theta-axis limits do not span 360 degrees.

Example: ax.Box = 'on'

Clipping of objects to the polar axes boundary, 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.

The clipping behavior of an object in the polar axes depends on both the Clipping property of the polar axes and the Clipping property of the individual object. The property value of the polar axes has these effects:

This table lists the results for different combinations of Clipping property values.

Thick lines and markers might display outside the polar axes limits, even if clipping is enabled. If a plot contains markers, then as long as the data point lies within the polar axes, MATLAB draws the entire marker.

Size and position of polar axes, including the labels and margins, specified as a four-element vector of the form [left bottom width height]. This vector defines the extents of the rectangle that encloses the outer bounds of the polar axes. The left and bottom elements define the distance from the lower-left corner of the figure or uipanel that contains the polar axes to the lower-left corner of the rectangle. The width and height elements are the rectangle dimensions.

By default, the values are measured in units normalized to the container. To change the units, set the Units property. The default value of [0 0 1 1] includes the whole interior of the container.

Inner size and location, specified as a four-element vector of the form [left bottom width height]. This property is equivalent to the Position property.

Size and location of the polar axes, not including labels or margins, specified as a four-element vector of the form [left bottom width height]. This vector defines the extents of the tightest bounding rectangle that encloses the polar axes. The left and bottom elements define the distance from the lower-left corner of the container to the lower-left corner of the rectangle. The width and height elements are the rectangle dimensions.

By default, the values are measured in units normalized to the container. To change the units, set the Units property.

Example: ax.Position = [0 0 1 1]

This property is read-only.

Margins for the text labels, returned as a four-element vector of the form [left bottom right top]. The elements define the distances between the bounds of the Position property and the extent of the polar axes text labels and title. By default, the values are measured in units normalized to the figure or uipanel that contains the polar axes. To change the units, set the Units property.

The Position property and the TightInset property define the tightest bounding box that encloses the polar axes and its labels and title.

Position property to hold constant when adding, removing, or changing decorations, specified as one of the following values:

Position units, specified as one of these values.

When specifying the units as a Name,Value pair during object creation, you must set the Units property before specifying the properties that you want to use these units, such as Position.

Layout options, specified as a TiledChartLayoutOptions or a GridLayoutOptions object. This property is useful when the axes object is either in a tiled chart layout or a grid layout.

To position the axes within the grid of a tiled chart layout, set the Tile and TileSpan properties on the TiledChartLayoutOptions object. For example, consider a 3-by-3 tiled chart layout. The layout has a grid of tiles in the center, and four tiles along the outer edges. In practice, the grid is invisible and the outer tiles do not take up space until you populate them with axes or charts.

This code places the axes ax in the third tile of the grid.

ax.Layout.Tile = 3;

To make the axes span multiple tiles, specify the TileSpan property as a two-element vector. For example, this axes spans 2 rows and 3 columns of tiles.

ax.Layout.TileSpan = [2 3];

To place the axes in one of the surrounding tiles, specify the Tile property as 'north', 'south', 'east', or 'west'. For example, setting the value to 'east' places the axes in the tile to the right of the grid.

ax.Layout.Tile = 'east';

To place the axes into a layout within an app, specify this property as a GridLayoutOptions object. For more information about working with grid layouts in apps, see uigridlayout.

If the axes is not a child of either a tiled chart layout or a grid layout (for example, if it is a child of a figure or panel) then this property is empty and has no effect.

Since R2024a

Options to customize interaction behavior, specified as a PolarAxesInteractionOptions object. Use the properties of the PolarAxesInteractionOptions object to customize the behavior of interactions with the polar axes. For a complete list of properties, see PolarAxesInteractionOptions Properties.

The options set by the PolarAxesInteractionOptions object apply to these interactions on the associated polar axes:

Example: pax.InteractionOptions.DatatipsPlacementMethod = "interpolate" allows data tips to be placed at locations on the plot that are between data points.

Data exploration toolbar, which is an AxesToolbar object. The toolbar appears at the top-right corner of the axes when you hover over it and includes options for exporting and data tips.

You can customize the toolbar buttons using the axtoolbar and axtoolbarbtn functions.

If you do not want the toolbar to appear when you hover over the axes, set the Visible property of the AxesToolbar object to 'off'.

ax = gca;
ax.Toolbar.Visible = 'off';

For more information, see AxesToolbar Properties.

Interactions, specified as a DataTipInteraction object or an empty array. When the value of this property is a DataTipInteraction object, you can display data tips within your chart without selecting any of the axes toolbar buttons.

To remove all interactions from the axes, set this property to an empty array. To temporarily disable the current set of interactions, call the disableDefaultInteractivity function. You can reenable them by calling the enableDefaultInteractivity function.

For more information about chart interactions, see Control Chart Interactivity.

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.

This property is read-only.

Location of mouse pointer, returned as a two element vector of the form [th r]. The elements of the vector indicate the location of the last click within the axes. th is the theta angle in radians, and r is the radius value. Each value is bounded by the following limits:

If the figure has a WindowButtonMotionFcn callback defined, then the value indicates the last location of the pointer. The figure also has a CurrentPoint property.

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.

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.

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.

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

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:

For more information on how to use function handles to define callback functions, see Create Callbacks for Graphics Objects.

Object creation function, specified as one of these values:

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.

Object deletion function, specified as one of these values:

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

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:

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

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

If you want an object to be clickable when it is underneath other objects that you do not want to be clickable, then set the PickableParts property of the other objects to 'none' so that the click passes through them.

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.

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 container, specified as a Figure, Panel, Tab, TiledChartLayout, or GridLayout object.

Children, returned as an array of graphics objects. Use this property to view a list of the children or to reorder the children by setting the property to a permutation of itself.

You cannot add or remove children using the Children property. To add a child to this list, set the Parent property of the child graphics object to the PolarAxes object.

Visibility of the object handle in the Children property of the parent, specified as one of these values:

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.

This property is read-only.

Type of graphics object, returned as 'polaraxes'.

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.

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.