[AIT logo]

Institut für Astronomie und Astrophysik

Abteilung Astronomie

Sand 1, D-72076 Tübingen, Germany
[Uni logo]


legend Source code in cafe_legend.pro

legend

Name
           legend
Purpose
           draws legend information for plots
Category
           cafe
SYNTAX:
           legend, legitem1["["param"]"]][:grp1] +
                   legitem2["["param"]"]][:grp2] +....
                   [,pos][,/left][,/right][,/top][,/bottom]
Input Parameters
           legitem - What legend information should be drawn. These
                     items are given as separate subtasks.
                     These can be e.g.:
                       data  -  Information about data displayed in
                                current plot. Draws line/color
                                according lines.
                       result-  Information about last fit result.
                       param -  Information about (selected)
                                parameters of fit.
                       models-  Information about current model(s)
                                used.
                     Available legend items may be shown with
                      > help, legend, all
Optional Input Parameters
           param    - Allow to send some parameters to the legend plotting
                      handler.
           grp      - The groups to apply the legend to. The
                      interpretation depends on the legend type.
           pos      - Position (in normal coordinates) of legend to
                      plot at. This must be a 2 component float
                      vektor with [xpos, ypos] being the coordinates
                      of the upper left corner.
OPTIONS:
           top      - Plot at top position.
           bottom   - Plot at bottom position.
           left     - Plot at left position.
           right    - Plot at right position.
           mouse    - Define legend position via mouse click. Move
                      the mouse in current plot window until desired
                      position is reached and click with any mouse
                      button.
           nobox    - Do not plot a box frame around all legend
                      items.
        noadjust    - Do not try to adjust position to keep the
                      legend within the plot frame.
SETUP:
           All options may be set with the "set" command. The
           command prefix is "legend".
Side Effects
           Changes plot drawn.
Example
               > plot, data,delchi, 2
               > legend, data,/left
                -> plot data information on plot at left side.
Revision History
           $Id: cafe_legend.pro,v 1.14 2005/01/04 10:56:05 goehler Exp $

Last modified by pro2html on 2005 January 04 at 16:06 UTC

[Home Page] [Software, Documentation] [IDL Documentation] [Quick Reference] [Feedback]

Jörn Wilms (wilms@astro.uni-tuebingen.de)
Updated automatically