<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--Converted with LaTeX2HTML 2008 (1.71)
original version by: Nikos Drakos, CBLU, University of Leeds
* revised and updated by: Marcus Hennecke, Ross Moore, Herb Swan
* with significant contributions from:
Jens Lippmann, Marek Rouchal, Martin Wilck and others -->
<HTML>
<HEAD>
<TITLE>Mouse</TITLE>
<META NAME="description" CONTENT="Mouse">
<META NAME="keywords" CONTENT="gnuplot">
<META NAME="resource-type" CONTENT="document">
<META NAME="distribution" CONTENT="global">
<META NAME="Generator" CONTENT="LaTeX2HTML v2008">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="STYLESHEET" HREF="gnuplot.css">
<LINK REL="next" HREF="node229.html">
<LINK REL="previous" HREF="node226.html">
<LINK REL="up" HREF="node175.html">
<LINK REL="next" HREF="node228.html">
</HEAD>
<BODY >
<!--Navigation Panel-->
<A NAME="tex2html4476"
HREF="node228.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html4470"
HREF="node175.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html4464"
HREF="node226.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html4472"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<A NAME="tex2html4474"
HREF="node467.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html4477"
HREF="node228.html">X11 mouse</A>
<B> Up:</B> <A NAME="tex2html4471"
HREF="node175.html">Set-show</A>
<B> Previous:</B> <A NAME="tex2html4465"
HREF="node226.html">Margin</A>
<B> <A NAME="tex2html4473"
HREF="node1.html">Contents</A></B>
<B> <A NAME="tex2html4475"
HREF="node467.html">Index</A></B>
<BR>
<BR>
<!--End of Navigation Panel-->
<H2><A NAME="SECTION0402439000000000000000"></A>
<A NAME="commands_set_mouse"></A><A NAME="commands_unset_mouse"></A><A NAME="set_mouse"></A><A NAME="unset_mouse"></A><A NAME="mousing"></A><A NAME="5320"></A>
<A NAME="mouse"></A><A NAME="5322"></A>
<A NAME="nomouse"></A><A NAME="5324"></A>
<BR>
Mouse
</H2>
The command <B>set mouse</B> enables mouse actions. Currently the pm, x11, ggi,
windows and wxt terminals are mouse enhanced. There are two mouse modes. The
2d-graph mode works for 2d graphs and for maps (i.e. splots with <B>set view</B>
having z-rotation 0, 90, 180, 270 or 360 degrees, including <B>set view map</B>)
and it allows tracing the position over graph, zooming, annotating graph etc.
For 3d graphs <B>splot</B>, the view and scaling of the graph can be changed with
mouse buttons 1 and 2. If additionally to these buttons the modifier 4#4ctrl5#5 is
hold down, the coordinate system only is rotated which is useful for large
data sets. A vertical motion of Button 2 with the shift key hold down changes
the <B>xyplane</B>.
<P>
Mousing is not available in multiplot mode. When multiplot is finished using
<B>unset multiplot</B>, then the mouse will be turned on again and acts on the
last plot (like replot does).
<P>
Syntax:
<BR>
<PRE>
set mouse {doubleclick <ms>} {nodoubleclick} \
{{no}zoomcoordinates} \
{noruler | ruler {at x,y}} \
{polardistance{deg|tan} | nopolardistance} \
{format <string>} \
{clipboardformat <int>/<string>} \
{mouseformat <int>/<string>} \
{{no}labels {"labeloptions"}} \
{{no}zoomjump} {{no}verbose}
unset mouse
</PRE>
<BR>
<P>
The doubleclick resolution is given in milliseconds and used for Button 1
which copies the current mouse position to the <B>clipboard</B>. If you want that
to be done by single clicking a value of 0 ms can be used. The default value
is 300 ms.
<P>
The option <B>zoomcoordinates</B> determines if the coordinates of the zoom box are
drawn at the edges while zooming. This is on by default.
<P>
The options <B>noruler</B> and <B>ruler</B> switch the ruler off and on, the
latter optionally setting the origin at the given coordinates. While
the ruler is on, the distance in user units from the ruler origin to
the mouse is displayed continuously. By default, toggling the ruler
has the key binding 'r'.
<P>
The option <B>polardistance</B> determines if the distance between the mouse cursor
and the ruler is also shown in polar coordinates (distance and angle in
degrees or tangent (slope)). This corresponds to the default key binding '5'.
<P>
The <B>format</B> option takes a fprintf like format string which determines how
floating point numbers are printed to the drivers window and the clipboard.
The default is <TT>"</TT>% #g<TT>"</TT>.
<P>
<B>clipboardformat</B> and <B>mouseformat</B> are used for formatting the text on
Button1 and Button2 actions - copying the coordinates to the clipboard and
temporarily annotating the mouse position. This corresponds to the key
bindings '1', '2', '3', '4' (see the driver's documentation). If the argument
is a string this string is used as c format specifier and should contain two
float specifiers, e.g. <B>set mouse mouseformat <TT>"</TT>mouse = %5.2g, %10.2f<TT>"</TT></B>. Use
<B>set mouse mouseformat <TT>""</TT></B> to turn this string off again.
<P>
The following formats are available (format 6 may only be selected if the
format string was specified already):
<P>
<BR>
<PRE>
0 real coordinates in brackets e.g. [1.23, 2.45]
1 real coordinates w/o brackets e.g. 1.23, 2.45
2 x == timefmt [(as set by `set timefmt`), 2.45]
3 x == date [31. 12. 1999, 2.45]
4 x == time [23:59, 2.45]
5 x == date / time [31. 12. 1999 23:59, 2.45]
6 alt. format, specified as string ""
</PRE>
<BR>
<P>
<A NAME="5349"></A>
Choose the option <B>labels</B> to define persistent gnuplot labels using Button 2.
The default is <B>nolabels</B>, which makes Button 2 draw only a temporary label at
the mouse position. Labels are drawn with the current setting of <B>mouseformat</B>.
The <B>labeloptions</B> string is passed to the <B>set label</B> command. The default is
<TT>"</TT>point pointstyle 1<TT>"</TT> which will plot a small plus at the label position.
Temporary labels will disappear at the next <B>replot</B> or mouse zoom operation.
Persistent labels can be removed by holding the Ctrl-Key down while clicking
Button 2 on the label's point. The threshold for how close you must be to the
label is also determined by the <B>pointsize</B>.
<P>
If the option <B>zoomjump</B> is on, the mouse pointer will be automatically
offset a small distance after starting a zoom region with button 3. This can
be useful to avoid a tiny (or even empty) zoom region. <B>zoomjump</B> is off by
default.
<P>
If the option <B>verbose</B> is turned on the communication commands are shown
during execution. This option can also be toggled by hitting <B>6</B> in the
driver's window. <B>verbose</B> is off by default.
<P>
Press 'h' in the driver's window for a short summary of the mouse and key
bindings. This will also display user defined bindings or <B>hotkeys</B> which
can be defined using the <B>bind</B> command, see help for <B>bind (p. <A HREF="node42.html#bind"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>)<A NAME="5367"></A></B>. Note, that user
defined <B>hotkeys</B> may override the default bindings.
<P>
Press 'q' in the driver's window to close the window. This key cannot be
overridden with the <B>bind</B> command.
<P>
See also help for <B>bind (p. <A HREF="node42.html#bind"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>)<A NAME="5371"></A></B> and <B>label (p. <A HREF="node219.html#label"><IMG ALIGN="BOTTOM" BORDER="1" ALT="[*]" SRC="crossref.png"></A>)<A NAME="5373"></A></B>.
<BR><HR>
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"><STRONG>Subsections</STRONG></A>
<UL>
<LI><A NAME="tex2html4478"
HREF="node228.html">X11 mouse</A>
</UL>
<!--End of Table of Child-Links-->
<HR>
<!--Navigation Panel-->
<A NAME="tex2html4476"
HREF="node228.html">
<IMG WIDTH="37" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="next" SRC="next.png"></A>
<A NAME="tex2html4470"
HREF="node175.html">
<IMG WIDTH="26" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="up" SRC="up.png"></A>
<A NAME="tex2html4464"
HREF="node226.html">
<IMG WIDTH="63" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="previous" SRC="prev.png"></A>
<A NAME="tex2html4472"
HREF="node1.html">
<IMG WIDTH="65" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="contents" SRC="contents.png"></A>
<A NAME="tex2html4474"
HREF="node467.html">
<IMG WIDTH="43" HEIGHT="24" ALIGN="BOTTOM" BORDER="0" ALT="index" SRC="index.png"></A>
<BR>
<B> Next:</B> <A NAME="tex2html4477"
HREF="node228.html">X11 mouse</A>
<B> Up:</B> <A NAME="tex2html4471"
HREF="node175.html">Set-show</A>
<B> Previous:</B> <A NAME="tex2html4465"
HREF="node226.html">Margin</A>
<B> <A NAME="tex2html4473"
HREF="node1.html">Contents</A></B>
<B> <A NAME="tex2html4475"
HREF="node467.html">Index</A></B>
<!--End of Navigation Panel-->
<ADDRESS>
2010-08-17
</ADDRESS>
</BODY>
</HTML>
