CARIS HPD : Portrayal : Paper Chart Marginalia : How Marginalia Works : Image Marginalia File
 

Image Marginalia File

The image marginalia file links image features to annotations.

A filter is used to specify the position of the anchor point feature with which the marginalia image is associated.

By default, the application looks for image files for image marginalia in C:\Program Files\CARIS\HPD\<version>\system\PCEConfig\annotations.

An example of a basic image marginalia file is shown below.

<Object Acronym="$marga">

  <Filter>

    <AttributeValueIsEqualTo Acronym="$lckey" Value="BottomRight"/>

  </Filter>

  <CreateAnnotation AnnotationType="IMAGE" Acronym="$imag2" File="test.tif" XOffset="3.0" HJust="Right" VJust="Top">

    <SetAttribute Acronym="$colfg" Value="White" />

    <SetAttribute Acronym="$colbk" Value="Blue" />

  </CreateAnnotation>

</Object>

The key attributes are described here.

Tag

Attribute Description

<Object/>

The feature to which the annotation is associated.

Attribute:

• Acronym: For marginalia, the value is $marga.

<Filter>

Parent tag for the filter.

<AttributeValueIsEqualTo />

Filter for associating marginalia information with an anchor point.

Attributes:

• Acronym: The location key ($lckey) position of the marginalia anchor point.

• Value: The value of the $lckey attribute. Eight default values are Top, TopRight, Right, BottomRight, Bottom, BottomLeft, Left, TopLeft

<CreateAnnotation/>

Image annotation information.

Attributes:

• AnnotationType: Always set to IMAGE.

• Acronym: Feature acronym for the image. This can be $imag2, $imagp, $image (2-bit, generic, and 8-bit images)

• File: Name of the image file.

• XOffset: The horizontal offset (in mm) from the feature’s reference point. This can specified up to two decimal places and be a positive or negative value.

• YOffset: The vertical offset (in mm) from the feature’s reference point. This can specified up to two decimal places and can be a positive or negative value.

• HJust: Horizontal justification (aligned to the offset position): Centre, Left, Right.

• VJust: Vertical justification (aligned to the offset position): Centre, Top, Bottom.

• Height: Height of the image (in mm). The Height attribute can be used without the Width attribute. In this case, an aspect ratio is applied to calculate the best width.

• Width: Width of the image (in mm). The Width attribute can be used without the Height attribute. In this case, an aspect ratio is applied to calculate the best height.

• Use either Height or Width. Using both can lead to image distortion.

<SetAttribute/>

Set image feature attributes

Attributes:

• Acronym: image feature attribute

• Value: Value that is to be set on the attribute.