Annotation
Add an annotation to a plot.
Syntax
model.result(<pgtag>).create(<ftag>,"Annotation");
model.result(<pgtag>).feature(<ftag>).set(property, <value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
 model.result(<pgtag>).create(<ftag>,"Annotation") creates an annotation feature named <ftag> belonging to the plot group <pgtag>.
Annotations add text, including optional position coordinates, to plots.
The following properties are available:
Table 7-6: Valid Property/Value Pairs for annotations
Property
Value
Default
Description
allowexprs
on | off
off
Allow evaluation of expressions in the annotation’s text using the eval(expr) and eval(expr,unit) syntax.
backgroundcheckbox
on | off
off
Add a background rectangle to the annotation.
backgroundcolor
custom | black | blue | cyan | gray | green |magenta | red | white | yellow
white
The color to use for background rectangle when backgroundcheckbox is set to on.
color
custom | black | blue | cyan | gray | green |magenta | red | white | yellow
red
The color to use for the point where the annotation appears.
data
none | parent | data set name
parent
The data set this feature refers to.
descriptionintitle
on | off
on
Whether the title contribution should contain the description when titletype is custom.
exprprecision
positive integer
6
Precision for the expressions used in annotations.
expressionintitle
on | off
off
Whether the title contribution should contain the expression when titletype is custom.
inheritcolor
Boolean
true
If inheritplot is not none: Determines if the color is inherited.
inheritplot
none | plot name
none
The plot that color is inherited from.
latexmarkup
on | off
off
Include LaTeX markup language in annotation.
level
fromdataset | global | line | point | surface | volume
fromdataset
The geometry level for evaluating expressions. The default is to take it from the data set. volume is only available in 3D.
posexpr
String array
{"0", "0"} (2D)
Position coordinates for the annotation (2 in 2D and 1D graph plots; 3 in 3D).
posprecision
positive integer
6
Precision for the position values.
prefixintitle
String
Empty
A prefix text in a custom title.
prependcoords
on | off
off
Include coordinates of annotation position before the annotation text.
recover
off | pprint | ppr
off
The derivative recovery method (off, within domains, or everywhere).
showpoint
on | off
on
Whether to show the point for the position of the annotation or not.
suffixintitle
String
Empty
A suffix text in a custom title.
text
String
Empty
The text to display as an annotation.
titletype
auto | custom | manual | none
none
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.
unitintitle
on | off
on
Whether the title contribution should contain the unit when titletype is custom.
Attributes
None.
See Also
MaxMinVolume, MaxMinSurface, MaxMinLine