1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Interacting with Plots (GNU Octave (version 6.2.0))</title>
<meta name="description" content="Interacting with Plots (GNU Octave (version 6.2.0))">
<meta name="keywords" content="Interacting with Plots (GNU Octave (version 6.2.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="High_002dLevel-Plotting.html" rel="up" title="High-Level Plotting">
<link href="Test-Plotting-Functions.html" rel="next" title="Test Plotting Functions">
<link href="Printing-and-Saving-Plots.html" rel="prev" title="Printing and Saving Plots">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<span id="Interacting-with-Plots"></span><div class="header">
<p>
Next: <a href="Test-Plotting-Functions.html" accesskey="n" rel="next">Test Plotting Functions</a>, Previous: <a href="Printing-and-Saving-Plots.html" accesskey="p" rel="prev">Printing and Saving Plots</a>, Up: <a href="High_002dLevel-Plotting.html" accesskey="u" rel="up">High-Level Plotting</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<span id="Interacting-with-Plots-1"></span><h4 class="subsection">15.2.10 Interacting with Plots</h4>
<p>The user can select points on a plot with the <code>ginput</code> function or
select the position at which to place text on the plot with the
<code>gtext</code> function using the mouse.
</p>
<span id="XREFginput"></span><dl>
<dt id="index-ginput">: <em>[<var>x</var>, <var>y</var>, <var>buttons</var>] =</em> <strong>ginput</strong> <em>(<var>n</var>)</em></dt>
<dt id="index-ginput-1">: <em>[<var>x</var>, <var>y</var>, <var>buttons</var>] =</em> <strong>ginput</strong> <em>()</em></dt>
<dd><p>Return the position and type of mouse button clicks and/or key strokes
in the current figure window.
</p>
<p>If <var>n</var> is defined, then capture <var>n</var> events before returning.
When <var>n</var> is not defined <code>ginput</code> will loop until the return key
<tt class="key">RET</tt> is pressed.
</p>
<p>The return values <var>x</var>, <var>y</var> are the coordinates where the mouse
was clicked in the units of the current axes. The return value <var>button</var>
is 1, 2, or 3 for the left, middle, or right button. If a key is pressed
the ASCII value is returned in <var>button</var>.
</p>
<p>Implementation Note: <code>ginput</code> is intenteded for 2-D plots. For 3-D
plots see the <var>currentpoint</var> property of the current axes which can be
transformed with knowledge of the current <code>view</code> into data units.
</p>
<p><strong>See also:</strong> <a href="#XREFgtext">gtext</a>, <a href="#XREFwaitforbuttonpress">waitforbuttonpress</a>.
</p></dd></dl>
<span id="XREFwaitforbuttonpress"></span><dl>
<dt id="index-waitforbuttonpress">: <em></em> <strong>waitforbuttonpress</strong> <em>()</em></dt>
<dt id="index-waitforbuttonpress-1">: <em><var>b</var> =</em> <strong>waitforbuttonpress</strong> <em>()</em></dt>
<dd><p>Wait for mouse click or key press over the current figure window.
</p>
<p>The return value of <var>b</var> is 0 if a mouse button was pressed or 1 if a
key was pressed.
</p>
<p><strong>See also:</strong> <a href="GUI-Utility-Functions.html#XREFwaitfor">waitfor</a>, <a href="#XREFginput">ginput</a>, <a href="Terminal-Input.html#XREFkbhit">kbhit</a>.
</p></dd></dl>
<span id="XREFgtext"></span><dl>
<dt id="index-gtext">: <em></em> <strong>gtext</strong> <em>(<var>s</var>)</em></dt>
<dt id="index-gtext-1">: <em></em> <strong>gtext</strong> <em>({<var>s1</var>, <var>s2</var>, …})</em></dt>
<dt id="index-gtext-2">: <em></em> <strong>gtext</strong> <em>({<var>s1</var>; <var>s2</var>; …})</em></dt>
<dt id="index-gtext-3">: <em></em> <strong>gtext</strong> <em>(…, <var>prop</var>, <var>val</var>, …)</em></dt>
<dt id="index-gtext-4">: <em><var>h</var> =</em> <strong>gtext</strong> <em>(…)</em></dt>
<dd><p>Place text on the current figure using the mouse.
</p>
<p>The string argument <var>s</var> may be a character array or a cell array
of strings. If <var>s</var> has more than one row, each row is used
to create a separate text object after a mouse click. For example:
</p>
<p>Place a single string after one mouse click
</p>
<div class="example">
<pre class="example">gtext ("I clicked here")
</pre></div>
<p>Place two strings after two mouse clicks
</p>
<div class="example">
<pre class="example">gtext ({"I clicked here"; "and there"})
</pre></div>
<p>Place two strings, each with two lines, after two mouse clicks
</p>
<div class="example">
<pre class="example">gtext ({"I clicked", "here"; "and", "there"})
</pre></div>
<p>Optional <var>property</var>/<var>value</var> pairs are passed directly to the
underlying text objects.
</p>
<p>The full list of text object properties is documented at
<a href="Text-Properties.html">Text Properties</a>.
</p>
<p>The optional return value <var>h</var> holds the graphics handle(s) to the
created text object(s).
</p>
<p><strong>See also:</strong> <a href="#XREFginput">ginput</a>, <a href="Plot-Annotations.html#XREFtext">text</a>.
</p></dd></dl>
<p>More sophisticated user interaction mechanisms can be obtained using the
ui* family of functions, see <a href="UI-Elements.html">UI Elements</a>.
</p>
<hr>
<div class="header">
<p>
Next: <a href="Test-Plotting-Functions.html" accesskey="n" rel="next">Test Plotting Functions</a>, Previous: <a href="Printing-and-Saving-Plots.html" accesskey="p" rel="prev">Printing and Saving Plots</a>, Up: <a href="High_002dLevel-Plotting.html" accesskey="u" rel="up">High-Level Plotting</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
