Function
Create a function plot as a graph plot of a defined function.
Syntax
model.result(<pgtag>).create(<ftag>,"Function");
model.result(<pgtag>).feature(<ftag>).selection(...);
model.result(<pgtag>).feature(<ftag>).set(property, <value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
model.result(<pgtag>).create(<ftag>,"Function") creates a function plot feature named <ftag> belonging to the plot group <pgtag>.
A function plot is used to visualize a function as a line, as points, or as its frequency spectrum. Function plots can be added to 1D plot groups.
The following properties are available:
Table 7-45: Valid Property/Value Pairs for Function 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.
autounit
on | off
off
Whether the automatic legends should include the unit.
customlinecolor
RGB-triplet
{0,0,1} or last used edgecolor
The color to use for the lines. Active when linecolor is set to custom.
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.
data
none | parent | dataset name
parent
The dataset this feature refers to.
dbmanualref
double
0
Reference value for display in dB, if dbref is manual (and indb is true).
dbref
maximum | manual
maximum
Use the maximum value of a manual value as the dB reference when indb is true.
dbtype
10log | 20log
10log
Use a 10 log or 20 log for the dB values when indb is true.
descr
String
Model dependent
The description of the expression in expr. Is used in the automatic title.
descriptionintitle
on | off
on
Whether the title contribution should contain the description when titletype is custom.
display
line | linepoints | points | fourier
line
How to display the function: as a line, as line and points, as points, or as a discrete Fourier transform (DFT).
expr
String
Model dependent
The expression to plot.
expressionintitle
on | off
off
Whether the title contribution should contain the expression when titletype is custom.
extrapolation
none | left | right | leftright
none
How to extrapolate the function outside the argument’s bounds: no extrapolation or extrapolation to the left, to the right, or to both the left and the right of the bounds.
extrapolationcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
red
The color of the extrapolation zones, if extrapolation is not none.
fouriershow
real | imaginary | amplitude | phase | spectrum
amplitude
When display is fourier: Show the DFT as real or imaginary part, amplitude, phase, or frequency spectrum.-
freqmax
integer
 
If fouriershow is spectrum and freqrangeactive is true: The upper frequency bound.
freqmin
integer
 
If fouriershow is spectrum and freqrangeactive is true: The lower frequency bound.
freqrangeactive
true | false
false
If fouriershow is spectrum: Controls whether a manual frequency range is used.
ignorelast
true | false
true
If fouriershow is not spectrum: ignore last sample.
indb
true | false
false
Display the amplitude or frequency spectrum in dB when fouriershow is amplitude or spectrum.
inverse
true | false
false
If fouriershow is not spectrum: inverse the discrete Fourier transform.
legend
true | false
false
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 | preference
1
The line width.
linestyle
none | cycle | solid | dotted | dashed | dashdot
solid
The line style, if any. Cycle indicates that the line style is different for each line.
lowerbound
double
0
The lower bound for the function’s argument.
maskdc
true | false
false
If fouriershow is not spectrum: set the DC value (zero frequency component) to zero.
nfreqs
integer
1
If fouriershow is spectrum and nfreqsactive is true: The number of frequencies to plot.
nfreqsactive
true | false
false
If fouriershow is spectrum: Controls whether the number of frequencies is set manually.
nsamples
integer
1
If fouriershow is not spectrum and nsamplesactive is true: The number of uniform samples to use.
nsamplesactive
true | false
false
If fouriershow is not spectrum: Controls whether the number of uniform samples is set manually.
pointdef
String
 
The tag of the dataset for the point definition, if display is set to linepoints or points.
pointcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
black
The point color.
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.
scale
none | multiplyperiod | dividenfreq
none
If fouriershow is spectrum, use no scaling, multiply by sampling period, or divide by number of frequencies.
scaleperiod
true | false
true
If fouriershow is not spectrum: scale with sampling period.
shiftzero
true | false
true
If fouriershow is not spectrum: shift zero frequency.
suffixintitle
String
Empty
Added suffix to contribution to title.
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.
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.
upperbound
double
1
The upper bound for the function’s argument.
xdataexpr
String
Model dependent
Expression for x-axis data.
xdatadescr
String
Model dependent
Description of expression in xdataexpr.
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
Global (Plot), LineGraph, Function2D