Text characteristics include
• Text styles
• Rules for constructing the annotation string based on feature attribute values.
More than one attribute can be used to construct the annotation string. Specific formatting of the annotation string can also be defined for an attribute.
Tag | Attribute | Attribute Description |
|---|---|---|
<Object/> | Acronym | Feature to which the annotation is associated. |
| AnnotationType | POINT_JUSTIFIED_TEXT (default), CURVED_LINE_TEXT, BLOCK_TEXT. See below for attributes associated with text annotation type. |
Acronym | Annotation acronym must be in the dictionary. | |
Description | Description of the annotation. | |
| POINT_JUSTIFIED_TEXT | |
XOffset | X offset, in millimetres, from object's reference point. | |
YOffset | Y offset, in millimetres, from object's reference point. | |
XRefOffset | X offset, in millimetres, of the reference point from the annotated feature. | |
YRefOffset | Y offset, in millimetres, of the reference point from the annotated feature. | |
Angle | Angle of the text, in degrees, around the text's reference point. | |
HJust | Horizontal justification - Left, Centre, Right. | |
VJust | Vertical justification - Top, Centre, Bottom, Baseline, Font Upper, Font Lower | |
OrientAttribute | The name of the attribute from which the annotation orientation information is used. | |
BLOCK_TEXT | ||
XRefOffset | X offset, in millimetres, of the reference point from the annotated feature. | |
YRefOffset | Y offset, in millimetres, of the reference point from the annotated feature. | |
Angle | Angle of the block text, in degrees, around the block text's reference point. | |
File | Optional parameter; points to an RTF file used for the text of the annotation. Note: When using File the attributes of the text data from the file are used and the attribute values of the text data set in the tag (size, WidthMM, etc.) are ignored. | |
WidthMM | Width of block text in millimetres. | |
Newline | Flag - True, False (indicates if a newline character should be inserted at the end of the annotation). This can be applied to point-justified or block text. | |
CharsToNewLine | Character(s) that match the attribute value are replaced with a newline character. | |
CURVED_LINE_TEXT | ||
CurveFormat | Stretched, Spaced, Start, Centre, and End | |
CurveType | Polyline, Spline | |
<Style/> | Font | Name of the font. The full font name must be used. |
Colour | Colour of the font -uses colour tokens. | |
Size | Font size in points. | |
Bold | Flag - True, False | |
Italic | Flag - True, False | |
Underline | Flag - True, False | |
<Attribute/> | Acronym | Attribute to retrieve the annotation from. |
Prefix | String to append to the beginning of the annotation. | |
Postfix | String to append to the end of the annotation. | |
Format | Format to indicate precision (maximum ###.#). | |
Separator | Character(s) between elements of list attributes. | |
UseAbbreviation | Flag - | |
FeatureAttribute | Flag - | |
Units | Set to | |
Perl Regular Expressions
Regular Expressions (‘Regex’) in Perl are strings that describe patterns. You can use these in the annotation file to reformat text.
For more information on regular expressions, see http://perldoc.perl.org/perlre.html. Further examples of Regex use in CARIS support files can be found at Regular Expressions.
An example is shown below.
<Object Acronym="RADSTA"> <Filter> <PrimitiveIsEqualTo Primitive="Point"/> </Filter> <CreateAnnotation Acronym="$comch" Description="Communication Channel" HJust="Left" VJust="Bottom" XOffset="0" YOffset="0"> <Regex Pattern="[\[\]]" ReplaceWith=""> <Attribute Acronym="COMCHA" /> </Regex> </CreateAnnotation> </Object> |
The above creates an annotation from the COMCHA attribute by removing the brackets.