Text Annotation Properties

These properties control text 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-64: Text Annotation Properties 

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

Text string

String: Text that appears in the annotation. Edit to change the text, or to add formatting commands such as the following:

  • !C: Add new line.
  • !U: Add superscript characters.
  • !D: Add subscript characters.
  • !N: Return to normal characters.

For a complete list of embedded text formatting commands, refer to Embedded Formatting Commands (IDL Reference Guide). No default value.

_STRING

String

Horizontal alignment

String List: Horizontal alignment of multiple lines within text box. Choose from these values:

  • Left: Align text along the left border of the text box.
  • Center: Align text in the center of the text box.
  • Right: Align text along the right border of the text box.

Default = Left

_HORIZONTAL_ALIGN

0 (Left--default)

1 (Center)

2 (Right)

Color

Color: Color to be used for the text. 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.

Fill background

Boolean: Fill the background of the text with the background color? Choose True or False.

Default = False

FILL_BACKGROUND

0 (Do not fill background)

1 (Fill background)

Fill color

Color: Color to be used for the text background. The 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 text annotation from 0% to 100%. Move the slider to change the value.

Default = 0

TRANSPARENCY

Integer from 0 to 100.

Text font

String List: Font used for text annotation. Select a font from the list. Choose from these values:

  • Helvetica
  • Courier
  • Times
  • Symbol
  • Hershey 3 Simplex

In addition to the above standard fonts, you will also have available all of the other Hershey fonts as well as any TrueType fonts available to IDL.

Default = Helvetica

FONT_INDEX

The following values are valid for all platforms:

0 (Helvetica--default)

1 (Courier)

2 (Times)

3 (Symbol)

4 (Hershey 3 Simplex)

There may be other Hershey and TrueType fonts available, but the list values are system-dependent.

Text style

String List: Style used for text annotation. Select a style from the list. Choose from these values:

  • Normal
  • Bold
  • Italic
  • Bold italic

Default = Normal

FONT_STYLE

0 (Normal--default)

1 (Bold)

2 (Italic)

3 (Bold italic)

Text font size

Number: Font size in points for the text annotation. Edit the number to change the size. Default = 12

FONT_SIZE

Integer