PlotGroup1D, PlotGroup2D, PlotGroup3D
Create a 1D, 2D, or 3D plot group.
Syntax
model.result().create(<pgtag>, dim);
model.result(<pgtag>).set(property,<value>);
model.result(<pgtag>).selection()...;
model.result(<pgtag>).run();
Description
model.result().create(<pgtag>,dim) creates a plot group named <pgtag> of view dimension dim. A plot group is a group of plots that are shown together in a graphics or plot window.
2D and 3D plot groups can include selections of geometric entities. See Selections.
1D plot groups contain graph plots. In the list of properties below, properties related to manual color legend settings are marked with on asterisk (*) and are only available if the 1D plot group includes any is any plot that has a color expression.
The following properties are available for 1D plot groups:
Table 7-107: Valid Properties for 1D plot groups.
name
Value
Default
Description
axisactive
on | off
off
Use manual axis formatting settings.
axiscommonexp
on | off
on
Use a common exponent for all axis values.
axisnotation
automatic | engineering | scientific
automatic
Use an automatic notation (decimal or scientific) for axis values or always use engineering or scientific notation.
axisprecision
positive integer
4
Precision for number format (number of digits).
axistrailingzeros
on | off
off
Show trailing zeros for axis values.
colorlegendpos
alternating | bottom | left | leftdouble | right | rightdouble
right
The position of the legends for all plots in this group (when a Color Expression has been added).
config
configuration name
 
The configuration to use for the solution times or parameters, if solutionparams is set to configuration.
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.
dateintitle
on | off
off
Whether the title contribution of plots in this group should contain the current date when titletype is custom.
descriptionintitle
on | off
on
Whether the title contribution of plots in this group should contain the description 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.
filenameintitle
on | off
off
Whether the title contribution of plots in this group should contain the name of the MPH-file 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.
legendactive*
on | off
off
Use manual color legend formatting settings.
legendcolumncount
positive integer
1
The number of columns of legends. If legendposoutside is set to bottom or top, use legendrowcount instead.
legendcommonexp*
on | off
on
Use a common exponent for all color legend values.
legendlayout
inside | outside
inside
Show legends inside of or outside of the graphics axis area.
legendmaxwidthinside
between 0 and 1
0.5
Maximum relative legend width, if legendlayout is set to inside.
legendnotation*
automatic | engineering | scientific
automatic
Use an automatic notation (decimal or scientific) for color legend values or always use engineering or scientific notation.
legendpos
upperright | middleright | lowerright | upperleft | middleleft | lowerleft | middleright | center | middleleft | manual
upperright
The position of the legends for all plots in this group, if legendlayout is set to inside. Choose manual to specify the exact position.
legendposoutside
bottom | left | right | top
right
The position of the legends for all plots in this group, if legendlayout is set to outside.
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.
legendprecision*
positive integer
3
Precision for number format (number of digits).
legendrowcount
positive integer
1
The number of rows of legends if legendposoutside is set to bottom or top.
legendtrailingzeros*
on | off
off
Show trailing zeros for axis values.
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 xspacing and yspacing.
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.
paramindicator
String
 
The parameter indicator to use when titletype is manual.
phase
double
0
The phase angle for the solution, if phasetype is manual.
phaseintitle
on | off
off
Whether the title should contain the phase when titletype is custom.
phasetype
fromdataset | manual
fromdataset
The source for the phase (solution at angle): from dataset or manual, if the solution dataset is applicable.
prefixintitle
String
Empty
Added prefix to group contribution to title.
preserveaspect
on | off
off
Whether the x- and y-axis should have equal scale.
savedatainmodel
true | false
false
Save plot data in the model.
showgrid
on | off
on
Display the grid in the plot.
showlegendsmaxmin
on | off
off
Show maximum and minimum values for color legends (when a Color Expression has been added).
showlegendsunit
on | off
off
Show units 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.
solutionparams
manual | configuration
manual
Specify solution parameters directly (manual) or from a configuration.
suffixintitle
String
Empty
Added suffix to group contribution to title.
switchxy
on | off
off
Switch the data on the x- and y-axes in 1D plot groups.
t
double array
Empty
The times to plot. Available when the underlying solution is transient.
timeintitle
on | off
off
Whether the title contribution of plots in this group should contain the current time when titletype is custom.
title
String
The auto-title.
The title to use when titletype is manual.
titlealwaysimaginary
true | false
false
Always show the imaginary part when titlenumberformat is stopwatch or stopwatchsci.
titlealwayssign
true | false
false
Always show the sign when titlenumberformat is stopwatch or stopwatchsci.
titlealwayssignexp
true | false
false
Always show the sign of the exponent when titlenumberformat is stopwatchsci.
titlecolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
black
The color of the title.
titledecimals
positive integer
3
The number of decimals for numerical values in the title when titlenumberformat is stopwatch or stopwatchsci.
titleexponentdigits
positive integer
1
The number of exponent digits (1–3) for numerical values in the title when titlenumberformat is stopwatchsci.
titleintegerdigits
positive integer
3
The number of integer digits for numerical values in the title when titlenumberformat is stopwatch.
titlenumberformat
default | auto | engineering | scientific | stopwatch | stopwatchsci
default
The number format for the title: default, automatic, engineering, scientific, stopwatch, or scientific stopwatch.
titleparamindicator
true | false
true
Add a parameter indicator to the plot title, when titletype is custom.
titleprecision
positive integer
6
The precision for numerical values in the title when titlenumberformat is auto, engineering, or scientific.
titletrailingzeros
true | false
false
Include trailing zeros when titlenumberformat is auto, engineering, or scientific.
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.
twoyaxes
true | false
false
Use two y-axes.
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.
xextra
double array
Empty
Extra grid points to include along the x-axis.
xlabel
String
Empty
The label on the x-axis.
xlabelactive
on | off
off
on if a manual x-axis label should be used, off if it should be computed automatically.
xlog
on | off
off
Whether to use a logarithmic scale along the x-axis.
xmax
double
Computed automatically
The maximum value of the x-axis.
xmin
double
Computed automatically
The minimum value of the x-axis.
xspacing
double
Computed automatically
The grid spacing on the x-axis. Used if manualgrid is set to on.
yextra
double array
Empty
Extra grid points to include along the y-axis
ylabel
String
Empty
The label on the y-axis.
ylabelactive
on | off
off
on if a manual y-axis label should be used, off if it should be computed automatically.
ylog
on | off
off
Whether to use a logarithmic scale along the y-axis.
ylogsec
on | off
off
Whether to use a logarithmic scale along the secondary y-axis.
ymax
double
Computed automatically
The maximum value of the y-axis.
ymaxsec
double
Computed automatically
The maximum value of the secondary y-axis.
ymin
double
Computed automatically
The minimum value of the y-axis.
yminsec
double
Computed automatically
The minimum value of the secondary y-axis.
ysecextra
double array
Empty
Extra grid points to include along the secondary y-axis.
yseclabel
String
Empty
The label on the secondary y-axis.
yseclabelactive
on | off
off
on if a manual secondary y-axis label should be used, off if it should be computed automatically.
ysecspacing
double
Computed automatically
The grid spacing on the secondary y-axis. Used of manualgrid is set to on.
yspacing
double
Computed automatically
The grid spacing on the y-axis. Used of manualgrid is set to on.
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.
The following properties are available for 2D and 3D plot groups:
Table 7-108: Valid Properties for 2D and 3D plot groups.
name
Value
Default
Description
arrayaxis
x | y | z (3D only)
x
The array axis, if arrayshape is linear.
arrayplane
xy | yz | xz
xy
The array plane, if arrayshape is square in a 3D plot group.
arrayshape
linear | square
linear
The plot array shape, if plotarrayenable is set to on.
axisactive
on | off
off
Use manual axis formatting settings.
axiscommonexp
on | off
on
Use a common exponent for all axis values.
axisnotation
automatic | engineering | scientific
automatic
Use an automatic notation (decimal or scientific) for axis values or always use engineering or scientific notation.
axisprecision
positive integer
4
Precision for number format (number of digits).
axistrailingzeros
on | off
off
Show trailing zeros for axis values.
celldisp
double
0
The cell displacement, if displacementlinear is set to absolute.
columndisp
double
0
The column cell displacement, if displacementsquare is set to absolute.
columnpadding
double
0
Absolute column padding for a square plot array.
config
configuration name
 
The configuration to use for the solution times or parameters, if solutionparams is set to configuration.
customedgecolor
RGB-triplet
{1,1,1} or last used edgecolor
The color to use when plotting dataset edges. Active when edgecolor is set to custom.
data
none | dataset name
parent
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.
displacementlinear
relative | absolute
relative
Displacement of a linear plot array: relative or absolute.
displacementsquare
relative | absolute
relative
Displacement of a square plot array: relative or absolute.
edgecolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
black
The color to use when plotting dataset edges.
edges
on | off
on
Whether to plot dataset edges.
expressionintitle
on | off
off
Whether the title contribution of plots in this group should contain the expression when titletype is custom.
frametype
mesh | material | spatial | geometry | fromdataset
spatial
The frame used when dataset edges are plotted. Use fromdataset to take the frame from the dataset.
inherithide
on | off
off
Whether to propagate hiding of objects to lower dimensions in plots.
interp
double array
Time corresponding to last selected solnum for transient levels
The time to use, for transient levels. Available when data is not none and the underlying data is transient.
legendactive
on | off
off
Use manual color legend formatting settings.
legendcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
black
How to color the values in the color legend.
legendcommonexp
on | off
on
Use a common exponent for all color legend values.
legendnotation
automatic | engineering | scientific
automatic
Use an automatic notation (decimal or scientific) for color legend values or always use engineering or scientific notation.
legendprecision
positive integer
3
Precision for number format (number of digits).
legendpos
alternating | bottom | left | leftdouble | right | rightdouble
right
The position of the legends for all plots in this group.
legendtrailingzeros
on | off
off
Show trailing zeros for axis values.
looplevel
array of nonnegative integers and strings
Last solution for transient or parametric solution for each level. Otherwise, first solution for each level.
The index of the solution to use, per level, or interp, but only for transient solutions. Available when data is not none and the underlying data has multiple solutions.
order
rowmajor | columnmajor
rowmajor
The ordering of a square plot array: row-major or column-order.
outersolnum
nonnegative integer
1
The index of the outer solutions to use Applicable only for parametric sweep models.
padding
double
0
Absolute padding for a linear plot array.
paddinglinear
relative | absolute
relative
Padding of a linear plot array, if displacementlinear is set to relative: relative or absolute.
paddingsquare
relative | absolute
relative
Padding of a square plot array, if displacementsquare is set to relative: relative or absolute.
paramindicator
String
 
The parameter indicator to use when titletype is manual.
phase
double
0
The phase angle for the solution, if phasetype is manual.
phaseintitle
on | off
off
Whether the title should contain the phase when titletype is custom.
phasetype
fromdataset | manual
fromdataset
The source for the phase (solution at angle): from dataset or manual, if the solution dataset is applicable.
plotarrayenable
on | off
off
Enable that the plots in the plot group form a plot array.
prefixintitle
String
Empty
Added prefix to group contribution to title.
relcolumnpadding
double
0.3
Relative column padding for a square plot array.
relpadding
double
0.3
Relative padding for a linear plot array.
relrowpadding
double
0.3
Relative row padding for a square plot array.
rowdisp
double
0
The row cell displacement, if displacementsquare is set to absolute.
rowpadding
double
0
Absolute row padding for a square plot array.
showhiddenobjects
on | off
off
Whether hidden objects should be visible in plots.
showlegends
on | off
on
Show color legends.
showlegendsmaxmin
on | off
off
Show maximum and minimum values in color legends.
showlegendsunit
on | off
off
Show the unit above the color legend.
solnum
nonnegative integer
Last solution for transient or parametric solution. Otherwise, first solution.
The index of the solution to use. Available when the underlying data has multiple solutions.
solrepresentation
solnum | solutioninfo
solutioninfo
Indicates which method of selecting solutions is active.
solutionintitle
on | off
on
Whether the title should contain the solution when titletype is custom.
solutionparams
manual | configuration
manual
Specify solution parameters directly (manual) or from a configuration.
suffixintitle
String
Empty
Added suffix to group contribution to title.
symmetryaxis
true | false
false
Show the symmetry axis in the plot (for 2D axisymmetric plot only).
t
double
Time corresponding to last selected solnum
The time to use, for transient problems. If it is not available in any solnum, the time is interpolated in the solution.
timeinterp
on | off
off
on if t is used to determine time steps; off if solnum is used.
title
String
The auto-title
The title to use when titletype is manual.
titleparamindicator
true | false
true
Add a parameter indicator to the plot title, when titletype is custom.
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.
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.
view
auto | view name
auto
The view settings to use when displaying this plot group. auto indicates that the view is selected automatically, or be created if there is none. Typically geometry-based datasets such as solution or mesh datasets use the current geometry view.
Surface plots with height attributes do not use the view setting.
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.
xlabel
String
Empty
The label on the x-axis. Available for 2D plot groups.
xlabelactive
on | off
off
on if a manual x-axis label should be used, off if it should be computed automatically. Available for 2D plot groups.
ylabel
String
Empty
The label on the y-axis. Available for 2D plot groups.
ylabelactive
on | off
off
on if a manual y-axis label should be used, off if it should be computed automatically. Available for 2D plot groups.
2D and 3D Plot Properties for Plot Arrays
When you have enabled the plotarrayenable property for a 2D or 3D plot group, all plots in that plot group support a few extra properties related to the plot array. See the following table for information about those properties:
Table 7-109: Properties for Plots in 2D and 3D Plot Groups with Plot Arrays.
Name
Value
Default
Description
applytodatasetedgesplotarr
true | false
true
Make the plot array apply to dataset edges.
arrayindex
0 or positive integer
0
The array index if manualindexing is set to true for a linear plot array.
belongstoplotarray
true | false
true
True if the plot belongs to the plot array.
colindex
0 or positive integer
0
The column index if manualindexing is set to true for a square plot array.
 
manualindexing
true | false
false
Use manual 0-based indexing for the position of this plot.
rowindex
0 or positive integer
0
The row index if manualindexing is set to true for a square plot array.
See Also
EvaluationGroup, PolarGroup, Solution, SmithGroup