NAME

d.legend - Displays a legend for a raster map layer in the active frame on the graphics monitor.
(GRASS Display Program)

SYNOPSIS

d.legend
d.legend help
d.legend [-n] map=name [color=name] [lines=value] [show=name]

DESCRIPTION

d.legend displays a legend for a user-specified raster map layer in the active frame on the graphics monitor. The legend's size is based on the height of the active frame. The user should therefore take care to create a display frame of suitable dimensions before running d.legend. d.legend will only obscure those portions of the active frame that directly underlie the legend.

The user can run d.legend either non-interactively or interactively. If the user specifies the name of a raster map layer on the command line, the program will run non-interactively. Default legend text color and number of lines will be used unless the user specifies other values on the command line.

Alternately, the user can simply type d.legend on the command line; in this case, the program will prompt the user for parameter values using the standard GRASS parser interface.

Flag:

-n
Do not display no data (NULL) values in legend.

Parameters:

map=name
Name of a raster map layer whose legend is to be displayed in the active display frame.
color=name
Sets the legend text color to the name stated.
Options: red, orange, yellow, green, blue, indigo, violet, magenta, brown, gray, white, and black.
Default: white
lines=value
Number of lines to appear in the map legend.
The number of lines refers to the maximum number of lines of type that can be displayed given the height of the active display frame. If unspecified by the user, the program will divide the display frame into the number of lines required to display all of the category labels and colors associated with the named map. To decrease the size of the displayed text, increase the number of lines.
Options: 1 - 1000
Default: Set lines value equal to the number of map categories
show=name
Show either values or categories. Or both
options: val,cat
default: val,cat

NOTES

The legend text size is based on the number of lines requested (or, by default, on the number of lines needed to display the legend). If the user attempts to display a very long legend in a relatively short display frame, the legend may appear in unreadably small text.

SEE ALSO

d.colormode d.colors d.colortable d.display
d.erase d.font d.frame d.grid
d.label d.labels d.rast d.scale
parser

AUTHOR

James Westervelt, U.S. Army Construction Engineering Research Laboratory