Skip to content

d.rast.leg

Displays a raster map and its legend on a graphics window

d.rast.leg [-fns] map=name [lines=integer] [raster=name] [--verbose] [--quiet] [--qq] [--ui]

Example:

d.rast.leg map=name

grass.script.run_command("d.rast.leg", map, lines=None, raster=None, flags=None, verbose=False, quiet=False, superquiet=False)

Example:

gs.run_command("d.rast.leg", map="name")

Parameters

map=name [required]
    Name of raster map to display
lines=integer
    Number of lines to appear in the legend
raster=name
    Name of input raster map to generate legend from
-f
    Flip legend
-n
    Omit entries with missing label
-s
    Draw smooth gradient
--help
    Print usage summary
--verbose
    Verbose module output
--quiet
    Quiet module output
--qq
    Very quiet module output
--ui
    Force launching GUI dialog

map : str, required
    Name of raster map to display
    Used as: input, raster, name
lines : int, optional
    Number of lines to appear in the legend
raster : str, optional
    Name of input raster map to generate legend from
    Used as: input, raster, name
flags : str, optional
    Allowed values: f, n, s
    f
        Flip legend
    n
        Omit entries with missing label
    s
        Draw smooth gradient
verbose: bool, optional
    Verbose module output
    Default: False
quiet: bool, optional
    Quiet module output
    Default: False
superquiet: bool, optional
    Very quiet module output
    Default: False

DESCRIPTION

d.rast.leg shows a raster map along with its legend. It first clears the entire screen, then divides it into a main (left) and a minor (right) frames, and displays a raster map in the main frame and the map legend in the minor frame. The main frame remains active when the program finishes.

NOTES

The legend may be flipped with the -f flag.

If the lines parameter is not given then the legend frame will display as many lines as number of categories in the map, otherwise, it will display the first lines minus 1 categories with the rest being truncated.

The user may adjust the lines parameter or the size of graphics window to get an appropriate result.

The user may specify a second raster map with the raster parameter from which the legend is generated. This is useful to visualize (time) series of raster maps with a common static legend instead of the default dynamic legend.

To remove all frames when clearing the display, use d.erase -f.

EXAMPLE

In this example, the polar diagram of the 'aspect' angle map in the North Carolina sample dataset is generated:

g.region raster=landclass96 -p
d.rast.leg landclass96

SEE ALSO

d.legend, d.erase, d.rast

AUTHORS

Jianping Xu, Scott Madry, Rutgers University
Markus Neteler

SOURCE CODE

Available at: d.rast.leg source code (history)
Latest change: Friday Feb 07 19:16:09 2025 in commit a82a39f