d.frame.html 6.28 KB
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>d.frame.py - GRASS GIS manual</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link rel="stylesheet" href="grassdocs.css" type="text/css">
</head>
<body bgcolor="white">
<div id="container">

<a href="index.html"><img src="grass_logo.png" alt="GRASS logo"></a>
<hr class="header">

<h2>NAME</h2>
<em><b>d.frame.py</b></em>  - Manages display frames on the user's graphics monitor.
<h2>KEYWORDS</h2>
<a href="display.html">display</a>, <a href="topic_graphics.html">graphics</a>, <a href="keywords.html#monitors">monitors</a>, <a href="keywords.html#frame">frame</a>
<h2>SYNOPSIS</h2>
<div id="name"><b>d.frame.py</b><br></div>
<b>d.frame.py --help</b><br>
<div id="synopsis"><b>d.frame.py</b> [-<b>cepa</b>] <b>frame</b>=<em>name</em>  [<b>at</b>=<em>bottom,top,left,right</em>]   [--<b>overwrite</b>]  [--<b>help</b>]  [--<b>verbose</b>]  [--<b>quiet</b>]  [--<b>ui</b>] 
</div>

<div id="flags">
<h3>Flags:</h3>
<dl>
<dt><b>-c</b></dt>
<dd>Create a new frame if doesn't exist and select</dd>

<dt><b>-e</b></dt>
<dd>Remove all frames, erase the screen and exit</dd>

<dt><b>-p</b></dt>
<dd>Print name of current frame and exit</dd>

<dt><b>-a</b></dt>
<dd>Print names of all frames including 'at' position and exit</dd>

<dt><b>--overwrite</b></dt>
<dd>Allow output files to overwrite existing files</dd>
<dt><b>--help</b></dt>
<dd>Print usage summary</dd>
<dt><b>--verbose</b></dt>
<dd>Verbose module output</dd>
<dt><b>--quiet</b></dt>
<dd>Quiet module output</dd>
<dt><b>--ui</b></dt>
<dd>Force launching GUI dialog</dd>
</dl>
</div>

<div id="parameters">
<h3>Parameters:</h3>
<dl>
<dt><b>frame</b>=<em>name</em>&nbsp;<b>[required]</b></dt>
<dd>Frame to be selected or created (if -c flag is given)</dd>

<dt><b>at</b>=<em>bottom,top,left,right</em></dt>
<dd>Screen coordinates in percent where to place the frame (0,0 is lower-left)</dd>
<dd>Implies only when -c or --overwrite flag is given</dd>
<dd>Options: <em>0-100</em></dd>

</dl>
</div>
<div class="toc">
<h4 class="toc">Table of contents</h4>
<ul class="toc">
    <li class="toc"><a href="#description" class="toc">DESCRIPTION</a></li>
    <li class="toc"><a href="#notes" class="toc">NOTES</a></li>
    <li class="toc"><a href="#example" class="toc">EXAMPLE</a></li>
    <li class="toc"><a href="#see-also" class="toc">SEE ALSO</a></li>
    <li class="toc"><a href="#author" class="toc">AUTHOR</a></li>
</ul>
</div>
<h2><a name="description">DESCRIPTION</a></h2>

<em>d.frame</em> manages display frames on the current user's graphics
monitor. Graphics are displayed in rectangular frames on whatever
graphics monitor the user is currently directing GRASS display output
to (defined by <em><a href="d.mon.html">d.mon</a></em> module). These
frames are created and managed with this module.

<p>
Note that GRASS frame contents <em>are not</em> retained when one
frame covers another. You cannot shuffle frames from top to bottom and
then back again. They simply define rectangular areas on the screen
where subsequent drawing will occur.

<h2><a name="notes">NOTES</a></h2>

The coordinates for the <b>at</b> option are stated in the form
<em>top,bottom,left,right</em> values are in percent. The upper-left
corner of the graphics monitor always is at location 0,0 while the
monitor's lower-right corner is always at 100,100.

<p>
If the user has created multiple display frames that overlap one another, 
whatever the user displays in the active frame will overwrite 
those portions of the underlying frame where these frames overlap. 

<h2><a name="example">EXAMPLE</a></h2>

<div class="code"><pre>
# start a new graphics monitor, the data will be rendered to
# /tmp/map.png image output file of size 600x540px
d.mon cairo out=/tmp/map.png width=600 height=540 --o

# set up region
g.region raster=elevation

# remove all frames and erase the current graphics monitor
d.frame -e

# create a first frame and display 'landuse96_28m' raster map including text label
# order: bottom,top,left,right - in percent 
d.frame -c frame=first at=0,50,0,50
d.rast landuse96_28m
d.text text='Landuse' bgcolor=220:220:220 color=black size=6

# create a second frame and display 'streams' vector map
d.frame -c frame=second at=0,50,50,100
d.vect streams color=blue
d.text text='Streams' bgcolor=220:220:220 color=black size=6

# create a third frame and display 'elevation' raster map including text label and scale
d.frame -c frame=third at=50,100,0,50
d.rast elevation
d.text text='Elevation' bgcolor=220:220:220 color=black size=6
d.barscale at=0,10 style=line bgcolor=none

# create a fourth frame and display RGB composition map including text label
d.frame -c frame=fourth at=50,100,50,100
d.rgb red=lsat7_2002_30 green=lsat7_2002_20 blue=lsat7_2002_10
d.text text='RGB true colors' bgcolor=220:220:220 color=black size=6

# release the current graphics monitor
d.mon -r
</pre></div>

<center>
  <img src="d_frame.png" alt="d.frame example"><br>
  <em>Figure: d.frame example</em>
</center>

<h2><a name="see-also">SEE ALSO</a></h2>

<em>
  <a href="d.erase.html">d.erase</a>,
  <a href="d.info.html">d.info</a>,
  <a href="d.mon.html">d.mon</a>,
  <a href="d.redraw.html">d.redraw</a>
</em>

<p>
  <a href="variables.html#list-of-selected-grass-environment-variables-for-rendering">GRASS environment variables for
  rendering</a> (GRASS_RENDER_FRAME)
  
<h2><a name="author">AUTHOR</a></h2>

Martin Landa, Czech Technical University in Prague, Czech Republic

<p>
Based on <em>d.frame</em> from GRASS 6:<br>
James Westervelt, U.S. Army Construction Engineering Research
Laboratory<br>
Michael Shapiro, U.S. Army Construction Engineering 
Research Laboratory

<!--
<p>
<i>Last changed: $Date$</i>
--><h2>SOURCE CODE</h2>
<p>Available at: <a href="https://github.com/OSGeo/grass/tree/master/scripts/d.frame">d.frame source code</a> (<a href="https://github.com/OSGeo/grass/commits/master/scripts/d.frame">history</a>)</p>
<hr class="header">
<p>
<a href="index.html">Main index</a> |
<a href="display.html">Display index</a> |
<a href="topics.html">Topics index</a> |
<a href="keywords.html">Keywords index</a> |
<a href="graphical_index.html">Graphical index</a> |
<a href="full_index.html">Full index</a>
</p>
<p>
&copy; 2003-2020
<a href="http://grass.osgeo.org">GRASS Development Team</a>,
GRASS GIS 7.8.5 Reference Manual
</p>

</div>
</body>
</html>