PolarPattern Properties

Control appearance and behavior of polar plot

expand all in page

Polar pattern properties control the appearance and behavior of the polar pattern object. By changing property values, you can modify certain aspects of the polar plot. To change the default properties use:

p = polarpattern(____,Name,Value)

To view all the properties of the polar pattern object use:

details(p)

You can also interact with the polar plot to change the properties. For more information, see Interact with Polar Plot.

Antenna Metrics

expand all

Show antenna metrics, specified as a comma-separated pair consisting of 'AntennaMetrics' and 0 or 1. Antenna metric displays main, back, and side lobes of antenna/array pattern passed as input.

Data Types: logical

Maximum number of peaks to compute for each data set, specified as a comma-separated pair consisting of 'Peaks' and a positive scalar or vector of integers.

Data Types: double

Angle Properties

expand all

Angle at the top of the polar plot, specified as a comma-separated pair consisting of 'AngleAtTop' and a scalar in degrees.

Data Types: double

Visible polar angle span, specified as a comma-separated pair consisting of 'AngleLim' and a 1-by-2 vector of real values.

Data Types: double

Show interactive angle limit cursors, specified as a comma-separated pair consisting of 'AngleLimVisible' and 0 or 1.

Data Types: logical

Direction of increasing angle, specified as a comma-separated pair consisting of 'AngleDirection' and 'ccw' (counterclockwise) or 'cw' (clockwise).

Data Types: char

Number of degrees between radial lines depicting angles in the polar plot, specified as a comma-separated pair consisting of 'AngleResolution' and a scalar in degrees.

Data Types: double

Rotate angle tick labels, specified as a comma-separated pair consisting of 'AngleTickLabelRotation' and 0 or 1.

Data Types: logical

Show angle tick labels, specified as a comma-separated pair consisting of 'AngleTickLabelVisible' and 0 or 1.

Data Types: logical

Format for angle tick labels, specified as a comma-separated pair consisting of 'AngleTickLabelFormat' and 360 degrees or 180 degrees.

Data Types: double

Scale factor of angle tick font, specified as a comma-separated pair consisting of 'AngleFontSizeMultiplier' and a numeric value greater than zero.

Data Types: double

Show angle span measurement, specified as a comma-separated pair consisting of 'Span' and 0 or 1.

Data Types: logical

Highlight radial line at zero degrees, specified as a comma-separated pair consisting of 'ZeroAngleLine' and 0 or 1.

Data Types: logical

Show gaps in line plots with nonuniform angle spacing, specified as a comma-separated pair consisting of 'DisconnectAngleGaps' and 0 or 1.

Data Types: logical

Magnitude Properties

expand all

Angle of magnitude tick label radial line, specified as a comma-separated pair consisting of 'MagnitudeAxisAngle' and real scalar in degrees.

Data Types: double

Magnitude ticks, specified as a comma-separated pair consisting of 'MagnitudeTick' and a 1-by-N vector, where N is the number of magnitude ticks.

Data Types: double

Show magnitude tick labels, specified as a comma-separated pair consisting of 'MagnitudeTickLabelVisible' and 0 or 1.

Data Types: logical

Minimum and maximum magnitude limits, specified as a comma-separated pair consisting of 'MagnitudeLim' and a two-element vector of real values.

Data Types: double

Determine magnitude dynamic range, specified as a comma-separated pair consisting of 'MagnitudeLimMode' and 'auto' or 'manual'.

Data Types: char

Determine angle for magnitude tick labels, specified as a comma-separated pair consisting of 'MagnitudeAxisAngleMode' and 'auto' or 'manual'.

Data Types: char

Determine magnitude tick locations, specified as a comma-separated pair consisting of 'MagnitudeTickMode' and 'auto' or 'manual'.

Data Types: char

Magnitude units, specified as a comma-separated pair consisting of 'MagnitudeUnits' and 'db' or 'dBLoss'.

Data Types: char

Scale factor of magnitude tick font, specified as a comma-separated pair consisting of 'MagnitudeFontSizeMultiplier' and a numeric value greater than zero.

Data Types: double

Miscellaneous Properties

expand all

Normalize each data trace to maximum value, specified as a comma-separated pair consisting of 'NormalizeData' and 0 or 1.

Data Types: logical

Connect first and last angles, specified as a comma-separated pair consisting of 'ConnectEndpoints' and 0 or 1.

Data Types: logical

Style of polar plot display, specified as a comma-separated pair consisting of 'Style' and 'line' or 'filled'.

Data Types: char

Create a temporary cursor, specified as a comma-separated pair consisting of 'TemporaryCursor' and 0 or 1.

Data Types: logical

Show tool tips when you hover over a polar plot element, specified as a comma-separated pair consisting of 'ToolTips' and 0 or 1.

Data Types: logical

Clip data to outer circle, specified as a comma-separated pair consisting of 'ClipData' and 0 or 1.

Data Types: logical

Directive on how to add next plot, specified as a comma-separated pair consisting of 'NextPlot' and one of the values in the table:

Property ValueEffect
'new'

Creates a figure and uses it as the current figure.

'add'

Adds new graphics objects without clearing or resetting the current figure.

'replace'

Removes all axes objects and resets figure properties to their defaults before adding new graphics objects.

Legend and Title Properties

expand all

Data tables for legend annotation, specified as a comma-separated pair consisting of 'LegendLabels' and a character vector or cell array of character vectors. Ⓐ denotes the active line for interactive operation.

Data Types: char

Show legend label, specified as a comma-separated pair consisting of 'LegendVisible' and 0 or 1.

Data Types: logical

Title to display above the polar plot, specified as a comma-separated pair consisting of 'TitleTop' and a character vector.

Data Types: char

Title to display below the polar plot, specified as a comma-separated pair consisting of 'TitleBottom' and a character vector.

Data Types: char

Offset between top title and angle ticks, specified as a comma-separated pair consisting of 'TitleTopOffset' and a scalar. The value must be in the range [-0.5,0.5].

Data Types: double

Offset between bottom title and angle ticks, specified as a comma-separated pair consisting of 'TitleBottomOffset' and a scalar. The value must be in the range [-0.5,0.5].

Data Types: double

Scale factor of top title font, specified as a comma-separated pair consisting of 'TitleTopFontSizeMultiplier' and a numeric value greater than zero.

Data Types: double

Scale factor of bottom title font, specified as a comma-separated pair consisting of 'TitleBottomFontSizeMultiplier' and a numeric value greater than zero.

Data Types: double

Thickness of top title font, specified as a comma-separated pair consisting of 'TitleTopFontWeight' and 'bold' or 'normal.

Data Types: char

Thickness of bottom title font, specified as a comma-separated pair consisting of 'TitleBottomFontWeight' and 'bold' or 'normal.

Data Types: char

Interpretation of top title characters, specified as a comma-separated pair consisting of 'TitleTopTextInterpreter' and:

  • 'tex' — Interpret using a subset of TeX markup

  • 'latex' — Interpret using LaTeX markup

  • 'none' — Display literal characters

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

This table lists the supported modifiers when the TickLabelInterpreter property is set to 'tex', which is the default value. Modifiers remain in effect until the end of the text, except for superscripts and subscripts which only modify the next character or text within curly braces {}.

ModifierDescriptionExample
^{ }Superscript'text^{superscript}'
_{ }Subscript'text_{subscript}'
\bfBold font'\bf text'
\itItalic font'\it text'
\slOblique font (rarely available)'\sl text'
\rmNormal font'\rm text'
\fontname{specifier}Set specifier as the name of a font family to change the font style. You can use this modifier with other modifiers.'\fontname{Courier} text'
\fontsize{specifier}Set specifier as a scalar numeric value to change the font size.'\fontsize{15} text'
\color{specifier}Set specifier as one of these colors: red, green, yellow, magenta, blue, black, white, gray, darkGreen, orange, or lightBlue.'\color{magenta} text'
\color[rgb]{specifier}Set specifier as a three-element RGB triplet to change the font color.'\color[rgb]{0,0.5,0.5} text'

LaTeX Markup

To use LaTeX markup, set the TickLabelInterpreter property to 'latex'. 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 reduces by about 10 characters per line.

Data Types: char

Interpretation of bottom title characters, specified as a comma-separated pair consisting of 'TitleBottomTextInterpreter' and:

  • 'tex' — Interpret using a subset of TeX markup

  • 'latex' — Interpret using LaTeX markup

  • 'none' — Display literal characters

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

This table lists the supported modifiers when the TickLabelInterpreter property is set to 'tex', which is the default value. Modifiers remain in effect until the end of the text, except for superscripts and subscripts which only modify the next character or the text within the curly braces {}.

ModifierDescriptionExample
^{ }Superscript'text^{superscript}'
_{ }Subscript'text_{subscript}'
\bfBold font'\bf text'
\itItalic font'\it text'
\slOblique font (rarely available)'\sl text'
\rmNormal font'\rm text'
\fontname{specifier}Set specifier as the name of a font family to change the font style. You can use this modifier with other modifiers.'\fontname{Courier} text'
\fontsize{specifier}Set specifier as a scalar numeric value to change the font size.'\fontsize{15} text'
\color{specifier}Set specifier as one of these colors: red, green, yellow, magenta, blue, black, white, gray, darkGreen, orange, or lightBlue.'\color{magenta} text'
\color[rgb]{specifier}Set specifier as a three-element RGB triplet to change the font color.'\color[rgb]{0,0.5,0.5} text'

LaTeX Markup

To use LaTeX markup, set the TickLabelInterpreter property to 'latex'. 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 reduces by about 10 characters per line.

Data Types: char

Grid Properties

expand all

Draw grid over data plots, specified as a comma-separated pair consisting of 'GridOverData' and 0 or 1.

Data Types: logical

Draw radial lines within innermost circle of the polar plot, specified as a comma-separated pair consisting of 'DrawGridToOrigin' and 0 or 1.

Data Types: logical

Increase angle resolution in the polar plot, specified as a comma-separated pair consisting of 'GridAutoRefinement' and 0 or 1. This property increases angle resolution by doubling the number of radial lines outside each magnitude.

Data Types: logical

Width of grid lines, specified as a comma-separated pair consisting of 'GridWidth' and a positive scalar.

Data Types: double

Show grid lines, including magnitude circles and angle radii, specified as a comma-separated pair consisting of 'GridVisible' and 0 or 1.

Data Types: logical

Color of foreground grid lines, specified as a comma-separated pair consisting of 'GridForeGroundColor' and an RGB triplet, character vector of color names, or 'none'.

RGB triplets and hexadecimal color codes are useful for specifying custom colors.

  • 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 character vector or a string scalar 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. Thus, 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 NameShort NameRGB TripletHexadecimal Color CodeAppearance
'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'

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

RGB TripletHexadecimal Color CodeAppearance
[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'

Data Types: double | char

Color of background grid lines, specified as a comma-separated pair consisting of 'GridBackGroundColor' and an RGB triplet, character vector of color names, or 'none'.

RGB triplets and hexadecimal color codes are useful for specifying custom colors.

  • 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 character vector or a string scalar 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. Thus, 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 NameShort NameRGB TripletHexadecimal Color CodeAppearance
'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'

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

RGB TripletHexadecimal Color CodeAppearance
[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'

Data Types: double | char

Marker, Color, Line, and Font Properties

expand all

Marker symbol, specified as a comma-separated pair consisting of 'Marker' and either 'none' or one of the symbols in this table. By default, a line does not have markers. Add markers at selected points along the line by specifying a marker.

ValueDescription
'o'Circle
'+'Plus sign
'*'Asterisk
'.'Point
'x'Cross
'_'Horizontal line
'|'Vertical line
'square' or 's'Square
'diamond' or 'd'Diamond
'^'Upward-pointing triangle
'v'Downward-pointing triangle
'>'Right-pointing triangle
'<'Left-pointing triangle
'pentagram' or 'p'Five-pointed star (pentagram)
'hexagram' or 'h'Six-pointed star (hexagram)
'none'No markers

Marker size, specified as a comma-separated pair consisting of 'MarkerSize' and a positive value in point units.

Data Types: double

Colors to use for multi-line plots, specified as a comma-separated pair consisting of 'ColorOrder' and a three-column matrix of RGB triplets. Each row of the matrix defines one color in the color order.

Data Types: double

Next color to use in color order, specified as a comma-separated pair consisting of 'ColorOrderIndex' and a positive integer. New plots added to the axes use colors based on the current value of the color order index.

Data Types: double

Color of data lines, specified as a comma-separated pair consisting of 'EdgeColor' and a character vector of color names or RGB triplet vector.

RGB triplets and hexadecimal color codes are useful for specifying custom colors.

  • 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 character vector or a string scalar 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. Thus, 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 NameShort NameRGB TripletHexadecimal Color CodeAppearance
'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'

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

RGB TripletHexadecimal Color CodeAppearance
[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'

Data Types: double | char

Line style of the plot, specified as a comma-separated pair consisting of 'LineStyle' and one of the symbols in the table:

SymbolLine StyleResulting Line
'-'Solid line

'--'Dashed line

':'Dotted line

'-.'Dash-dotted line

'none'No lineNo line

Line width of the plot, specified as a comma-separated pair consisting of 'LineWidth' and a positive scalar or vector.

Font size of text in the plot, specified as a comma-separated pair consisting of 'FontSize' and a positive scalar.

Set font size, specified as a comma-separated pair consisting of 'FontSizeAutoMode' and 'auto' or 'manual'.

Data Types: char

See Also

Antenna Toolbox Documentation

Support