Global (Plot)
Create a global plot for 1D plot groups and polar plot groups.
Syntax
model.result(<pgtag>).create(<ftag>,"Global");
model.result(<pgtag>).feature(<ftag>).set(property, <value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
model.result(<pgtag>).create(<ftag>,"Global") creates a plot feature named <ftag> belonging to the plot group <pgtag>.
Global plot is used to visualize defined variables, such as solutions to ODEs or coupling operators with a destination. Global plots can be added to 1D and polar plot groups.
The following properties are available:
Table 7-39: Valid Property/Value Pairs for Global Plots
name
Value
Default
Description
autodescr
on | off
Model dependent
Whether the automatic legends should include the expression descriptions.
autoexpr
on | off
Model dependent
Whether the automatic legends should include the expressions.
autolegends
on | off
on
Whether to use the automatically computed legends or the legends defined in the legends property. The automatic legends display the description and expression for each line.
autounit
on | off
off
Whether the automatic legends should include the unit.
const
String array of property/value pairs
Empty
Parameters to use in the expressions.
customlinecolor
RGB-triplet
{0,0,1} or last used edgecolor.
The color to use for the lines. Active when linecolor is set to custom.
data
none | parent | dataset name
parent
The dataset this feature refers to.
descr
String array
Model-dependent.
The description of the expressions in expr. Is used in the automatic legends.
descriptionintitle
on | off
on
Whether the title contribution should contain the description when titletype is custom.
differential
on | off
on
Whether the expression should be linearized at the linearization point. Applicable only if evalmethod is harmonic.
evalmethod
linpoint | harmonic | lintotal | lintotalavg | lintotalrms | lintotalpeak
harmonic
Applicable only for solutions with a stored linearization point. Controls if the linearization point, the perturbation, or a combination should be used when evaluating the expression.
expr
String array
Model-dependent.
The expressions to plot.
expressionintitle
on | off
off
Whether the title contribution should contain the expression when titletype is custom.
freqmax
integer
 
If xaxisdata is spectrum and freqrangeactive is true: The upper frequency bound.
freqmin
integer
 
If xaxisdata is spectrum and freqrangeactive is true: The lower frequency bound.
freqrangeactive
on | off
false
If xaxisdata is spectrum: Controls whether a manual frequency range is used.
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 parent and the underlying data is transient.
legend
on | off
off
Whether to show legends.
legendmethod
automatic | manual
automatic
Whether to use the automatic legends or the legends supplied in the legends property.
legendprefix
String
 
A prefix added to the automatic legend.
legends
String array
The last computed automatic legends.
Manual legends active when legendmethod is set to manual.
legendsuffix
String
 
A suffix added to the automatic legend.
linecolor
custom | cycle | black | blue | cyan | gray | green | magenta | red | white | yellow
cycle
How to color the lines in the graph. Cycle indicates that the colors is different for each line.
linewidth
double
0.5
The line width.
linemarker
none | cycle | asterisk | circle | diamond | plus | point | square | star | triangle
none
The line markers, if any. Cycle indicates that the marker is different for each line.
linestyle
none | cycle | solid | dotted | dashed | dashdot
solid
The line style, if any. Cycle indicates that the line style is different for each line.
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.
markerpos
interp | datapoints
interp
Controls whether the positions of the markers are in the data points of the plot, or interpolated depending on the number (set in markers). Markers are visible when linemarker is set.
markers
integer
8
The number of markers to show. Markers are visible when linemarker is set.
nfreqs
integer
1
If xaxisdata is spectrum and nfreqsactive is true: The number of frequencies to plot.
nfreqsactive
Boolean
false
If xaxisdata is spectrum: Controls whether the number of frequencies is set manually.
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.
plotonsecyaxis
Boolean
true
Plot on secondary y-axis, if twoyaxes is set to true in the parent plot group.
prefixintitle
String
Empty
Added prefix to contribution to title.
refine
nonnegative integer
1
Refinement of the time resolution for time-dependent studies (an integer 1–1000).
scale
Boolean
false
If xaxisdata is spectrum: The frequency spectrum is transformed so that it has the same scale as the original data.
solnum
nonnegative integer array
All solutions
The solutions to plot. Available when data is not parent and 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 contribution to title.
t
double array
Empty
The times to plot. Available when data is not parent and the underlying solution is transient.
title
String
The auto-title.
The title to use when titletype is manual.
titletype
auto | custom | manual | none
auto
auto if the title contribution should be computed automatically, possibly using the group’s customization. custom if the title contribution should be computed automatically, but customized. manual if the manual title contribution should be used (the title property). none if no title contribution should be used.
typeintitle
on | off
on
Whether the title contribution should contain the type when titletype is custom.
unit
String
Model-dependent
The unit to use for the expression in expr. If the old unit is not valid when the expression changes, the unit property is reset to default.
unitintitle
on | off
on
Whether the title contribution should contain the unit when titletype is custom.
xdata
expr | solution | spectrum | phase
solution
x-axis data. expr uses the expression in xdataexpr. solution uses the available solutions in the underlying dataset, such as time steps. phase uses a phase range, and rearranged phase plots.
xdataexpr
String
Model-dependent
Expression for x-axis data.
xdatadescr
String
Model-dependent
Description of expression in xdataexpr.
xdataphaserange
double array
range(0, 0.5, 2π)
The phases for which the expressions should be evaluated when xdata is phase.
xdataphaseunit
String
rad
The unit in which xdataphaserange is described.
xdatasolnumtype
all | inner | outer | valid level
outer
Whether the expression should be evaluated for every inner or every outer solution, or for a specific level (level1, level2, and so on). Applicable only for models containing multiple levels.
xdataunit
String
Model-dependent
The unit to use for the expression in xdataexpr. If the old unit is not valid when the expression changes, the unit property is reset to default.
Attributes
None.
See Also
LineGraph