File: Root-Properties.html

package info (click to toggle)
octave 6.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 124,192 kB
  • sloc: cpp: 322,665; ansic: 68,088; fortran: 20,980; objc: 8,121; sh: 7,719; yacc: 4,266; lex: 4,123; perl: 1,530; java: 1,366; awk: 1,257; makefile: 424; xml: 147
file content (255 lines) | stat: -rw-r--r-- 9,984 bytes parent folder | download 
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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
<!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>Root Properties (GNU Octave (version 6.2.0))</title>

<meta name="description" content="Root Properties (GNU Octave (version 6.2.0))">
<meta name="keywords" content="Root Properties (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="Graphics-Object-Properties.html" rel="up" title="Graphics Object Properties">
<link href="Figure-Properties.html" rel="next" title="Figure Properties">
<link href="Graphics-Object-Properties.html" rel="prev" title="Graphics Object Properties">
<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="Root-Properties"></span><div class="header">
<p>
Next: <a href="Figure-Properties.html" accesskey="n" rel="next">Figure Properties</a>, Up: <a href="Graphics-Object-Properties.html" accesskey="u" rel="up">Graphics Object Properties</a> &nbsp; [<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="Root-Properties-1"></span><h4 class="subsubsection">15.3.3.1 Root Properties</h4>
<span id="index--Root-PropertiesRoot-Properties"></span>



<p>Properties of the root graphics object:
</p>
<dl compact="compact">
<dd>
<span id="XREFrootbeingdeleted"></span><span id="index-root-beingdeleted"></span>
</dd>
<dt><code>beingdeleted</code>: {<code>&quot;off&quot;</code>} | <code>&quot;on&quot;</code></dt>
<dd><p><code>beingdeleted</code> is unused.
</p>

<span id="XREFrootbusyaction"></span><span id="index-root-busyaction"></span>
</dd>
<dt><code>busyaction</code>: <code>&quot;cancel&quot;</code> | {<code>&quot;queue&quot;</code>}</dt>
<dd><p><code>busyaction</code> is unused.
</p>

<span id="XREFrootbuttondownfcn"></span><span id="index-root-buttondownfcn"></span>
</dd>
<dt><code>buttondownfcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p><code>buttondownfcn</code> is unused.
</p>

<span id="XREFrootcallbackobject"></span><span id="index-root-callbackobject"></span>
</dd>
<dt><code>callbackobject</code> (read-only): graphics handle, def. <code>[](0x0)</code></dt>
<dd><p>Graphics handle of the current object whose callback is executing.
</p>

<span id="XREFrootchildren"></span><span id="index-root-children"></span>
</dd>
<dt><code>children</code> (read-only): vector of graphics handles, def. <code>[](0x1)</code></dt>
<dd><p>Graphics handles of the root&rsquo;s children.
</p>

<span id="XREFrootclipping"></span><span id="index-root-clipping"></span>
</dd>
<dt><code>clipping</code>: <code>&quot;off&quot;</code> | {<code>&quot;on&quot;</code>}</dt>
<dd><p><code>clipping</code> is unused.
</p>

<span id="XREFrootcommandwindowsize"></span><span id="index-root-commandwindowsize"></span>
</dd>
<dt><code>commandwindowsize</code> (read-only): def. <code>[0   0]</code></dt>
<dd>


<span id="XREFrootcreatefcn"></span><span id="index-root-createfcn"></span>
</dd>
<dt><code>createfcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p><code>createfcn</code> is unused.
</p>

<span id="XREFrootcurrentfigure"></span><span id="index-root-currentfigure"></span>
</dd>
<dt><code>currentfigure</code>: graphics handle, def. <code>[](0x0)</code></dt>
<dd><p>Graphics handle of the current figure.
</p>

<span id="XREFrootdeletefcn"></span><span id="index-root-deletefcn"></span>
</dd>
<dt><code>deletefcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p><code>deletefcn</code> is unused.
</p>

<span id="XREFrootfixedwidthfontname"></span><span id="index-root-fixedwidthfontname"></span>
</dd>
<dt><code>fixedwidthfontname</code>: string, def. <code>&quot;Courier&quot;</code></dt>
<dd>


<span id="XREFroothandlevisibility"></span><span id="index-root-handlevisibility"></span>
</dd>
<dt><code>handlevisibility</code>: <code>&quot;callback&quot;</code> | <code>&quot;off&quot;</code> | {<code>&quot;on&quot;</code>}</dt>
<dd><p><code>handlevisibility</code> is unused.
</p>

<span id="XREFroothittest"></span><span id="index-root-hittest"></span>
</dd>
<dt><code>hittest</code>: <code>&quot;off&quot;</code> | {<code>&quot;on&quot;</code>}</dt>
<dd><p><code>hittest</code> is unused.
</p>

<span id="XREFrootinterruptible"></span><span id="index-root-interruptible"></span>
</dd>
<dt><code>interruptible</code>: <code>&quot;off&quot;</code> | {<code>&quot;on&quot;</code>}</dt>
<dd><p><code>interruptible</code> is unused.
</p>

<span id="XREFrootmonitorpositions"></span><span id="index-root-monitorpositions"></span>
</dd>
<dt><code>monitorpositions</code> (read-only):</dt>
<dd><p><code>monitorpositions</code> is unused.
</p>

<span id="XREFrootparent"></span><span id="index-root-parent"></span>
</dd>
<dt><code>parent</code>: graphics handle, def. <code>[](0x0)</code></dt>
<dd><p>Root object has no parent graphics object.  <code>parent</code> is always empty.
</p>

<span id="XREFrootpickableparts"></span><span id="index-root-pickableparts"></span>
</dd>
<dt><code>pickableparts</code>: <code>&quot;all&quot;</code> | <code>&quot;none&quot;</code> | {<code>&quot;visible&quot;</code>}</dt>
<dd><p><code>pickableparts</code> is unused.
</p>

<span id="XREFrootpointerlocation"></span><span id="index-root-pointerlocation"></span>
</dd>
<dt><code>pointerlocation</code>: two-element vector, def. <code>[0   0]</code></dt>
<dd><p><code>pointerlocation</code> is unused.
</p>

<span id="XREFrootpointerwindow"></span><span id="index-root-pointerwindow"></span>
</dd>
<dt><code>pointerwindow</code> (read-only): graphics handle, def. <code>0</code></dt>
<dd><p><code>pointerwindow</code> is unused.
</p>

<span id="XREFrootscreendepth"></span><span id="index-root-screendepth"></span>
</dd>
<dt><code>screendepth</code> (read-only): double</dt>
<dd>


<span id="XREFrootscreenpixelsperinch"></span><span id="index-root-screenpixelsperinch"></span>
</dd>
<dt><code>screenpixelsperinch</code> (read-only): double</dt>
<dd>


<span id="XREFrootscreensize"></span><span id="index-root-screensize"></span>
</dd>
<dt><code>screensize</code> (read-only): four-element vector</dt>
<dd>


<span id="XREFrootselected"></span><span id="index-root-selected"></span>
</dd>
<dt><code>selected</code>: {<code>&quot;off&quot;</code>} | <code>&quot;on&quot;</code></dt>
<dd><p><code>selected</code> is unused.
</p>

<span id="XREFrootselectionhighlight"></span><span id="index-root-selectionhighlight"></span>
</dd>
<dt><code>selectionhighlight</code>: <code>&quot;off&quot;</code> | {<code>&quot;on&quot;</code>}</dt>
<dd><p><code>selectionhighlight</code> is unused.
</p>

<span id="XREFrootshowhiddenhandles"></span><span id="index-root-showhiddenhandles"></span>
</dd>
<dt><code>showhiddenhandles</code>: {<code>&quot;off&quot;</code>} | <code>&quot;on&quot;</code></dt>
<dd><p>If <code>showhiddenhandles</code> is <code>&quot;on&quot;</code>, all graphics objects handles are visible in their parents&rsquo; children list, regardless of the value of their <code>handlevisibility</code> property.
</p>

<span id="XREFroottag"></span><span id="index-root-tag"></span>
</dd>
<dt><code>tag</code>: string, def. <code>&quot;&quot;</code></dt>
<dd><p>A user-defined string to label the graphics object.
</p>

<span id="XREFroottype"></span><span id="index-root-type"></span>
</dd>
<dt><code>type</code> (read-only): string</dt>
<dd><p>Class name of the graphics object.  <code>type</code> is always <code>&quot;root&quot;</code>
</p>

<span id="XREFrootuicontextmenu"></span><span id="index-root-uicontextmenu"></span>
</dd>
<dt><code>uicontextmenu</code>: graphics handle, def. <code>[](0x0)</code></dt>
<dd><p><code>uicontextmenu</code> is unused.
</p>

<span id="XREFrootunits"></span><span id="index-root-units"></span>
</dd>
<dt><code>units</code>: <code>&quot;centimeters&quot;</code> | <code>&quot;characters&quot;</code> | <code>&quot;inches&quot;</code> | <code>&quot;normalized&quot;</code> | {<code>&quot;pixels&quot;</code>} | <code>&quot;points&quot;</code></dt>
<dd>


<span id="XREFrootuserdata"></span><span id="index-root-userdata"></span>
</dd>
<dt><code>userdata</code>: Any Octave data, def. <code>[](0x0)</code></dt>
<dd><p>User-defined data to associate with the graphics object.
</p>

<span id="XREFrootvisible"></span><span id="index-root-visible"></span>
</dd>
<dt><code>visible</code>: <code>&quot;off&quot;</code> | {<code>&quot;on&quot;</code>}</dt>
<dd><p><code>visible</code> is unused.
</p>
</dd>
</dl>


<hr>
<div class="header">
<p>
Next: <a href="Figure-Properties.html" accesskey="n" rel="next">Figure Properties</a>, Up: <a href="Graphics-Object-Properties.html" accesskey="u" rel="up">Graphics Object Properties</a> &nbsp; [<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>