Axes

Figure D-24: Visualization Browser with Axis Properties Displayed

VizBrowserAxes.gif

These properties control axis object 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.

The following table contains the properties that control the container for the visualization axes.

Table D-54: Axes Container Properties 

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

Style

String List: Select display style for axes. Choose from these values:

  • None: Do not display axes.
  • At Dataspace Minimum: Display 2 axes for 2-D visualization, 3 axes for 3-D visualization.
  • Box Axes: Display 4 axes for 2-D visualization, 12 axes for 3-D visualization.
  • Crosshairs: Display crosshair style axes.

Default = At Dataspace Minimum

STYLE

0 (None)

1 (At dataspace minimum--default)

2 (Box axes)

3 (Crosshairs)

Lock to Data

Boolean: Locks axis (axes) to data.

Default = False

DATA_POSITION

0 (False)

1 (True)

Transparency

Number: Adjusts transparency of axis (axes).

Default = 0

TRANSPARENCY

Integer from 0 to 100.

Color

Color: Color to be used for the axis lines in this visualization. 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.

Line style

Line Style: Style of the axis tick lines. Select a line style from the list. Default = Axes-16.jpg(solid line)

GRIDSTYLE

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).

Line thickness

Line Thickness: Thickness of the axis tick lines. Select a thickness from the list. Default = 1

THICK

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

Major ticks

Number: Set number of major tick marks. Enter value.

Default = 0

MAJOR

Integer

Minor ticks

Number: Set number of minor tick marks. Enter value.

Default = 0

MINOR

Integer

Major Tick Length

Number: Normalized length of major tick marks for all axes from 0 (no ticks) to 1 (major tick marks span the visualization). Move the slider to change the value. Default = 0.05.

TICKLEN

Floating point value from 0 to 1.

Minor tick length

Number: Relative length of minor tick marks for all axes from -1 (minor tick marks extend the length of major tick marks on left side of axes) to 1 (minor tick marks extend same length as major tick marks on right side of axes). Move the slider to change the value. Default = 0.5 (minor tick marks extend one-half the length of major tick marks on right side of axes).

SUBTICKLEN

Floating point value from -1 to 1.

Tick interval

Number: Interval between ticks. Edit the number to change the value. Default = 0

TICKINTERVAL

Floating point

Tick layout

String List: Select layout style for major and minor tick visualization on all axes. Choose from these values:

  • Axis plus labels: Display tick labels and marks.
  • Labels only: Display tick labels only (no tick marks).
  • Box style: Display tick labels and marks, with labels enclosed in boxes.

Default = Axis plus labels

TICKLAYOUT

0 (Axis plus labels)

1 (Labels only)

2 (Box style)

Tick direction

String List: Select a direction for tick marks. Choose from these values:

  • Right/Above: Place tick marks to the right of or above the axis line.
  • Left/Below: Place text to the left of or below the axis line.

Default = Right/Above

TICKDIR

0 (Right/above--default)

1 (Left/below)

Text show

Boolean: Set text to show or not show. Choose True or False.

Default = True (show)

NOTEXT

0 (Do not show)

1 (Show--default)

Text position

String List: Select a position for tick and label text. Choose from these values:

  • Below/left: Place text below or to the left of the axis line.
  • Above/right: Place text above or to the right of the axis line.

Default = Below/left

TEXTPOS

0 (Below/left--default)

1 (Above/right)

Tick format code

String: A string defining the format of the tick annotation information. The format code should be enclosed in parentheses, and should conform to one of the formats described in Format Codes (Application Programming). This field always displays the current format code, but is only available for editing if Use Tick Format Code is selected as the value of the Tick format property.

TICKFORMAT

String

Tick format

String List: Choose a format code or time interval to use for each tick interval. Choose from these values:

  • None
  • Filled Fixed Width Integer
  • Freeform Integer or Float
  • Float with 2 or 4 decimal places
  • Exponential with 2 or 4 decimal places
  • Date (13 formats)
  • Time (11 formats)

Default = None

TICK_DEFINEDFORMAT

0 (None)

1 (Use tick format code)

2 (Filled fixed-width integer)

3 (Freeform integer or float)

4 (Float with two or four decimal places)

5 (Exponential with two or four decimal places)

6 (Date)

7 (Time)

Title

String: Title to apply to all axes for this visualization. Enter title text for the axes. No default value.

AXIS_TITLE

String

Text 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)

TEXT_COLOR

3D integer array of the form:

[R, G, B]

Each color value may range from 0 to 255.

Text font

String List: Font used for tick and label text. 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 tick and label text. 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 tick and label text. Edit the number to change the size. Default = 12

FONT_SIZE

Integer

This table contains the properties that control axis visualization X, Y, or (for three-dimensional visualizations) Z. 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-55: Property Settings for Individual Axes 

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

Color

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

Line style

Line Style: Style of the axis tick lines. Select a line style from the list. Default = Axes-14.jpg(solid line)

GRIDSTYLE

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).

Line thickness

Line Thickness: Thickness of the axis tick lines in points. Select a thickness from the list. Default = 1

THICK

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

Major ticks

Number: Number of major ticks marks to display along the axis. Edit the number to change the value. Default = 5

MAJOR

Integer

Minor ticks

Number: Number of minor ticks to display between major ticks. Edit the number to change the value. Default = 3

MINOR

Integer

Major tick length

Number: Normalized length of major tick marks for this axis from 0 (no ticks) to 1 (major tick marks span the visualization). Move the slider to change the value. Default = 0.05

TICKLEN

Floating point value

Minor tick length

Number: Relative length of minor tick marks for this axis from -1 (minor tick marks extend the length of major tick marks on left side of axis) to 1 (minor tick marks extend same length as major tick marks on right side of axis). Move the slider to change the value. Default = 0.5 (Minor tick marks extend one-half the length of major tick marks on right side of axis).

SUBTICKLEN

Floating point value

Tick interval

Number: Interval between major tick marks. Edit the number to change the value. Default = 0 (use the default interval for the specified range)

TICKINTERVAL

Floating point value

Tick layout

String List: Select layout style for major and minor tick visualization. Choose from these values:

  • Axis plus labels: Display tick labels and marks.
  • Labels only: Display tick labels only (no tick marks).
  • Box style: Display tick labels and marks, with labels enclosed in boxes.

Default = Axis plus labels

TICKLAYOUT

0 (Axis plus labels--default)

1 (Labels only)

2 (Box style)

Tick direction

String List: Select a direction for tick marks. Choose from these values:

  • Right/Above: Place tick marks to the right of or above the axis line.
  • Left/Below: Place text to the left of or below the axis line.

Default = Right/Above

TICKDIR

0 (Right/above--default)

1 (Left/below)

Text show

Boolean: Show tick and label text? Choose True or False. Default = True.

NOTEXT

0 (Do not show tick and label text)

1 (Show tick and label text--default)

Text position

String List: Select a position for tick and label text. Choose from these values:

  • Below/left: Place text below or to the left of the axis line.
  • Above/right: Place text above or to the right of the axis line.

Default = Below/left

TEXTPOS

0 (Below/left--default)

1 (Above/right)

Tick format code

String: A string defining the format of the tick annotation information. The format code should be enclosed in parentheses, and should conform to one of the formats described in Format Codes (Application Programming). This field always displays the current format code, but is only available for editing if Use Tick Format Code is selected as the value of the Tick format property.

TICKFORMAT

String

Tick format

String List: Choose a format code or time interval to use for each tick interval. Choose from these:

  • None
  • Filled Fixed Width Integer
  • Freeform Integer or Float
  • Float with 2 or 4 decimal places
  • Exponential with 2 or 4 decimal places
  • Date (13 formats)
  • Time (11 formats)

Default = None

TICK_DEFINEDFORMAT

0 (None--default)

1 (Use tick format code)

2 (Filled fixed width integer)

3 (Freeform integer or float)

4 (Float with 2 or 4 decimal places)

5 (Exponential with 2 or 4 decimal places)

6 (Date--13 formats)

7 (Time--11 formats)

Title

String: Title to apply to this axis. Enter title text for the axes. No default value.

AXIS_TITLE

String

Text 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)

TEXT_COLOR

3D integer array of the form:

[R, G, B]

Each color value may range from 0 to 255.

Text font

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

  • Helvetica
  • Courier
  • Times
  • Symbol
  • Hershey

Default = Helvetica

FONT_INDEX

0 (Helvetica--default)

1 (Courier)

2 (Times)

3 (Symbol)

4 (Hershey)

Text style

String List: Style used for tick and label text. 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 tick and label text. Edit the number to change the size. Default = 12

FONT_SIZE

Integer