Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

Hull and Outfitting

getNoteChar

  • Last UpdatedDec 02, 2025
  • 2 minute read

This method is supposed to have access to a list of note characteristic records. It also takes an integer index as parameter and should return a list of note characteristics for the corresponding note. This list of note characteristic records should have the same number of elements as the corresponding name list described above, that means, there should be one entry for each note type.

The characteristics record returned should contain the following items:

(<reference>,<placement>,<colour>,<layer>, <flip_angle>)

<reference> is a string defining the location of the reference point. The allowed values are described below:

Value

Description

cursor

Use the pick point defined by the user as reference point

nearest

Use the point closest to the identified geometry

midpoint

Use the midpoint of the longest geometry in the identified picture element

COG

Use the center of the circumscribed rectangle of the identified picture element

<placement> is a string defining the location of the note body in case no reference lines are used. The placement is related to the reference point and the values refer to the circumscribed rectangle of the note body.

<placement> is built up by two values, one for horizontal placement and one for vertical placement that are concatenated without delimiters to form one string. The allowed values are described below:

Value (horizontal)

Description

Left

Use the left side

Mid

Use the midpoint

Right

Use the right side

Origin

Use the origin

Value (vertical)

Description

Lower

Use the lower side

Mid

Use the midpoint

Upper

Use the upper side

Origin

Use the origin

Origin refers to the point (0,0) in the local coordinate system used when building up the note body further explained below. All combinations of these values are valid, for example, LeftLower or MidOrigin.

<colour> is a string giving the name of a colour selected from the standard set.

<layer> is either a string defining a named layer existing in the Layer Alias File (see User's Guide Drafting), or an integer number giving the layer. The created note component will then get this layer.

<flip_angle> is an integer number defining the angle in degrees where the note text along a line changes from one side of the line to the other. The angle must be between 0 and 180 degrees.

Related Links
TitleResults for “How to create a CRG?”Also Available in