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.
anchorpoint
upperright | uppermiddle | upperleft | middleright | center | middleleft | lowerright | lowermiddle | lowerleft
upperleft
The position of the annotation text relative to the anchor point at the position given by posexpr.
backgroundcolor
custom | black | blue | cyan | gray | green |magenta | red | white | yellow | none
none
The color to use for background rectangle.
color
custom | black | blue | cyan | gray | green |magenta | red | white | yellow
red
The color to use for the point where the annotation appears and the annotation text.
data
none | parent | dataset name
parent
The dataset 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.
inheritbackgroundcolor
Boolean
true
If inheritplot is not none: Determines if the background color is inherited.
inheritcolor
Boolean
true
If inheritplot is not none: Determines if the color is inherited.
inheritframe
Boolean
true
If inheritplot is not none: Determines if the show frame property 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 dataset. volume is only available in 3D.
orientation
horizontal | vertical
horizontal
Orient the annotation text horizontally or vertically.
plotonsecyaxis
Boolean
false
Plot on secondary y-axis if twoyaxes is set to true in the parent plot group. For 1D graph plots and annotations only. An array, using setIndex syntax.
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).
showframe
true | false
false
Whether to show a frame around the annotation or not.
showpoint
true | false
true
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.
title
String
The auto-title.
The title to use when titletype is manual.
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
Deform
See Also
MaxMinVolume, MaxMinSurface, MaxMinLine, MaxMinPoint