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-9: Valid Properties for annotation.
Property
Value
Default
Description
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 | fromtheme | black | blue | cyan | gray | green | magenta | red | white | yellow | none
none
The color to use for background rectangle.
color
custom | fromtheme | black | blue | cyan | gray | green | magenta | red | white | yellow
fromtheme
The color to use for the point where the annotation appears and the annotation text. The default takes the color from the current color theme.
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.
expralwaysimaginary
true | false
false
Always show the imaginary part when exprnumberformat is stopwatch or stopwatchsci.
expralwayssign
true | false
false
Always show the sign when exprnumberformat is stopwatch or stopwatchsci.
expralwayssignexp
true | false
false
Always show the sign of the exponent when exprnumberformat is stopwatchsci.
exprdecimals
positive integer
2
Number of decimals when exprnumberformat is stopwatch or stopwatchsci.
expressionintitle
on | off
off
Whether the title contribution should contain the expression when titletype is custom.
exprexponentdigits
positive integer (1–3)
1
The number of exponent digits (1–3) for numerical values in the title when exprnumberformat is stopwatchsci.
exprnumberformat
default | auto | engineering | scientific | stopwatch | stopwatchsci
auto
The number format for the annotation: default, automatic, engineering, scientific, stopwatch, or scientific stopwatch.
exprprecision
positive integer
6
Precision for the expressions used in annotations.
exprtrailingzeros
true | false
false
Include trailing zeros when exprnumberformat is auto, engineering, or scientific.
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.
pointradius
double
2
A value between 0 and 10 for the point radius, if showpoint is true.
posexprx
String array
{"0"}
Position x-coordinates for the annotation.
posexpry
String array
{"0"}
Position y-coordinates for the annotation.
posexprz
String array
{"0"}
Position z-coordinates for the annotation (3D only).
posprecision
positive integer
6
Precision for the position values.
posalwayssign
true | false
false
If prependcoords is set to true: Always show the sign when posnumberformat is stopwatch or stopwatchsci.
posalwayssignexp
true | false
false
If prependcoords is set to true: Always show the sign of the exponent when posnumberformat is stopwatchsci.
posdecimals
positive integer
2
If prependcoords is set to true: Number of decimals when posnumberformat is stopwatch or stopwatchsci.
posexponentdigits
positive integer (1–3)
1
If prependcoords is set to true: Number of exponent digits (1–3) for numerical values in the title when posnumberformat is stopwatchsci.
posintegerdigits
positive integer
3
If prependcoords is set to true: Number of integer digits when posnumberformat is stopwatch.
posnumberformat
default | auto | engineering | scientific | stopwatch | stopwatchsci
auto
If prependcoords is set to true: The number format for the marker position: default, automatic, engineering, scientific, stopwatch, or scientific stopwatch.
posprecision
positive integer
6
If prependcoords is set to true: The precision for position values in the marker when posnumberformat is auto, engineering, or scientific.
postrailingzeros
true | false
false
If prependcoords is set to true: Include trailing zeros when posnumberformat is auto, engineering, or scientific.
prefixintitle
String
Empty
A prefix text in a custom title.
prependcoords
true | false
false
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.
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
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 | 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.
unitintitle
on | off
on
Whether the title contribution should contain the unit when titletype is custom.
Attributes
Deform, Transformation
Compatibility
The property allowexprs property has been removed as of version 6.0. Evaluation on of expressions in the annotation’s text using the eval(expr), eval(expr,unit), and eval(expr,unit,expression) syntax is now always allowed for the annotation text.
See Also
MaxMinVolume, MaxMinSurface, MaxMinLine, MaxMinPoint