MGHGRCOLORBAR2_

MGHGRCOLORBAR2__DEFINE

Class Name

MGHgrColorBar2

Purpose

This class implements a colour bar, ie a rectangular bar
showing a mapping between numeric values and colours.

Superclasses

This class inherits from IDLgrModel.

Properties

The following properties are supported:
AXIS (Get)
This keyword returns a reference to the axis object. It can be used
to modify the axis properties.
BYTE_RANGE (Init,Get,Set)
The range of byte values to which the data range is to be mapped.
COLORSCALE (Init)
A reference to an object from which default colour mapping information
(BYTE_RANGE, DATA_RANGE and PALETTE) can be retrieved.
DATA_RANGE (Init,Get,Set)
The range of data values to be mapped onto the indexed color range.
Data values outside the range are mapped to the nearest end of the range.
DELTAZ (Init,Get,Set)
Vertical spacing in normalised units between the components of the
object, needed to control visibility. If this property is
not set, then the spacing is set at draw time, based on the view's
ZCLIP property--the value is 2*(ZCLIP[0] - ZCLIP[1])/65536, which
for the default ZCLIP is 6.1E-5. DELTAZ should only need to be
set explicitly if the object or its parent is transformed before
drawing.
LOCATION (Init,Get,Set)
Location of the lower left corner of the rectangle in data units.
DIMENSIONS (Init,Get,Set)
Horizontal & vertical dimensions of the rectangle in data units.
PALETTE (Init,Get,Set)
A reference to the palette defining the byte-color mapping.
TICKIN (Init,Get,Set)
Controls whether tick marks are directed inwards (1) or outwards (0).
The default is 0.
TITLE (Init,Get,Set)
A reference to a text object representing the axis title. If this is
specified as a string, then a text object is created automatically
using the current setting of the FONT property.
XCOORD_CONV (Init,Get,Set)
YCOORD_CONV (Init,Get,Set)
ZCOORD_CONV (Init,Get,Set)
Coordinate transformations specifying the relationship between
normalised & data units.
XRANGE (Get)
YRANGE (Get)
ZRANGE (Get)
Position of the extremes of the object in data units. ZRANGE is
not finalised until the object is drawn.

Methods

The usual.
###########################################################################
This software is provided subject to the following conditions:
1. NIWA makes no representations or warranties regarding the
accuracy of the software, the use to which the software may
be put or the results to be obtained from the use of the
software. Accordingly NIWA accepts no liability for any loss
or damage (whether direct of indirect) incurred by any person
through the use of or reliance on the software.
2. NIWA is to be acknowledged as the original author of the
software where the software is used or presented in any form.
###########################################################################

Modification History

Mark Hadfield, Aug 1998:
Written.