hcolorbar__define.pro


Name:
HColorBar
Description:
The purpose of this program is to create a horizontal
colorbar object to be used in conjunction with other
IDL 5 graphics objects.

Name:
hcolorbar::init
Type:
Function (constructor)
Arguments:
COLOR  : A three-element array representing the RGB values of a color
for the colorbar axes and annotation. The default value is
white: [255,255,255].
FONTSIZE: A floating value that is the point size of the font
used for the axis and title annotations. Set to 8 point by default.
NAME   : The name associated with this object.
NCOLORS: The number of colors associated with the colorbar. The
default is 256.
MAJOR  : The number of major tick divisions on the colorbar axes.
The default is 5.
MINOR  : The number of minor tick marks on the colorbar axes.
The default is 4.
PALETTE: A palette object for the colorbar. The default palette
is a gray-scale palette object.
POSITION: A four-element array specifying the position of the
colorbar in the arbitary coordinate system of the viewplane
rectangle. The default position is [0.90, 0.10, 0.95, 0.90].
RANGE  : The range associated with the colorbar axis. The default
is [0, NCOLORS].
TITLE  : A string containing a title for the colorbar axis
annotation. The default is a null string.
Return value:
1 or 0 for true/false. For '0', IDL will return the null-object
Description:
A HCOLORBAR object is created. The colorbar INHERITS IDLgrMODEL.
Thus, all IDLgrMODEL methods and keywords can also be used. It is
the model that is selected in a selection event, since the SELECT_TARGET
keyword is set for the model.

Name:
hcolorbar::cleanup
Type:
Destructor
Description:
the destructor

Name:
hcolorbar::getProperty
Type:
Procedure
Description:
Returns colorbar properties in keyword
parameters as defined for the INIT method. Keywords allowed are:
COLOR
MAJOR
MINOR
NAME
PALETTE
POSITION
RANGE
TEXT
TITLE
TRANSFORM

Name:
hcolorbar::setProperty
Type:
Procedure
Description:
Sets colorbar properties in keyword
parameters as defined for the INIT method. Keywords allowed are:
COLOR
MAJOR
MINOR
NAME
PALETTE
POSITION
RANGE
TEXT
TITLE
TRANSFORM

Name:
hcolorbar::clamp
Type:
Procedure
Arguments:
datarange : two element array
Description:
This method clamps the data to a particular data range:
Given a two-element array in the data range of
the colorbar, the colorbar image is clamped to this range. In
other words, the range of colors is clamped to the specified
range. Values above or below the range in the colorbar are set to
the minimum and maximum range values, respectively.

Name:
hcolorbar_normalize
Type:
Function
Return value:
the scaling factor
Description:
This is a utility function to calculate the scale factor
required to position a vector of specified range at a
specific position given in normalized coordinates.

Name:
hcolorbar__define
Type:
Private procedure
Description:
the constructor, inherits the IDLgrModel object

Last modified: Mon Nov 29 13:30:05 2004