CARIS Batch Utility : Portrayals : Portrayal Control File
 

Portrayal Control File

The Portrayal Control File links a portrayal to required files for chart presentation. These files include lookup tables (line, area or point), symbol files, and colour tables.

The default file is located in C:\Program Files\CARIS\Caris\
<version>\system and is named portrayalcontrol.xml.

The structure of the control file is shown below.

The following table lists tags in the file.

Tag

Description

<PresentationControlFile>

Root tag for all tags and elements.

Attributes:

Version= The version of the file.

<PresentationOptions>

Parent tag for a specific portrayal.

Attributes:

Type= The portrayal standard for chart display.

Name= The specific presentation. Each presentation has its own set of portrayal files.

Description= A brief description of the presentation.

<LookupTables>

Parent tag for the lookup tables for areas, lines, points, and where necessary, text.

<AreaLookup/>

The file that controls symbology, colour and other display properties of area features. This tag is a child tag of <LookupTables>.

Attributes:

File= The path and name of the area lookup table.

SymbolizedBoundaries=True/False. When True, areas are symbolized with a complex line style; when set to False, areas are drawn with a simple line style.

<LineLookup/>

The file that controls symbology, colour and other display properties of line features. This tag is a child tag of <LookupTables>.

Attributes:

File= The path and name of the line lookup table.

<PointLookup/>

The file that controls symbology, colour and other display properties of line features. This tag is a child tag of <LookupTables>

Attributes:

File= The path and name of the point lookup table.

<TextLookup/>

The file that controls text properties in INT1 charts. This tag is a child tag of <LookupTables>

Attributes:

File= The path and name of the point lookup table.

<SymbolFiles/>

Folder containing symbol files for S-52 features.

Attributes:

Directory= Path for the folder containing symbol files.

<SymbolFile/>

Name of the binary file containing INT1 symbols for paper charts.

Attributes:

File= The path and name of binary symbol file.

<ColourFiles/>

Folder containing colour tables based on ECDIS display modes. Each file contains colour tokens for displaying features.

Attributes:

Directory= Path for the folder containing display mode files.

<ColourFile/>

Path for the file containing colour tokens for INT1 display in paper charts.

Attributes:

File= Path and name of the file.

<FeatureCodeColourMapFile/>

The colour table associates symbolization codes in the ih_master file with colour tokens for INT1 paper chart display.

Attributes:

File= Path and name of the file.

<MasterFile/>

A text file that contains CARIS symbolization codes.

Attributes:

File= Path and name of the file.

<TranslationFile>

Folder containing the Extensible Stylesheet Transformations (XSLT) files for defining S-101 features.

<SymbolFiles/>

Symbols for features.

Attributes:

Directory= The path for the folder containing Scalable Vector Graphics (SVG) files for S-100 symbology.

Type="SVG" The type of symbol file, in this case, SVG.

<LineStyles/>

Files for drawing line styles.

Attributes:

Directory= Path for the folder containing XML files for line feature drawing instructions.

Schema= Path of the Schema Definition File (XSD) that defines elements in the LineStyle XML files.

<AreaFills/>

Files for area fills.

Attributes:

Directory= Path for the folder containing XML files for area fills.

Schema= Path of the Schema Definition File (XSD) that defines elements in the AreaFills XML files.

<ColourFiles/>

Folder containing colour tables based on ECDIS display modes. Each file contains colour tokens for displaying features.

Attributes:

Directory= Path for the folder containing display mode files.