Line Annotation Properties

These properties control line 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-65:  Line Annotation Properties

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

Transparency

Number: Percent transparency of line. Move slider to change value.

Default = 0

TRANSPARENCY

Integer from 0 to 100.

Z value

Number: Z value of plane on which to project the polygon. Edit the number to change the value.

Default = 0

ZVALUE

Floating point value

Color

Color: Color to be used for the line. 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 line annotation. Select a line style from the list. Default = Line_Annotation_Properties-07.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 line annotation in points. Select a thickness from the list. Default = 1

THICK

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

Arrow style

Arrow Style Selector: Select an arrow style from the list. Choose from these values:

arrow_style.gif

Default = arrow_style_default.gif (no arrow)

ARROW_STYLE

0 (No arrow--Default)

1 (Right arrow)

2 (Left arrow)

3 (Right and left arrow)

4 (Head and tail--right arrow)

5 (Head and tail--left arrow)

Arrowhead size

Number: Size of arrowhead in normalized units. Arrow style must be selected for arrowhead to display. Move the slider to change the value. Default = 0.05

ARROW_SIZE

Floating point