Documentation for test/

Generated by IDLdoc

single page | use frames     summary     class     fields     routine details     file attributes

./

idlgrcolorbar__define.pro


An IDLgrColorbar object consists of a color-ramp with an optional framing box and annotation axis.

The IDLgrColorbar::Init function method initializes the colorbar object. NOTE: Init methods are special lifecycle methods, and as such cannot be called outside the context of object creation. This means that in most cases, you cannot call the Init method directly. There is one exception to this rule: If you write your own subclass of this class, you can call the Init method from within the Init method of the subclass.

The IDLgrColorbar::ComputeDimensions method function computes and returns the dimensions of the colorbar for a given destination.

This method is intended to be private, and should never be called directly.

The IDLgrColorbar::Cleanup procedure method preforms all cleanup on the object. NOTE: Cleanup methods are special lifecycle methods, and as such cannot be called outside the context of object destruction. This means that in most cases, you cannot call the Cleanup method directly. There is one exception to this rule: If you write your own subclass of this class, you can call the Cleanup method from within the Cleanup method of the subclass.

The IDLgrColorbar::SetProperty procedure method sets the value of a property or group of properties for the colorbar.

The IDLgrColorbar::GetProperty procedure method retrieves the value of a property or group of properties for the colorbar.

Examples

myColorbar->GetProperty, PARENT = parent

Author information

History

Written by: Scott J. Lasica, 3/5/98 Modified: CT, RSI, Oct 2000 - Add support for colorbar-only - Fix calc for long titles or ticktext

Class description for IDLgrColorbar

Inheritance

All ancestor classes: IDLGRMODEL IDLGRCONTAINER IDL_CONTAINER IDLGRCOMPONENT IDLITCOMPONENT

Properties

Properties in IDLgrColorbar

ALL get
BLUE_VALUES get set init
COLOR get set init
DIMENSIONS get set init
GREEN_VALUES get set init
HIDE get set init
MAJOR get set init
MINOR get set init
NAME get set init
PALETTE get set init
PARENT get
RED_VALUES get set init
SHOW_AXIS get set init
SHOW_OUTLINE get set init
SUBTICKLEN get set init
THICK get set init
THREED get set init
TICKFORMAT get set init
TICKFRMTDATA get set init
TICKLEN get set init
TICKTEXT get set init
TICKVALUES get set init
TITLE get set init
TRANSFORM get
UVALUE get set init
XCOORD_CONV get set init
XRANGE get
YCOORD_CONV get set init
YRANGE get
ZCOORD_CONV get set init
ZRANGE get
_EXTRA set init
_REF_EXTRA get

Fields

Fields in IDLGRMODEL

Fields in IDLGRCONTAINER

Fields in IDL_CONTAINER

Fields in IDLGRCOMPONENT

Fields in IDLITCOMPONENT

Fields in IDLgrColorbar

DIMENSIONS [0.00000, 0.00000]
FREE_PALETTE 0S
IDLGRCOLORBARVERSION 0S
MAXDIM 0S
OAXIS obj_new()
OCOORDCONVNODE obj_new()
OIMAGE obj_new()
OPALETTE obj_new()
OPOLY obj_new()
OSCALENODE obj_new()
OSURF obj_new()
SHOW_AXIS 0S

Routines

Routines from idlgrcolorbar__define.pro

result = IDLgrColorbar::Init(aRed, aGreen, aBlue, BLUE_VALUES=BLUE_VALUES, COLOR=COLOR, DIMENSIONS=DIMENSIONS, GREEN_VALUES=GREEN_VALUES, RED_VALUES=RED_VALUES, HIDE=HIDE, MAJOR=MAJOR, MINOR=MINOR, NAME=NAME, SHOW_AXIS=SHOW_AXIS, SHOW_OUTLINE=SHOW_OUTLINE, SUBTICKLEN=SUBTICKLEN, THICK=THICK, TICKFORMAT=TICKFORMAT, TICKFRMTDATA=TICKFRMTDATA, TICKLEN=TICKLEN, TICKTEXT=TICKTEXT, TICKVALUES=TICKVALUES, TITLE=TITLE, UVALUE=UVALUE, XCOORD_CONV=XCOORD_CONV, YCOORD_CONV=YCOORD_CONV, ZCOORD_CONV=ZCOORD_CONV, THREED=THREED, PALETTE=PALETTE, _EXTRA=_EXTRA)
result = IDLgrColorbar::ComputeDimensions(oSrcDest, PATH=PATH)
IDLgrColorbar::CalcSize, DIMENSIONS=DIMENSIONS, THICK=THICK, SHOW_AXIS=SHOW_AXIS
IDLgrColorbar::Cleanup
IDLgrColorbar::SetProperty, BLUE_VALUES=BLUE_VALUES, COLOR=COLOR, DIMENSIONS=DIMENSIONS, GREEN_VALUES=GREEN_VALUES, RED_VALUES=RED_VALUES, HIDE=HIDE, MAJOR=MAJOR, MINOR=MINOR, NAME=NAME, SHOW_AXIS=SHOW_AXIS, SHOW_OUTLINE=SHOW_OUTLINE, SUBTICKLEN=SUBTICKLEN, THICK=THICK, THREED=THREED, TICKFORMAT=TICKFORMAT, TICKFRMTDATA=TICKFRMTDATA, TICKLEN=TICKLEN, TICKTEXT=TICKTEXT, TICKVALUES=TICKVALUES, TITLE=TITLE, UVALUE=UVALUE, XCOORD_CONV=XCOORD_CONV, YCOORD_CONV=YCOORD_CONV, ZCOORD_CONV=ZCOORD_CONV, PALETTE=PALETTE, _EXTRA=_EXTRA
IDLgrColorbar::GetProperty, BLUE_VALUES=BLUE_VALUES, COLOR=COLOR, DIMENSIONS=DIMENSIONS, GREEN_VALUES=GREEN_VALUES, RED_VALUES=RED_VALUES, HIDE=HIDE, MAJOR=MAJOR, MINOR=MINOR, NAME=NAME, SHOW_AXIS=SHOW_AXIS, SHOW_OUTLINE=SHOW_OUTLINE, SUBTICKLEN=SUBTICKLEN, THICK=THICK, TICKFORMAT=TICKFORMAT, TICKFRMTDATA=TICKFRMTDATA, TICKLEN=TICKLEN, TICKTEXT=TICKTEXT, TICKVALUES=TICKVALUES, TITLE=TITLE, TRANSFORM=TRANSFORM, UVALUE=UVALUE, XCOORD_CONV=XCOORD_CONV, YCOORD_CONV=YCOORD_CONV, ZCOORD_CONV=ZCOORD_CONV, ALL=ALL, PARENT=PARENT, XRANGE=XRANGE, YRANGE=YRANGE, ZRANGE=ZRANGE, THREED=THREED, PALETTE=PALETTE, _REF_EXTRA=_REF_EXTRA
IDLgrColorbar__Define

Routine details

top source IDLgrColorbar::Init

result = IDLgrColorbar::Init(aRed, aGreen, aBlue, BLUE_VALUES=BLUE_VALUES, COLOR=COLOR, DIMENSIONS=DIMENSIONS, GREEN_VALUES=GREEN_VALUES, RED_VALUES=RED_VALUES, HIDE=HIDE, MAJOR=MAJOR, MINOR=MINOR, NAME=NAME, SHOW_AXIS=SHOW_AXIS, SHOW_OUTLINE=SHOW_OUTLINE, SUBTICKLEN=SUBTICKLEN, THICK=THICK, TICKFORMAT=TICKFORMAT, TICKFRMTDATA=TICKFRMTDATA, TICKLEN=TICKLEN, TICKTEXT=TICKTEXT, TICKVALUES=TICKVALUES, TITLE=TITLE, UVALUE=UVALUE, XCOORD_CONV=XCOORD_CONV, YCOORD_CONV=YCOORD_CONV, ZCOORD_CONV=ZCOORD_CONV, THREED=THREED, PALETTE=PALETTE, _EXTRA=_EXTRA)

Parameters

aRed
aGreen
aBlue

Keywords

BLUE_VALUES
COLOR
DIMENSIONS
GREEN_VALUES
RED_VALUES
HIDE
MAJOR
MINOR
NAME
SHOW_AXIS
SHOW_OUTLINE
SUBTICKLEN
THICK
TICKFORMAT
TICKFRMTDATA
TICKLEN
TICKTEXT
TICKVALUES
TITLE
UVALUE
XCOORD_CONV
YCOORD_CONV
ZCOORD_CONV
THREED
PALETTE
_EXTRA

top source IDLgrColorbar::ComputeDimensions

result = IDLgrColorbar::ComputeDimensions(oSrcDest, PATH=PATH)

Parameters

oSrcDest

Keywords

PATH

top source IDLgrColorbar::CalcSize

IDLgrColorbar::CalcSize, DIMENSIONS=DIMENSIONS, THICK=THICK, SHOW_AXIS=SHOW_AXIS

Keywords

DIMENSIONS
THICK
SHOW_AXIS

top source IDLgrColorbar::Cleanup

IDLgrColorbar::Cleanup

top source IDLgrColorbar::SetProperty

IDLgrColorbar::SetProperty, BLUE_VALUES=BLUE_VALUES, COLOR=COLOR, DIMENSIONS=DIMENSIONS, GREEN_VALUES=GREEN_VALUES, RED_VALUES=RED_VALUES, HIDE=HIDE, MAJOR=MAJOR, MINOR=MINOR, NAME=NAME, SHOW_AXIS=SHOW_AXIS, SHOW_OUTLINE=SHOW_OUTLINE, SUBTICKLEN=SUBTICKLEN, THICK=THICK, THREED=THREED, TICKFORMAT=TICKFORMAT, TICKFRMTDATA=TICKFRMTDATA, TICKLEN=TICKLEN, TICKTEXT=TICKTEXT, TICKVALUES=TICKVALUES, TITLE=TITLE, UVALUE=UVALUE, XCOORD_CONV=XCOORD_CONV, YCOORD_CONV=YCOORD_CONV, ZCOORD_CONV=ZCOORD_CONV, PALETTE=PALETTE, _EXTRA=_EXTRA

Keywords

BLUE_VALUES
COLOR
DIMENSIONS
GREEN_VALUES
RED_VALUES
HIDE
MAJOR
MINOR
NAME
SHOW_AXIS
SHOW_OUTLINE
SUBTICKLEN
THICK
THREED
TICKFORMAT
TICKFRMTDATA
TICKLEN
TICKTEXT
TICKVALUES
TITLE
UVALUE
XCOORD_CONV
YCOORD_CONV
ZCOORD_CONV
PALETTE
_EXTRA

top source IDLgrColorbar::GetProperty

IDLgrColorbar::GetProperty, BLUE_VALUES=BLUE_VALUES, COLOR=COLOR, DIMENSIONS=DIMENSIONS, GREEN_VALUES=GREEN_VALUES, RED_VALUES=RED_VALUES, HIDE=HIDE, MAJOR=MAJOR, MINOR=MINOR, NAME=NAME, SHOW_AXIS=SHOW_AXIS, SHOW_OUTLINE=SHOW_OUTLINE, SUBTICKLEN=SUBTICKLEN, THICK=THICK, TICKFORMAT=TICKFORMAT, TICKFRMTDATA=TICKFRMTDATA, TICKLEN=TICKLEN, TICKTEXT=TICKTEXT, TICKVALUES=TICKVALUES, TITLE=TITLE, TRANSFORM=TRANSFORM, UVALUE=UVALUE, XCOORD_CONV=XCOORD_CONV, YCOORD_CONV=YCOORD_CONV, ZCOORD_CONV=ZCOORD_CONV, ALL=ALL, PARENT=PARENT, XRANGE=XRANGE, YRANGE=YRANGE, ZRANGE=ZRANGE, THREED=THREED, PALETTE=PALETTE, _REF_EXTRA=_REF_EXTRA

Keywords

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

top source IDLgrColorbar__Define

IDLgrColorbar__Define

File attributes

Modification date: Mon Mar 28 21:43:39 2016
Lines: 560