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
145
146
147
|
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Interacting with Plots (GNU Octave (version 10.3.0))</title>
<meta name="description" content="Interacting with Plots (GNU Octave (version 10.3.0))">
<meta name="keywords" content="Interacting with Plots (GNU Octave (version 10.3.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<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.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
kbd.key {font-style: normal}
span:hover a.copiable-link {visibility: visible}
strong.def-name {font-family: monospace; font-weight: bold; font-size: larger}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<div class="subsection-level-extent" id="Interacting-with-Plots">
<div class="nav-panel">
<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>
<h4 class="subsection" id="Interacting-with-Plots-1"><span>15.2.10 Interacting with Plots<a class="copiable-link" href="#Interacting-with-Plots-1"> ¶</a></span></h4>
<p>The user can select points on a plot with the <code class="code">ginput</code> function or
select the position at which to place text on the plot with the
<code class="code">gtext</code> function using the mouse.
</p>
<a class="anchor" id="XREFginput"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-ginput"><span><code class="def-type">[<var class="var">x</var>, <var class="var">y</var>, <var class="var">buttons</var>] =</code> <strong class="def-name">ginput</strong> <code class="def-code-arguments">(<var class="var">n</var>)</code><a class="copiable-link" href="#index-ginput"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-ginput-1"><span><code class="def-type">[<var class="var">x</var>, <var class="var">y</var>, <var class="var">buttons</var>] =</code> <strong class="def-name">ginput</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href="#index-ginput-1"> ¶</a></span></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 class="var">n</var> is defined, then capture <var class="var">n</var> events before returning.
When <var class="var">n</var> is not defined <code class="code">ginput</code> will loop until the return key
<kbd class="key">RET</kbd> is pressed.
</p>
<p>The return values <var class="var">x</var>, <var class="var">y</var> are the coordinates where the mouse
was clicked in the units of the current axes. The return value <var class="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 class="var">button</var>.
</p>
<p>Implementation Note: <code class="code">ginput</code> is intenteded for 2-D plots. For 3-D
plots see the <var class="var">currentpoint</var> property of the current axes which can be
transformed with knowledge of the current <code class="code">view</code> into data units.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFgtext">gtext</a>, <a class="ref" href="#XREFwaitforbuttonpress">waitforbuttonpress</a>.
</p></dd></dl>
<a class="anchor" id="XREFwaitforbuttonpress"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-waitforbuttonpress"><span><code class="def-type"><var class="var">b</var> =</code> <strong class="def-name">waitforbuttonpress</strong> <code class="def-code-arguments">()</code><a class="copiable-link" href="#index-waitforbuttonpress"> ¶</a></span></dt>
<dd><p>Wait for mouse click or key press over the current figure window.
</p>
<p>The return value of <var class="var">b</var> is 0 if a mouse button was pressed or 1 if a
key was pressed.
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="GUI-Utility-Functions.html#XREFwaitfor">waitfor</a>, <a class="ref" href="#XREFginput">ginput</a>, <a class="ref" href="Terminal-Input.html#XREFkbhit">kbhit</a>.
</p></dd></dl>
<a class="anchor" id="XREFgtext"></a><span style="display:block; margin-top:-4.5ex;"> </span>
<dl class="first-deftypefn">
<dt class="deftypefn" id="index-gtext"><span><strong class="def-name">gtext</strong> <code class="def-code-arguments">(<var class="var">s</var>)</code><a class="copiable-link" href="#index-gtext"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-gtext-1"><span><strong class="def-name">gtext</strong> <code class="def-code-arguments">({<var class="var">s1</var>, <var class="var">s2</var>, …})</code><a class="copiable-link" href="#index-gtext-1"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-gtext-2"><span><strong class="def-name">gtext</strong> <code class="def-code-arguments">({<var class="var">s1</var>; <var class="var">s2</var>; …})</code><a class="copiable-link" href="#index-gtext-2"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-gtext-3"><span><strong class="def-name">gtext</strong> <code class="def-code-arguments">(…, <var class="var">prop</var>, <var class="var">val</var>, …)</code><a class="copiable-link" href="#index-gtext-3"> ¶</a></span></dt>
<dt class="deftypefnx def-cmd-deftypefn" id="index-gtext-4"><span><code class="def-type"><var class="var">h</var> =</code> <strong class="def-name">gtext</strong> <code class="def-code-arguments">(…)</code><a class="copiable-link" href="#index-gtext-4"> ¶</a></span></dt>
<dd><p>Place text on the current figure using the mouse.
</p>
<p>The string argument <var class="var">s</var> may be a character array or a cell array
of strings. If <var class="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-preformatted">gtext ("I clicked here")
</pre></div>
<p>Place two strings after two mouse clicks
</p>
<div class="example">
<pre class="example-preformatted">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-preformatted">gtext ({"I clicked", "here"; "and", "there"})
</pre></div>
<p>Optional <var class="var">property</var>/<var class="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 class="ref" href="Text-Properties.html">Text Properties</a>.
</p>
<p>The optional return value <var class="var">h</var> holds the graphics handle(s) to the
created text object(s).
</p>
<p><strong class="strong">See also:</strong> <a class="ref" href="#XREFginput">ginput</a>, <a class="ref" 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 class="pxref" href="UI-Elements.html">UI Elements</a>.
</p>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Test-Plotting-Functions.html">Test Plotting Functions</a>, Previous: <a href="Printing-and-Saving-Plots.html">Printing and Saving Plots</a>, Up: <a href="High_002dLevel-Plotting.html">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>
|
