CARIS HPD : Portrayal : Annotations : Sector Lights Annotation File
 

Sector Lights Annotation File

The sector annotation file (light_sector_annotations.xml) defines text annotation properties for sector lights, such as font type, text layout, etc. Distance of the annotation from the sector light is determined through the Light Sectors commands in Source Editor and Paper Chart Editor.

An example of the file is shown below:

<?xml version=”1.0” encoding=”UTF-8”?>

<LightSectorAnnotationFile Version=”2.0”>

  <AnnotationFileInfo Name=”Light Sector Annotations” Description=”Light Sector Annotation Rules” CreationDate=”04062009” CreatedBy=”CARIS”/>

  <!-- Obscured Light: -->

  <Object Acronym=”LIGHTS”>

    <Filter>

      <AttributeValueContains Acronym=”LITVIS” Value=”7”/>

    </Filter>

    <CreateAnnotation AnnotationType=”CURVED_LINE_TEXT”

     CurveFormat=”CENTRE” Acronym=”$ltano” Description=”Obscured Sector Light”>

      <Style Font=”Arial” Size=”7” Bold=”False” Italic=”False” Underline=”False”>

        <Attribute Prefix=”Obscd”/>

      </Style>

    </CreateAnnotation>

  </Object>

<!-- Default Entry: -->

  <Object Acronym=”LIGHTS”>

    <CreateAnnotation AnnotationType=”CURVED_LINE_TEXT” CurveFormat=”CENTRE” Acronym=”$ltano” Description=”Sector Light”>

      <Style Font=”Arial” Size=”7” Bold=”False” Italic=”False” Underline=”False”>

        <Attribute Acronym=”COLOUR” UseAbbreviation=”True”/>

      </Style>

    </CreateAnnotation>

  </Object>

</LightSectorAnnotationFile>

The tags and attributes are described in this table.

Tag

Attribute

Attribute Description

<Object/>

Acronym

Feature to which the annotation is to be associated.

<CreateAnnotation/>

Annotation Acronym

Annotation acronym must be in the dictionary.

Description

Description of the annotation.

AnnotationType

POINT_JUSTIFIED_TEXT (default), CURVED_LINE_TEXT

XOffset

X offset, in mm, from object's reference point.

YOffset

Y offset, in mm, from object's reference point.

HJust

Horizontal justification - Left, Centre, Right

VJust

Vertical justification - Top, Centre, Bottom. Baseline, Font Upper, Font Lower

CurveFormat

Stretched, Spaced, Start, Centre, and End

CurveType

Polyline, Spline

OrientAttribute

The name of the attribute to get annotation orientation information.

<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 (e.g., ###.#).

Separator

Character(s) between elements of list attributes.

UseAbbreviation

Flag -True, False (if True an abbreviation from the AbbreviationTable is used).

FeatureAttribute

Flag -True, False (indicates if attribute should come from the feature or spatial object - points only. Feature object=”True” is assumed).

DecimalSeparator

Set to “.” or “,” or “&183;” (to create “.”).

Units

Set to “Metres” or “Imperial Feet” (indicates if annotations are displayed in the selected value).