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

1D plot groups contain graph plots.

The following properties are available for 1D plot groups:

Table 7-68: Valid Property/Value Pairs 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.
data	none | data set name	First compatible data set	The data set this feature refers to. This is the default data set for all plots in the group.
datasetintitle	on | off	off	Whether the title should contain the data set 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.
legendpos	upperright | lowerright | upperleft | lowerleft | middleright | middleleft	upperright	The position of the legends for all plots in this group.
looplevel	integer row matrix	All solutions on all levels	The solutions to use, per level.
looplevelindices	integer row matrix	Empty	An alternate 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	non-negative 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 alternate 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.
preserveaspect	on | off	off	Whether the x- and y-axis should have equal scale.
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).
solnum	Integer array	All solutions	The solutions to plot. Available when the underlying data has multiple solutions.
solnumindices	String or integer array	Empty	An alternate 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.
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.
titlecolor	custom | black | blue | cyan | green | magenta | red | white | yellow	black	The color of the title.
titletype	auto | custom | manual | none	auto	auto if the title should be computed automatically. custom if the title should be computed automatically, but customized. 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.
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.
ymax	double	Computed automatically	The maximum value of the y-axis.
ymin	double	Computed automatically	The minimum value of the y-axis.
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-69: Valid Property/Value Pairs for 2D and 3Dplot 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.
customedgecolor	RGB-triplet	{1,1,1} or last used edgecolor	The color to use when plotting data set edges. Active when edgecolor is set to custom.
data	none | data set name	parent	The data set this feature refers to. This is the default data set for all plots in the group.
datasetintitle	on | off	off	Whether the title should contain the data set when titletype is custom.
edgecolor	custom | black | blue | cyan | green | magenta | red | white | yellow	black	The color to use when plotting data set edges.
edges	on | off	on	Whether to plot data set 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	spatial	The frame used when data set edges are plotted.
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 | 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 non-negative 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.
outersolnum	non-negative integer	1	The index of the outer solutions to use Applicable only for parametric sweep models.
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.
showhiddenobjects	on | off	off	Whether objects hidden in geometry sequence should be visible in plots.
showlegends	on | off	on	Show color legends.
showlegendsmaxmin	on | off	off	Show maximum and minimum values in color legends.
solnum	non-negative 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.
suffixintitle	String	Empty	Added suffix to group contribution to title.
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.
titletype	auto | custom | manual | none	auto	auto if the title should be computed automatically. custom if the title should be computed automatically, but customized. 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 data sets such as solution or mesh data sets 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.

See Also

PolarGroup, Solution, SmithGroup