<<prev file | next file >>    view single page | view frames    summary: fields | routine    details: routine

ToBeReviewed/COULEURS/

colorbar.pro

topCOLORBAR

COLORBAR, BOTTOM=BOTTOM, CB_CHARSIZE=CB_CHARSIZE, CB_CHARTHICK=CB_CHARTHICK, CB_COLOR=CB_COLOR, DIVISIONS=DIVISIONS, DISCRET=DISCRET, CB_LABEL=CB_LABEL, FORMAT=FORMAT, POSITION=POSITION, MAX=MAX, MIN=MIN, NCOLORS=NCOLORS, PSCOLOR=PSCOLOR, CB_TITLE=CB_TITLE, VERTICAL=VERTICAL, TOP=TOP, RIGHT=RIGHT, CB_LOG=CB_LOG, _extra=_extra

NAME: COLORBAR PURPOSE: The purpose of this routine is to add a color bar to the current graphics window. CATEGORY: Graphics, Widgets. CALLING SEQUENCE: COLORBAR INPUTS: None. KEYWORD PARAMETERS: BOTTOM: The lowest color index of the colors to be loaded in the bar. CB_CHARSIZE: The character size of the color bar annotations. Default is 1.0. CB_CHARTICK: The character thick of the color bar annotations. Default is 1.0. CB_COLOR: The color index of the bar outline and characters. Default is ncolors - 1 + bottom. CB_LOG: to get logarithmic scale for the colorbar CB_TITLE: This is title for the color bar. The default is to have no title. DISCRET: Vecteur contenant les incices des couleurs a tracer en barre de couleur. On obtient ainsi une barre de couleur discrete ne comportant que les couleurs specifiees ds l'ordre ou elles apparaissent ds le vecteur. DIVISIONS: The number of divisions to divide the bar into. There will be (divisions + 1) annotations. The default is 2. FORMAT: The format of the bar annotations. Default is '(F6.2)'. CB_LABEL: C''est un vecteur qui specifie la valeur des sticks presents dans la barre de couleur. Il permet qd on utilise DISCRET d''avoir des couleurs qui ne s''incrementent pas de facon regulieres. MAX: The maximum data value for the bar annotation. Default is NCOLORS-1. MIN: The minimum data value for the bar annotation. Default is 0. NCOLORS: This is the number of colors in the color bar. NOTITLE: oblige a ne pas mettre de titre meme si cb_title est declare POSITION: A four-element array of normalized coordinates in the same form as the POSITION keyword on a plot. Default is [0.88, 0.15, 0.95, 0.95] for a vertical bar and [0.15, 0.88, 0.95, 0.95] for a horizontal bar. PSCOLOR: This keyword is only applied if the output is being sent to a PostScript file. It indicates that the PostScript device is configured for color output. If this keyword is set, then the annotation is drawn in the color specified by the COLOR keyword. If the keyword is not set, the annotation is drawn in the color specified by the !P.COLOR system variable (usually this will be the color black). In general, this gives better looking output on non-color or gray-scale printers. If you are not specifically setting the annotation color (with the COLOR keyword), it will probably be better NOT to set this keyword either, even if you are outputting to a color PostScript printer. RIGHT: This puts the labels on the right-hand side of a vertical color bar. It applies only to vertical color bars. TOP: This puts the labels on top of the bar rather than under it. The keyword only applies if a horizontal color bar is rendered. VERTICAL: Setting this keyword give a vertical color bar. The default is a horizontal color bar. COMMON BLOCKS: None. SIDE EFFECTS: Color bar is drawn in the current graphics window. RESTRICTIONS: The number of colors available on the display device (not the PostScript device) is used unless the NCOLORS keyword is used. EXAMPLE: To display a horizontal color bar above a contour plot, type: LOADCT, 5, NCOLORS=100 CONTOUR, DIST(31,41), POSITION=[0.15, 0.15, 0.95, 0.75], $ C_COLORS=INDGEN(25)*4, NLEVELS=25 COLORBAR, NCOLORS=100 MODIFICATION HISTORY: Written by: David Fanning, 10 JUNE 96. 10/27/96: Added the ability to send output to PostScript. DWF 11/4/96: Substantially rewritten to go to screen or PostScript file without having to know much about the PostScript device or even what the current graphics device is. DWF 1/27/97: Added the RIGHT and TOP keywords. Also modified the way the TITLE keyword works. DWF 7/15/97: Fixed a problem some machines have with plots that have no valid data range in them. DWF 3/3/98: ajout du keyword discret par

Keywords

BOTTOM       

CB_CHARSIZE       

CB_CHARTHICK       

CB_COLOR       

DIVISIONS       

DISCRET       

CB_LABEL       

FORMAT       

POSITION       

MAX       

MIN       

NCOLORS       

PSCOLOR       

CB_TITLE       

VERTICAL       

TOP       

RIGHT       

CB_LOG       

_extra       

Produced by IDLdoc 2.0.