Colorbar

Figure D-22: Visualization Browser with Colorbar Properties Displayed

VizBrowserColorbar.gif

These properties control colorbar 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

Table D-52: Colorbar Container Properties 

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

Border

Boolean: Set border on or off. Choose True or False.

Default = False

BORDER_ON

0 (False)

1 (True)

Orientation

Boolean: Set orientation of colorbar. Choose Horizontal or Vertical.

Default = Horizontal

ORIENTATION

0 (Horizontal)

1 (Vertical)

Transparency

Number: Adjusts transparency of colorbar.

Default = 0

TRANSPARENCY

Integer from 0 to 100.

Color

Color: Color to be used for the colorbar 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 colorbar lines. Select a line style from the list. Default = Colorbar-31.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 colorbar 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: Set number of major tick marks. Enter value.

Default = 3

MAJOR

Integer

Minor ticks

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

Default = 0

MINOR

Integer

Major tick length

Number: Factor from 0 - 1 determining major tick length. Move slider to change the size.

Default = .05

TICKLEN

Floating point value from 0 to 1.

Minor tick length

Number: Factor from 0 - 1 determining minor tick length. Move slider to change the size.

Default = 1

SUBTICKLEN

Floating point value from 0 to 1.

Tick interval

Number: Set tick interval. Enter value.

Default = 0

TICKINTERVAL

Floating point

Tick layout

String List: Set tick layout type. Choose between these values:

  • Axis plus labels
  • Labels only
  • Box style

Default = Axis plus labels

TICKLAYOUT

0 (Axis plus labels)

1 (Labels only)

2 (Box style)

Tick direction

String List: Set tick direction. Choose between these values:

  • Right/Above
  • Left/Below

Default = Right/Above

TICKDIR

0 (Right/above--default)

1 (Left/below)

Logarithmic axis

Default = false

LOG

0 (False)

1 (True)

Text show

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

Default = True (show)

NOTEXT

0 (Hide)

1 (Show--default)

Text position

String List: Set text position. Choose between these values:

  • Below/left
  • Above/right

Default = Below/left

TEXTPOS

0 (Below/left--default)

1 (Above/right)

Tick format code

Shows the code for the tick format selected. Default = empty

TICKFORMAT

String

Tick format

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

  • None
  • Use Tick Format Code
  • 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

Title: Enter title for colorbar.

Default = RGB Table 0

AXIS_TITLE

String

Text color

Color: Color to be used for the legend 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 legend 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 legend 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 legend text. Edit the number to change the size. Default = 12

FONT_SIZE

Integer

.