Freehand Annotation Properties

These properties control freehand annotation visualizations. For each property, the type of control and the values that can be assigned are listed, along with the property identifier and allowed values for use by the iTools Procedural Interface. For a description of how a particular control is used, refer to Property Controls.

Table D-70: Freehand Annotation Properties 

Interface:
Property Name
Control Type: Values
API:
Property Identifier
API:
Allowed Values

Color

Color: Color to be used for the polygon outline. Click to choose from the default color palette, or specify RGB values. Default = [0,0,0] (black)

COLOR

3D integer array of the form:

[R, G, B]

Each color value may range from 0 to 255.

Linestyle

Line Style: Style of the polygon outline. Select a line style from the list. Default = Freehand_Annotation_Properties-19.jpg(solid line)

LINESTYLE

An integer value specifying a predefined line style, or a two-element vector specifying a stippling pattern.

The predefined line styles are:

0 (Solid line--the default)

1 (Dotted)

2 (Dashed)

3 (Dash dot)

4 (Dash dot dot dot)

5 (Long dash)

6 (No line drawn)

To define your own stippling pattern, specify a two-element vector [repeat, bitmask], where repeat indicates the number of times consecutive runs of 1's or 0's in the bitmask should be repeated. (That is, if three consecutive 0's appear in the bitmask and the value of repeat is 2, the line will have six consecutive bits turned off.) The value of repeat must be in the range 1 <= repeat <= 255.

The bitmask indicates which pixels are drawn and which are not along the length of the line. Bitmask is most conveniently specified as a 16-bit hexadecimal value.

For example, LINESTYLE = [2, 'F0F0'X] describes a dashed line (8 bits on, 8 bits off, 8 bits on, 8 bits off).

Thickness

Line Thickness: Thickness of the polygon outline in points. Select a thickness from the list. Default = 1

THICK

A floating-point value between 1.0 (the default) and 10.0.

Fill background

Boolean: Fill polygon background? Choose True or False. Default = True

FILL_BACKGROUND

0 (Do not fill polygon background)

1 (Fill polygon background--default)

Fill color

Color: Color to be used for the background. For background color to display, Fill Background property must be set to True. Click to choose from the default color palette, or specify RGB values. Default = [255,255,255] (white)

FILL_COLOR

3D integer array of the form:

[R, G, B]

Each color value may range from 0 to 255.

Transparency

Number: Transparency of the polygon background fill from 0% to 100%. Move the slider to change the value. Default = 0

TRANSPARENCY

Integer from 0 to 100.

Color

Color: Color to be used for the polygon outline. Click to choose from the default color palette, or specify RGB values. Default = [0,0,0] (black)

COLOR

3D integer array of the form:

[R, G, B]

Each color value may range from 0 to 255.