Skip to content

d.background

Fills the graphics display frame with user defined color.

d.background color=name [--verbose] [--quiet] [--qq] [--ui]

Example:

d.background color=name

grass.script.run_command("d.background", color, verbose=False, quiet=False, superquiet=False)

Example:

gs.run_command("d.background", color="name")

Parameters

color=name [required]
    Background color
    Either a standard color name or R:G:B triplet
--help
    Print usage summary
--verbose
    Verbose module output
--quiet
    Quiet module output
--qq
    Very quiet module output
--ui
    Force launching GUI dialog

color : str, required
    Background color
    Either a standard color name or R:G:B triplet
    Used as: input, color, name
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.background will fill the image (or generally display monitor) with a single color specified by the color option.

NOTES

d.background is a frontend to d.erase and shares its limitations. Namely, it does not work with the wx monitors such as d.mon wx0.

EXAMPLES

In this example, the streets_wake map from the North Carolina sample dataset is displayed with custom background color (specified using HTML hex color code) using cairo display monitor (creates file called map.png):

g.region vector=streets_wake
d.mon cairo
d.background color=#ADEFD1
d.vect map=streets_wake color=#00203F legend_label="Streets"
d.legend.vect -b at=70,30 title="Wake County"

Street network with legend and background color

Figure: Wake County street network with custom background color (North Carolina sample dataset)

SEE ALSO

d.erase

AUTHOR

Vaclav Petras, NCSU GeoForAll Lab

SOURCE CODE

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