Routines (alphabetical) > Object Classes > Graphics Object Classes > IDLgrColorbar Properties

# IDLgrColorbar Properties

IDLgrColorbar objects have the following properties in addition to properties inherited from any superclasses. Properties with the word “Yes” in the “Get” column of the property table can be retrieved via IDLgrColorbar::GetProperty. Properties with the word “Yes” in the “Init” column of the property table can be set via IDLgrColorbar::Init. Properties with the word “Yes” in the “Set” column in the property table can be set via IDLgrColorbar::SetProperty.

Note: For a discussion of the property description tables shown below, see About Object Property Descriptions.

Objects of this class have the following properties. See IDLgrColorbar Properties for details on individual properties.

- ALL
- BLUE_VALUES
- COLOR
- DIMENSIONS
- GREEN_VALUES
- HIDE
- MAJOR
- MINOR
- PALETTE
- PARENT
- RED_VALUES
- SHOW_AXIS
- SHOW_OUTLINE
- SUBTICKLEN
- THICK
- THREED
- TICKFORMAT
- TICKFRMTDATA
- TICKLEN
- TICKTEXT
- TICKVALUES
- TITLE
- XCOORD_CONV
- XRANGE
- YCOORD_CONV
- YRANGE
- ZCOORD_CONV
- ZRANGE

In addition, objects of this class inherit:

- IDLgrModel
- IDLitComponent

### ALL

An anonymous structure containing the values of all of the properties associated with the state of this object. State information about the object includes things like color, range, tick direction, etc., but not image, vertex, or connectivity data, or user values.

Note: The fields of this structure may change in subsequent releases of IDL.

Property Type | Structure
Name String | not displayed
Get: Yes | Set: No | Init: No | Registered: No

### BLUE_VALUES

A byte vector containing the blue values for the color palette. Setting this value is the same as specifying the aBlue argument to the IDLgrColorbar::Init method.

Property Type | Byte vector
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### COLOR

The color to be used as the foreground color for the axis and outline box. The color may be specified as a color lookup table index or as a three-element vector [red, green, blue]. The default is [0, 0, 0].

Property Type | Color
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### DIMENSIONS

A two element integer vector [dx, dy] that specifies the size of the ramp display (not the axis) in pixels. If dx > dy, the colorbar is drawn horizontally with the axis placed below or above the ramp box depending on the value of the SHOW_AXIS property. If dx < dy, the colorbar is drawn vertically with the axis placed to the right or left of the ramp box depending on the value of the SHOW_AXIS property. The default value is [16,256].

Property Type | Integer vector
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### GREEN_VALUES

A byte vector containing the green values for the color palette. Setting this value is the same as specifying the aGreen argument to the IDLgrColorbar::Init method.

Property Type | Byte vector
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### HIDE

A Boolean value to indicate whether this object should be drawn:

- 0 = Draw graphic (the default)
- 1 = Do not draw graphic

Property Type | Boolean
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### MAJOR

An integer that represents the number of major tick marks. The default is -1, specifying that IDL will compute the number of tickmarks. Setting MAJOR equal to zero suppresses major tickmarks entirely.

Property Type | Integer
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### MINOR

An integer representing the number of minor tick marks. The default is -1, specifying that IDL will compute the number of tickmarks. Setting MINOR equal to zero suppresses minor tickmarks entirely.

Property Type | Integer
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### PALETTE

An object reference to an instance of the IDLgrPalette object class. If this property is a valid object reference, the colors within the IDLgrPalette are used to specify the colors for the colorbar.

Note: Objects specified via this property are not automatically cleaned up when the IDLgrColorbar object is destroyed.

Property Type | Object reference
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### PARENT

An object reference to the object that contains this colorbar.

Property Type | Object reference
Name String | not displayed
Get: Yes | Set: No | Init: No | Registered: No

### RED_VALUES

A byte vector that contains the red values for the color palette. Setting this value is the same as specifying the aRed argument to the IDLgrColorbar::Init method.

Property Type | Byte vector
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### SHOW_AXIS

An integer value that indicates whether the axis should be drawn:

- 0 = Do not display axis (the default)
- 1 = Display axis on left side or below the color ramp
- 2 = Display axis on right side or above the color ramp

Property Type | Integer
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### SHOW_OUTLINE

A Boolean value indicating whether the colorbar bounds should be outlined:

- 0 = Do not display outline (the default)
- 1 = Display outline

Property Type | Boolean
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### SUBTICKLEN

A floating-point scale ratio specifying the length of minor tick marks relative to the length of major tick marks. The default is 0.5, specifying that the minor tick mark is one-half the length of the major tick mark.

Property Type | Floating-point
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### THICK

A floating-point value between 0.0 and 10.0, specifying the line thickness used to draw the axis and box outline, in points. A thickness of 0 displays a thin hairline on the chosen device. Out-of-range values are quietly clamped to the allowed range. The default is 1.0 points.

Property Type | Floating-point
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### THREED

A Boolean value that determines whether to create the colorbar as a graphic object that can be fully transformed in three dimensions on initialization. By default, the colorbar always faces the viewer and is drawn at z=0.

Property Type | Boolean
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### TICKFORMAT

Either a standard IDL format string (see Format Codes for details on format codes) or a string containing the name of a user-supplied function that returns a string to be used to format the axis tick mark labels. The function should accept integer arguments for the direction of the axis, the index of the tick mark, and the value of the tick mark, and should return a string to be used as the tick mark’s label. The function may optionally accept a keyword called DATA, which will be automatically set to the TICKFRMTDATA value. The default TICKFORMAT is '', an empty string, which indicates that IDL will determine the appropriate format for each value.

Note: If the user-defined function’s name does not begin with an open parenthesis, it is interpreted as the name of a callback function to be used to generate tick mark labels. This function is defined with either three or four parameters, depending on whether TICKUNITS is specified.

Property Type | String
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### TICKFRMTDATA

A user-defined value of any type passed via the DATA keyword to the user-supplied formatting function specified via the TICKFORMAT property, if any. By default, this value is undefined, indicating that the DATA property will be undefined (and furthermore, need not be supported by the user-supplied function). Note that TICKFRMTDATA will not be included in the structure returned via the ALL property to the IDLgrColorbar::GetProperty method.

Property Type | Scalar of any type
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### TICKLEN

A floating-point value that specifies the length of each major tick mark, measured in data units. The recommended, and default, tick mark length is 0.2. IDL converts, maintains, and returns this data as double-precision floating-point.

Property Type | Floating-point
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### TICKTEXT

An object reference to either a single instance of the IDLgrText object class (with multiple strings) or to a vector of instances of the IDLgrText object class (each with a single string) that specifies the annotations to be assigned to the tick marks. By default, TICKTEXT is set to the NULL object, which indicates that IDL will compute tick annotations based upon the major tick values. The positions and orientation of the provided text object(s) may be overwritten by the colorbar.

Note: Objects specified via this property are not automatically cleaned up when the IDLgrColorbar object is destroyed.

Property Type | Object reference or object reference vector
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### TICKVALUES

A floating-point vector of data values that represent the values at each tick mark. If TICKVALUES is set to 0, the default, IDL computes the tick values based on the axis range and the number of major ticks. IDL converts, maintains, and returns this data as double-precision floating-point.

Property Type | Floating-point vector
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### TITLE

An object reference to an instance of the IDLgrText object class to specify the title for the axis. The default is the null object, specifying that no title is drawn. The title will be centered along the axis, even if the text object itself has an associated location.

Note: Objects specified via this property are not automatically cleaned up when the IDLgrColorbar object is destroyed.

Property Type | Object reference
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### XCOORD_CONV

A floating-point vector, [s0, s1], of scaling factors used to convert X coordinates from data units to normalized units. The formula for the conversion is as follows:

NormalizedX = s0 + s1 * DataX

Recommended values are:

[(-Xmin)/(Xmax-Xmin), 1/(Xmax-Xmin)]

The default is [0.0, 1.0]. IDL converts, maintains, and returns this data as double-precision floating-point.

Property Type | Floating-point vector
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### XRANGE

A two-element double-precision floating-point vector of the form [xmin, xmax] specifying the range of the x data coordinates covered by the colorbar.

Property Type | Floating-point vector
Name String | not displayed
Get: Yes | Set: No | Init: No | Registered: No

### YCOORD_CONV

A floating-point vector, [s0, s1], of scaling factors that converts Y coordinates from data units to normalized units. The formula for the conversion is as follows:

NormalizedY = s0 + s1 * DataY

Recommended values are:

[(-Ymin)/(Ymax-Ymin), 1/(Ymax-Ymin)]

The default is [0.0, 1.0]. IDL converts, maintains, and returns this data as double-precision floating-point.

Property Type | Floating-point vector
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### YRANGE

A two-element double-precision floating-point vector of the form [ymin, ymax] that specifies the range of the Y data coordinates covered by the colorbar.

Property Type | Floating-point vector
Name String | not displayed
Get: Yes | Set: No | Init: No | Registered: No

### ZCOORD_CONV

A floating-point vector, [s0, s1], of scaling factors that converts Z coordinates from data units to normalized units. The formula for the conversion is as follows:

NormalizedZ = s0 + s1 * DataZ

Recommended values are:

[(-Zmin)/(Zmax-Zmin), 1/(Zmax-Zmin)]

The default is [0.0, 1.0]. IDL converts, maintains, and returns this data as double-precision floating-point.

Property Type | Floating-point vector
Name String | not displayed
Get: Yes | Set: Yes | Init: Yes | Registered: No

### ZRANGE

A two-element double-precision floating-point vector of the form [zmin, zmax] specifying the range of the Z data coordinates covered by the colorbar.

Note: Until the colorbar is drawn to the destination object, the [XYZ]RANGE properties will be zero. Use the ComputeDimensions method on the colorbar object to get the data dimensions of the colorbar prior to a draw operation.

Property Type | Floating-point vector
Name String | not displayed
Get: Yes | Set: No | Init: No | Registered: No