PolarGroup
Create a polar plot group.
Syntax
model.result().create(<pgtag>, "PolarGroup");
model.result(<pgtag>).set(property, <value>);
model.result(<pgtag>).run();
Description
model.result().create(<pgtag>,"PolarGroup") creates a polar plot group named <pgtag>. A polar plot group displays the containing graph plots in a polar coordinate system.
The following properties are available for polar plot groups:
Table 7-110: Valid Property/Value Pairs for polar plot groups
name
Value
Default
Description
angularunit
degrees | radians
degrees
The angular unit: degrees or radians.
data
none | dataset name
First compatible dataset
The dataset this feature refers to. This is the default dataset for all plots in the group.
datasetintitle
on | off
off
Whether the title should contain the dataset when titletype is custom
expressionintitle
on | off
off
Whether the title contribution of plots in this group should contain the expression when titletype is custom
innerinput
all | first | last | manual | manualindices | interp
all
How to input the solution to use. manual indicates that solnum is used. manualindices indicates that solnumindices is used. interp indicates that t is used.
interp
double row matrix
Empty on all levels.
The times to use, for transient levels. Available when data is not none and the underlying data is transient.
legendpos
upperright | middleright | lowerright | upperleft | middleleft | lowerleft | middleright | center | middleleft | manual
upperright
The position of the legends for all plots in this group. Choose manual to specify the exact position.
legendposx
double
1
The x-position (0-1) for the legend position when legendpos is set to manual.
legendposy
double
1
The y-position (0-1) for the legend position when legendpos is set to manual.
looplevel
integer row matrix
All solutions on all levels
The solutions to use, per level
looplevelindices
integer row matrix
Empty
An alternative way to specify the solutions to use, allowing you to enter, for example, range(1,1,20). Applicable when looplevelinput is manualindices on a level.
looplevelinput
String array with all | first | last | manual | manualindices | interp on each level
all on all levels
How to input the solution to use, per level. manual on a level indicates that looplevel is used on that level. manualindices on a level indicates that looplevelindices is used on that level. interp on a level indicates that interp is used on that level.
manualgrid
on | off
off
Whether to use the automatic grid spacing or the grid settings specified in rspacing and tspacing.
outerinput
all | first | last | manual | manualindices
all
How to input the outer solutions to use. Applicable only for parametric sweep models. manual indicates that outersolnum is used. manualindices indicates that outersolnumindices is used.
outersolnum
nonnegative integer array
1
The index of the outer solutions to use. Applicable only for parametric sweep models. Since the various outer solutions can have different number of solnum, the solnum property is not used.
outersolnumindices
String or integer array
Empty
An alternative way to specify the outer solutions to use, allowing you to enter, for example, range(1,1,20). Applicable when outerinput is manualindices.
phaseintitle
on | off
off
Whether the title should contain the phase when titletype is custom.
prefixintitle
String
Empty
Added prefix to group contribution to title.
rextra
double array
Empty
Extra grid points to include along the r-axis
rmax
double
Computed automatically
The maximum value of the r-axis
rmin
double
Computed automatically
The minimum value of the r-axis
rotdir
ccw | cw
ccw
Rotation direction: counterclockwise or clockwise.
rspacing
double
Computed automatically
The grid spacing on the r-axis. Used if manualgrid is set to on.
showlegendsmaxmin
on | off
off
Show maximum and minimum values for color legends (when a Color Expression has been added).
solnum
Integer array
All solutions
The solutions to plot. Available when the underlying data has multiple solutions.
solnumindices
String or integer array
Empty
An alternative way to specify the solutions to use, allowing you to enter, for example, range(1,1,20). Applicable when innerinput is manualindices.
solrepresentation
solnum | solutioninfo
solutioninfo
Indicates which method of selecting solutions is active
suffixintitle
String
Empty
Added suffix to group contribution to title
symmetricangle
on | off
off
Display angles as +-180 degrees around zero instead as a full 360 degree revolution.
t
double array
Empty
The times to plot. Available when the underlying solution is transient.
textra
double array
Empty
Extra grid points to include along the θ-axis, in degrees
title
String
The auto-title.
The title to use when titletype is manual
titletype
auto | custom | label | manual | none
auto
auto, if the title should be computed automatically. custom, if the title should be computed automatically, but customized. label, if the title should be the plot group’s label. manual, if the manual title should be used (the title property). none, if no title should be displayed.
tspacing
double
Computed automatically
The grid spacing on the θ-axis. Used of manualgrid is set to on.
typeintitle
on | off
on
Whether the title contribution of plots in this group should contain the type when titletype is custom
unitintitle
on | off
on
Whether the title contribution of plots in this group should contain the unit when titletype is custom
window
graphics | new | windowX, where X is an integer
graphics
The window where the plot group is displayed. When plotting on a graphics server, graphics is equivalent to new.
windowtitle
String
Computed automatically
The title to use for the window where the plot group is displayed. It is not possible to change the title of the graphics window.
windowtitleactive
on | off
off
Set windowtitleactive to on to enter a manual window title in windowtitle
zeroangle
right | up | left | down
right
Direction of the zero angle.
See Also
PlotGroup1D, PlotGroup2D, PlotGroup3D, SmithGroup