Details of an explanatory note on a raster panel. More...

import"encxcom.idl";

Inheritance diagram for IRasPanelNote:

Properties
IPixelRect	Rect `[get]`
	The bounding box of the note on the chart. Pixel position (0,0) is always at the top left corner of the chart. More...

BSTR	Code `[get]`
	Fine catIdentification of the note. This is a subsidiary classification within Type(). More...

BSTR	Type `[get]`
	Coarse categorisation of the note. E.g. Routeing or Sources. More...

VARIANT_BOOL	Obscures `[get]`
	Returns true if the note overlaps any hydrography. More...

VARIANT_BOOL	Display `[get]`
	Returns true if the note should be displayed to the user. More...

Detailed Description

Details of an explanatory note on a raster panel.

This is a mechanism to enable programmatic access to information that is only available on the chart image. This is typically metadata, such as tidal diamond information, warning notices etc.

Definition at line 1274 of file encxcom.idl.

Property Documentation

◆ Code

BSTR IRasPanelNote::Code

get

Fine catIdentification of the note. This is a subsidiary classification within Type().

For example, the Type() "Buoyage/Beacons/Lights" contains the following Code() values: "Navaids", "IALA Region", "Buoyage changes", "Lights/Beacons".

◆ Display

VARIANT_BOOL IRasPanelNote::Display

get

Returns true if the note should be displayed to the user.

A few notes are included in the IRasPanelNotes because they obscure hydrography, but are not intended for display to the user.

◆ Obscures

VARIANT_BOOL IRasPanelNote::Obscures

get

Returns true if the note overlaps any hydrography.

◆ Rect

IPixelRect IRasPanelNote::Rect

getbound

The bounding box of the note on the chart. Pixel position (0,0) is always at the top left corner of the chart.

◆ Type

BSTR IRasPanelNote::Type

get

Coarse categorisation of the note. E.g. Routeing or Sources.