Nyquist
Create a Nyquist plot.
Syntax
model.result(<pgtag>).create(<ftag>,"Nyquist");
model.result(<pgtag>).feature(<ftag>).set(property,<value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
model.result(<pgtag>).create(<ftag>,"Nyquist") creates a Nyquist plot feature named <ftag> belonging to the plot group <pgtag>.
Nyquist plots are used to visualize complex-valued variables. Nyquist plots can be added to 1D plot groups.
The following properties are available:
Table 7-97: Valid Properties for Nyquist 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.
autounit
on | off
off
Whether the automatic legends should include the unit.
bottomcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
black
The bottom color to use for a color gradient. Active when linecolor is cyclegradient.
colorcycle
default | long
default
The color cycle, when linecolor is set to cycle. With default, it contains 7 colors; with long, it contains 19 colors.
colortable
color table name
Rainbow
The color table to use when linecolor is set to cyclecolortable. See Color Tables for a list of color tables.
const
String matrix
Empty or physics dependent
Parameters to use in the expressions as an N‑by‑3 matrix containing name, value, and description. Only parameters provided by the physics interfaces in the model can be set.
custombottomcolor
RGB-triplet
{1,0,0} or last used color
The uniform color to use. Active when bottomcolor is set to custom.
customlinecolor
RGB-triplet
{0,0,1} or last used edgecolor
The color to use for the lines. Active when linecolor is set to custom.
customtopcolor
RGB-triplet
{1,0,0} or last used color
The uniform color to use. Active when topcolor is set to custom.
cyclelength
auto | manual
auto
The length of color cycle when linecolor is cyclegradient.
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.
legend
on | off
off
Whether to show legends.
legendexprprecision
positive integer
3
The precision for the evaluated expression when legendmethod is set to evaluated.
legendmethod
automatic | manual | evaluated
automatic
Whether to use the automatic legends or the legends added manually or evaluated.
legendpattern
String
 
A legend string to be evaluated when legendmethod is set to evaluated.
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 | cyclereset | cyclecolortable | cyclegradient | fromtheme | 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. Use cyclereset to restart the cycling of colors from the first color. Use fromtheme to take the color from the selected color theme.
linewidth
double | preference
1
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.
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.
numberofcolors
integer
7
The number of colors in the color cycle when cyclelength is manual.
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.
prefixintitle
String
Empty
Added prefix to contribution to title
reversecolortable
boolean
false
Whether to reverse the order of the colors in the color table. Active when linecolor is cyclecolortable.
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.
solutionparams
manual | parent
manual
If data is a local dataset with nontrivial data, specify solutions manually or take them from the parent plot group.
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 | 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.
topcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
white
The bottom color to use for a color gradient. Active when linecolor is cyclegradient.
typeintitle
on | off
on
Whether the title contribution should contain the type when titletype is custom.
unit
String array
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.
unitcircle
boolean
false
Whether to plot the unit circle along with the axis.
unitintitle
on | off
on
Whether the title contribution should contain the unit when titletype is custom.