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
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
|
<!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>Figure Properties (GNU Octave (version 10.3.0))</title>
<meta name="description" content="Figure Properties (GNU Octave (version 10.3.0))">
<meta name="keywords" content="Figure Properties (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="Graphics-Object-Properties.html" rel="up" title="Graphics Object Properties">
<link href="Axes-Properties.html" rel="next" title="Axes Properties">
<link href="Root-Properties.html" rel="prev" title="Root Properties">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<div class="subsubsection-level-extent" id="Figure-Properties">
<div class="nav-panel">
<p>
Next: <a href="Axes-Properties.html" accesskey="n" rel="next">Axes Properties</a>, Previous: <a href="Root-Properties.html" accesskey="p" rel="prev">Root Properties</a>, Up: <a href="Graphics-Object-Properties.html" accesskey="u" rel="up">Graphics Object Properties</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="subsubsection" id="Figure-Properties-1"><span>15.3.3.2 Figure Properties<a class="copiable-link" href="#Figure-Properties-1"> ¶</a></span></h4>
<a class="index-entry-id" id="index-Figure-Properties"></a>
<p>Properties of <code class="code">figure</code> objects (see <a class="pxref" href="Multiple-Plot-Windows.html#XREFfigure">figure</a>):
</p>
<h4 class="subsubheading" id="Categories_003a-1"><span>Categories:<a class="copiable-link" href="#Categories_003a-1"> ¶</a></span></h4>
<p><a class="ref" href="#XREFfigurecategoryAppearance">Appearance<!-- /@w --></a> | <a class="ref" href="#XREFfigurecategoryCallbackExecution">Callback Execution<!-- /@w --></a> | <a class="ref" href="#XREFfigurecategoryCreation_002fDeletion">Creation/Deletion<!-- /@w --></a> | <a class="ref" href="#XREFfigurecategoryDisplay">Display<!-- /@w --></a> | <a class="ref" href="#XREFfigurecategoryKeyboardInteraction">Keyboard Interaction<!-- /@w --></a> | <a class="ref" href="#XREFfigurecategoryMouseInteraction">Mouse Interaction<!-- /@w --></a> | <a class="ref" href="#XREFfigurecategoryObjectIdentification">Object Identification<!-- /@w --></a> | <a class="ref" href="#XREFfigurecategoryObjectPosition">Object Position<!-- /@w --></a> | <a class="ref" href="#XREFfigurecategoryParent_002fChildren">Parent/Children<!-- /@w --></a> | <a class="ref" href="#XREFfigurecategoryPrinting_002fSaving">Printing/Saving<!-- /@w --></a> | <a class="ref" href="#XREFfigurecategoryUnused">Unused<!-- /@w --></a>
</p>
<a class="anchor" id="XREFfigurecategoryAppearance"></a><h4 class="subsubheading" id="Appearance"><span>Appearance<a class="copiable-link" href="#Appearance"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFfigurealphamap"></a></dd>
<dt><a id="index-figure-alphamap"></a><span><code class="code">alphamap</code>: def. 64-by-1 double<a class="copiable-link" href="#index-figure-alphamap"> ¶</a></span></dt>
<dd><p>Transparency is not yet implemented for figure objects. <code class="code">alphamap</code> is unused.
</p>
<a class="anchor" id="XREFfigurecolor"></a></dd>
<dt><a id="index-figure-color"></a><span><code class="code">color</code>: colorspec, def. <code class="code">[1 1 1]</code><a class="copiable-link" href="#index-figure-color"> ¶</a></span></dt>
<dd><p>Color of the figure background. See <a class="xref" href="Colors.html">colorspec</a>.
</p>
<a class="anchor" id="XREFfigurecolormap"></a></dd>
<dt><a id="index-figure-colormap"></a><span><code class="code">colormap</code>: N-by-3 matrix, def. 256-by-3 double<a class="copiable-link" href="#index-figure-colormap"> ¶</a></span></dt>
<dd><p>A matrix containing the RGB color map for the current axes.
</p>
<a class="anchor" id="XREFfiguregraphicssmoothing"></a></dd>
<dt><a id="index-figure-graphicssmoothing"></a><span><code class="code">graphicssmoothing</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-figure-graphicssmoothing"> ¶</a></span></dt>
<dd><p>Use smoothing techniques to reduce the appearance of jagged lines.
</p>
<a class="anchor" id="XREFfigurename"></a></dd>
<dt><a id="index-figure-name"></a><span><code class="code">name</code>: string, def. <code class="code">""</code><a class="copiable-link" href="#index-figure-name"> ¶</a></span></dt>
<dd><p>Name to be displayed in the figure title bar. The name is displayed to the right of any title determined by the <code class="code">numbertitle</code> property.
</p>
<a class="anchor" id="XREFfigurenumbertitle"></a></dd>
<dt><a id="index-figure-numbertitle"></a><span><code class="code">numbertitle</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-figure-numbertitle"> ¶</a></span></dt>
<dd><p>Display <code class="code">"Figure"</code> followed by the numerical figure handle value in the figure title bar.
</p>
</dd>
</dl>
<a class="anchor" id="XREFfigurecategoryCallbackExecution"></a><h4 class="subsubheading" id="Callback-Execution-1"><span>Callback Execution<a class="copiable-link" href="#Callback-Execution-1"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFfigurebusyaction"></a></dd>
<dt><a id="index-figure-busyaction"></a><span><code class="code">busyaction</code>: <code class="code">"cancel"</code> | {<code class="code">"queue"</code>}<a class="copiable-link" href="#index-figure-busyaction"> ¶</a></span></dt>
<dd><p>Define how Octave handles the execution of this object’s callback properties when it is unable to interrupt another object’s executing callback. This is only relevant when the currently executing callback object has its <code class="code">interruptible</code> property set to <code class="code">"off"</code>. The <code class="code">busyaction</code> property of the interrupting callback object indicates whether the interrupting callback is queued (<code class="code">"queue"</code> (default)) or discarded (<code class="code">"cancel"</code>).
See <a class="xref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFfigureinterruptible"></a></dd>
<dt><a id="index-figure-interruptible"></a><span><code class="code">interruptible</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-figure-interruptible"> ¶</a></span></dt>
<dd><p>Specify whether this object’s callback functions may be interrupted by other callbacks. By default <code class="code">interruptible</code> is <code class="code">"on"</code> and callbacks that make use of <code class="code">drawnow</code>, <code class="code">figure</code>, <code class="code">waitfor</code>, <code class="code">getframe</code> or <code class="code">pause</code> functions are eventually interrupted.
See <a class="xref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
</dd>
</dl>
<a class="anchor" id="XREFfigurecategoryCreation_002fDeletion"></a><h4 class="subsubheading" id="Creation_002fDeletion"><span>Creation/Deletion<a class="copiable-link" href="#Creation_002fDeletion"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFfigurebeingdeleted"></a></dd>
<dt><a id="index-figure-beingdeleted"></a><span><code class="code">beingdeleted</code>: {<code class="code">"off"</code>} | <code class="code">"on"</code><a class="copiable-link" href="#index-figure-beingdeleted"> ¶</a></span></dt>
<dd><p>Property indicating that a function has initiated deletion of the object. <code class="code">beingdeleted</code> is set to true until the object no longer exists.
</p>
<a class="anchor" id="XREFfigurecloserequestfcn"></a></dd>
<dt><a id="index-figure-closerequestfcn"></a><span><code class="code">closerequestfcn</code>: string | function handle, def. <code class="code">"closereq"</code><a class="copiable-link" href="#index-figure-closerequestfcn"> ¶</a></span></dt>
<dd><p>Function that is executed when a figure is deleted. See <a class="xref" href="Manipulation-of-Plot-Windows.html#XREFclosereq">closereq function</a>.
</p>
<p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFfigurecreatefcn"></a></dd>
<dt><a id="index-figure-createfcn"></a><span><code class="code">createfcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-figure-createfcn"> ¶</a></span></dt>
<dd><p>Callback function executed immediately after figure has been created. Function is set by using default property on root object, e.g., <code class="code">set (groot, "defaultfigurecreatefcn", 'disp ("figure created!")')</code>.
</p>
<p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFfiguredeletefcn"></a></dd>
<dt><a id="index-figure-deletefcn-1"></a><span><code class="code">deletefcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-figure-deletefcn-1"> ¶</a></span></dt>
<dd><p>Callback function executed immediately before figure is deleted.
</p>
<p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
</dd>
</dl>
<a class="anchor" id="XREFfigurecategoryDisplay"></a><h4 class="subsubheading" id="Display"><span>Display<a class="copiable-link" href="#Display"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFfigurevisible"></a></dd>
<dt><a id="index-figure-visible"></a><span><code class="code">visible</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-figure-visible"> ¶</a></span></dt>
<dd><p>If <code class="code">visible</code> is <code class="code">"off"</code>, the figure is not rendered on screen.
</p>
<a class="anchor" id="XREFfigurewindowstate"></a></dd>
<dt><a id="index-figure-windowstate"></a><span><code class="code">windowstate</code>: <code class="code">"fullscreen"</code> | <code class="code">"maximized"</code> | <code class="code">"minimized"</code> | {<code class="code">"normal"</code>}<a class="copiable-link" href="#index-figure-windowstate"> ¶</a></span></dt>
<dd><p>Window state adjustment is not yet implemented for figure objects. <code class="code">windowstate</code> is unused.
</p>
<a class="anchor" id="XREFfigurewindowstyle"></a></dd>
<dt><a id="index-figure-windowstyle"></a><span><code class="code">windowstyle</code>: <code class="code">"docked"</code> | <code class="code">"modal"</code> | {<code class="code">"normal"</code>}<a class="copiable-link" href="#index-figure-windowstyle"> ¶</a></span></dt>
<dd><p>The window style of a figure. One of the following values:
</p><dl class="table">
<dt><code class="code">normal</code></dt>
<dd><p>The window may be unselected and other windows may be shown in front of the window.
</p></dd>
<dt><code class="code">modal</code></dt>
<dd><p>The window will stay on top of all normal figures until it is dismissed.
</p></dd>
<dt><code class="code">docked</code></dt>
<dd><p>Unimplemented.
</p></dd>
</dl>
<p>Changing modes of a visible figure may cause the figure to close and reopen.
</p>
</dd>
</dl>
<a class="anchor" id="XREFfigurecategoryKeyboardInteraction"></a><h4 class="subsubheading" id="Keyboard-Interaction"><span>Keyboard Interaction<a class="copiable-link" href="#Keyboard-Interaction"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFfigurekeypressfcn"></a></dd>
<dt><a id="index-figure-keypressfcn"></a><span><code class="code">keypressfcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-figure-keypressfcn"> ¶</a></span></dt>
<dd><p>Callback function executed when a keystroke event happens while the figure has focus. The actual key that was pressed can be retrieved using the second argument ’evt’ of the function.
</p>
<p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFfigurekeyreleasefcn"></a></dd>
<dt><a id="index-figure-keyreleasefcn"></a><span><code class="code">keyreleasefcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-figure-keyreleasefcn"> ¶</a></span></dt>
<dd><p>With <code class="code">keypressfcn</code>, the keyboard callback functions. These callback functions are called when a key is pressed/released respectively. The functions are called with two input arguments. The first argument holds the handle of the calling figure. The second argument holds an event structure which has the following members:
</p><dl class="table">
<dt><code class="code">Character:</code></dt>
<dd><p>The ASCII value of the key
</p></dd>
<dt><code class="code">Key:</code></dt>
<dd><p>Lowercase value of the key
</p></dd>
<dt><code class="code">Modifier:</code></dt>
<dd><p>A cell array containing strings representing the modifiers pressed with the key.
</p></dd>
</dl>
<p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFfigurewindowkeypressfcn"></a></dd>
<dt><a id="index-figure-windowkeypressfcn"></a><span><code class="code">windowkeypressfcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-figure-windowkeypressfcn"> ¶</a></span></dt>
<dd><p>Function that is executed when a key is pressed and the figure has focus.
</p>
<p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFfigurewindowkeyreleasefcn"></a></dd>
<dt><a id="index-figure-windowkeyreleasefcn"></a><span><code class="code">windowkeyreleasefcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-figure-windowkeyreleasefcn"> ¶</a></span></dt>
<dd><p>Function that is executed when a key is released and the figure has focus.
</p>
<p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
</dd>
</dl>
<a class="anchor" id="XREFfigurecategoryMouseInteraction"></a><h4 class="subsubheading" id="Mouse-Interaction-1"><span>Mouse Interaction<a class="copiable-link" href="#Mouse-Interaction-1"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFfigurebuttondownfcn"></a></dd>
<dt><a id="index-figure-buttondownfcn"></a><span><code class="code">buttondownfcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-figure-buttondownfcn"> ¶</a></span></dt>
<dd><p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFfigurecontextmenu"></a></dd>
<dt><a id="index-figure-contextmenu"></a><span><code class="code">contextmenu</code>: graphics handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-figure-contextmenu"> ¶</a></span></dt>
<dd><p>Graphics handle of the uicontextmenu object that is currently associated to this figure object.
</p>
<a class="anchor" id="XREFfigurecurrentpoint"></a></dd>
<dt><a id="index-figure-currentpoint"></a><span><code class="code">currentpoint</code> (read-only): two-element vector, def. <code class="code">[0; 0]</code><a class="copiable-link" href="#index-figure-currentpoint"> ¶</a></span></dt>
<dd><p>A 1-by-2 vector which holds the coordinates of the point over which the mouse pointer was when a mouse event occurred. The X and Y coordinates are in units defined by the figure’s <code class="code">units</code> property and their origin is the lower left corner of the plotting area.
</p>
<p>Events which set <code class="code">currentpoint</code> are
</p><dl class="table">
<dt>A mouse button was pressed</dt>
<dd><p>always
</p></dd>
<dt>A mouse button was released</dt>
<dd><p>only if the figure’s callback <code class="code">windowbuttonupfcn</code> is defined
</p></dd>
<dt>The pointer was moved while pressing the mouse button (drag)</dt>
<dd><p>only if the figure’s callback <code class="code">windowbuttonmotionfcn</code> is defined
</p></dd>
</dl>
<a class="anchor" id="XREFfigurehittest"></a></dd>
<dt><a id="index-figure-hittest"></a><span><code class="code">hittest</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-figure-hittest"> ¶</a></span></dt>
<dd><p>Specify whether figure processes mouse events or passes them to ancestors of the object. When enabled, the object may respond to mouse clicks by evaluating the <code class="code">"buttondownfcn"</code>, showing the uicontextmenu, and eventually becoming the root <code class="code">"currentobject"</code>. This property is only relevant when the object can accept mouse clicks which is determined by the <code class="code">"pickableparts"</code> property. See <a class="xref" href="#XREFfigurepickableparts">pickableparts property<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFfiguremenubar"></a></dd>
<dt><a id="index-figure-menubar"></a><span><code class="code">menubar</code>: {<code class="code">"figure"</code>} | <code class="code">"none"</code><a class="copiable-link" href="#index-figure-menubar"> ¶</a></span></dt>
<dd><p>Control the display of the figure menu bar at the top of the figure.
</p>
<a class="anchor" id="XREFfigurepointer"></a></dd>
<dt><a id="index-figure-pointer"></a><span><code class="code">pointer</code>: {<code class="code">"arrow"</code>} | <code class="code">"botl"</code> | <code class="code">"botr"</code> | <code class="code">"bottom"</code> | <code class="code">"circle"</code> | <code class="code">"cross"</code> | <code class="code">"crosshair"</code> | <code class="code">"custom"</code> | <code class="code">"fleur"</code> | <code class="code">"hand"</code> | <code class="code">"ibeam"</code> | <code class="code">"left"</code> | <code class="code">"right"</code> | <code class="code">"top"</code> | <code class="code">"topl"</code> | <code class="code">"topr"</code> | <code class="code">"watch"</code><a class="copiable-link" href="#index-figure-pointer"> ¶</a></span></dt>
<dd><p>Name of the mouse pointer shape associated with the canvas of the figure. When <code class="code">pointer</code> is <code class="code">"custom"</code>, the shape is determined by the <code class="code">pointershapecdata</code> property.
</p>
<p><code class="code">pointer</code> has no effect when the figure is in zoom, pan, or rotate mode. In this case, Octave automatically uses a pointer shape appropriate to the mode.
</p>
<a class="anchor" id="XREFfigurepointershapecdata"></a></dd>
<dt><a id="index-figure-pointershapecdata"></a><span><code class="code">pointershapecdata</code>: 16-by-16 or 32-by-32 Matrix, def. 16-by-16 double<a class="copiable-link" href="#index-figure-pointershapecdata"> ¶</a></span></dt>
<dd><p>m-by-m matrix defining a custom pointer. Each element defines a pixel with the element (1,1) representing the top-left pixel. A value of 1 is colored black, a value of 2 is colored white, and all other values are rendered as transparent.
</p>
<a class="anchor" id="XREFfigurepointershapehotspot"></a></dd>
<dt><a id="index-figure-pointershapehotspot"></a><span><code class="code">pointershapehotspot</code>: two-element vector, def. <code class="code">[1 1]</code><a class="copiable-link" href="#index-figure-pointershapehotspot"> ¶</a></span></dt>
<dd><p>For custom pointers only <code class="code">pointershapehotspot</code> defines the row and column of the pixel in <code class="code">pointershapecdata</code> that is used as the pointer location.
</p>
<a class="anchor" id="XREFfigureresize"></a></dd>
<dt><a id="index-figure-resize"></a><span><code class="code">resize</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-figure-resize"> ¶</a></span></dt>
<dd><p>Control whether the figure can be resized by dragging the window borders and corners using a mouse. When <code class="code">resize</code> is <code class="code">"off"</code> mouse interactions are disabled but the figure can still be resized by changing its <code class="code">"position"</code> property.
</p>
<a class="anchor" id="XREFfigureresizefcn"></a></dd>
<dt><a id="index-figure-resizefcn"></a><span><code class="code">resizefcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-figure-resizefcn"> ¶</a></span></dt>
<dd><p><code class="code">resizefcn</code> is deprecated. Use <code class="code">sizechangedfcn</code> instead.
</p>
<a class="anchor" id="XREFfigureselected"></a></dd>
<dt><a id="index-figure-selected"></a><span><code class="code">selected</code>: {<code class="code">"off"</code>} | <code class="code">"on"</code><a class="copiable-link" href="#index-figure-selected"> ¶</a></span></dt>
<dd><p>Property indicates whether this figure is selected.
</p>
<a class="anchor" id="XREFfigureselectionhighlight"></a></dd>
<dt><a id="index-figure-selectionhighlight"></a><span><code class="code">selectionhighlight</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-figure-selectionhighlight"> ¶</a></span></dt>
<dd><p>If <code class="code">selectionhighlight</code> is <code class="code">"on"</code>, then the figure’s selection state is visually highlighted.
</p>
<a class="anchor" id="XREFfigureselectiontype"></a></dd>
<dt><a id="index-figure-selectiontype"></a><span><code class="code">selectiontype</code>: <code class="code">"alt"</code> | <code class="code">"extend"</code> | {<code class="code">"normal"</code>} | <code class="code">"open"</code><a class="copiable-link" href="#index-figure-selectiontype"> ¶</a></span></dt>
<dd><p>Selection type of the latest mouse click.
</p>
<p><code class="code">selectiontype</code> may take different values depending on the combination of mouse button and keyboard modifier that were used:
</p><dl class="table">
<dt><code class="code">normal:</code></dt>
<dd><p>Left-click.
</p></dd>
<dt><code class="code">alt:</code></dt>
<dd><p>Right-click or Ctrl+Left-click.
</p></dd>
<dt><code class="code">extend:</code></dt>
<dd><p>Shift+Left-click, Middle click, or combined Left-click and Right-click.
</p></dd>
<dt><code class="code">open:</code></dt>
<dd><p>Double Left-click.
</p></dd>
</dl>
<a class="anchor" id="XREFfiguresizechangedfcn"></a></dd>
<dt><a id="index-figure-sizechangedfcn"></a><span><code class="code">sizechangedfcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-figure-sizechangedfcn"> ¶</a></span></dt>
<dd><p>Callback triggered when the figure window size is changed.
</p>
<p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFfiguretoolbar"></a></dd>
<dt><a id="index-figure-toolbar"></a><span><code class="code">toolbar</code>: {<code class="code">"auto"</code>} | <code class="code">"figure"</code> | <code class="code">"none"</code><a class="copiable-link" href="#index-figure-toolbar"> ¶</a></span></dt>
<dd><p>Control the display of the toolbar (along the bottom of the menubar) and the status bar. When set to <code class="code">"auto"</code>, the display is based on the value of the <a class="ref" href="#XREFfiguremenubar"><code class="code">"menubar"</code></a> property.
</p>
<a class="anchor" id="XREFfigurewindowbuttondownfcn"></a></dd>
<dt><a id="index-figure-windowbuttondownfcn"></a><span><code class="code">windowbuttondownfcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-figure-windowbuttondownfcn"> ¶</a></span></dt>
<dd><p>See <a class="xref" href="#XREFfigurewindowbuttonupfcn">windowbuttonupfcn property<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFfigurewindowbuttonmotionfcn"></a></dd>
<dt><a id="index-figure-windowbuttonmotionfcn"></a><span><code class="code">windowbuttonmotionfcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-figure-windowbuttonmotionfcn"> ¶</a></span></dt>
<dd><p>See <a class="xref" href="#XREFfigurewindowbuttonupfcn">windowbuttonupfcn property<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFfigurewindowbuttonupfcn"></a></dd>
<dt><a id="index-figure-windowbuttonupfcn"></a><span><code class="code">windowbuttonupfcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-figure-windowbuttonupfcn"> ¶</a></span></dt>
<dd><p>With <code class="code">windowbuttondownfcn</code> and <code class="code">windowbuttonmotionfcn</code>, the mouse callback functions. These callback functions are called when a mouse button is pressed, dragged, or released respectively. When these callback functions are executed, the <code class="code">currentpoint</code> property holds the current coordinates of the cursor.
</p>
<p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFfigurewindowscrollwheelfcn"></a></dd>
<dt><a id="index-figure-windowscrollwheelfcn"></a><span><code class="code">windowscrollwheelfcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-figure-windowscrollwheelfcn"> ¶</a></span></dt>
<dd><p>Function that is executed when a user manipulates the mouse wheel over this figure. The function is called with two input arguments. The first argument holds the handle of the calling figure. The second argument holds an event structure which has the following members:
</p><dl class="table">
<dt><code class="code">VerticalScrollCount:</code></dt>
<dd><p>The number of wheel steps, typically 1 when scrolling down and -1 when scrolling up.
</p></dd>
<dt><code class="code">VerticalScrollAmount:</code></dt>
<dd><p>The number of lines a wheel step should scroll. This value is always 3.
</p></dd>
<dt><code class="code">EventName:</code></dt>
<dd><p>The event name which is <code class="code">"WindowScrollWheel"</code>.
</p></dd>
</dl>
<p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
</dd>
</dl>
<a class="anchor" id="XREFfigurecategoryObjectIdentification"></a><h4 class="subsubheading" id="Object-Identification-1"><span>Object Identification<a class="copiable-link" href="#Object-Identification-1"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFfigurecurrentaxes"></a></dd>
<dt><a id="index-figure-currentaxes"></a><span><code class="code">currentaxes</code>: graphics handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-figure-currentaxes"> ¶</a></span></dt>
<dd><p>Handle to the graphics object of the current axes.
</p>
<a class="anchor" id="XREFfigurecurrentcharacter"></a></dd>
<dt><a id="index-figure-currentcharacter"></a><span><code class="code">currentcharacter</code> (read-only): def. <code class="code">""</code><a class="copiable-link" href="#index-figure-currentcharacter"> ¶</a></span></dt>
<dd><p>Tracking of the last key pressed is not yet implemented for figure objects. <code class="code">currentcharacter</code> is unused.
</p>
<a class="anchor" id="XREFfigurecurrentobject"></a></dd>
<dt><a id="index-figure-currentobject"></a><span><code class="code">currentobject</code> (read-only): graphics handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-figure-currentobject"> ¶</a></span></dt>
<dd><p>Handle to the most recently active graphics object in the figure.
</p>
<a class="anchor" id="XREFfigureintegerhandle"></a></dd>
<dt><a id="index-figure-integerhandle"></a><span><code class="code">integerhandle</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-figure-integerhandle"> ¶</a></span></dt>
<dd><p>Assign the next lowest unused integer as the Figure number.
</p>
<a class="anchor" id="XREFfigurenextplot"></a></dd>
<dt><a id="index-figure-nextplot"></a><span><code class="code">nextplot</code>: {<code class="code">"add"</code>} | <code class="code">"new"</code> | <code class="code">"replace"</code> | <code class="code">"replacechildren"</code><a class="copiable-link" href="#index-figure-nextplot"> ¶</a></span></dt>
<dd><p><code class="code">nextplot</code> is used by high level plotting functions to decide what to do with axes already present in the figure. See <a class="xref" href="Manipulation-of-Plot-Windows.html#XREFnewplot">newplot function<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFfigurenumber"></a></dd>
<dt><a id="index-figure-number"></a><span><code class="code">number</code> (read-only): double<a class="copiable-link" href="#index-figure-number"> ¶</a></span></dt>
<dd><p>Number of the current figure.
</p>
<a class="anchor" id="XREFfiguretag"></a></dd>
<dt><a id="index-figure-tag"></a><span><code class="code">tag</code>: string, def. <code class="code">""</code><a class="copiable-link" href="#index-figure-tag"> ¶</a></span></dt>
<dd><p>A user-defined string to label the graphics object.
</p>
<a class="anchor" id="XREFfiguretype"></a></dd>
<dt><a id="index-figure-type"></a><span><code class="code">type</code> (read-only): string<a class="copiable-link" href="#index-figure-type"> ¶</a></span></dt>
<dd><p>Class name of the graphics object. <code class="code">type</code> is always <code class="code">"figure"</code>.
</p>
<a class="anchor" id="XREFfigureuserdata"></a></dd>
<dt><a id="index-figure-userdata"></a><span><code class="code">userdata</code>: Any Octave data, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-figure-userdata"> ¶</a></span></dt>
<dd><p>User-defined data to associate with the graphics object.
</p>
</dd>
</dl>
<a class="anchor" id="XREFfigurecategoryObjectPosition"></a><h4 class="subsubheading" id="Object-Position"><span>Object Position<a class="copiable-link" href="#Object-Position"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFfiguredockcontrols"></a></dd>
<dt><a id="index-figure-dockcontrols"></a><span><code class="code">dockcontrols</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-figure-dockcontrols"> ¶</a></span></dt>
<dd><p>Interactive figure docking is not yet implemented for figure objects. <code class="code">dockcontrols</code> is unused.
</p>
<a class="anchor" id="XREFfigureinnerposition"></a></dd>
<dt><a id="index-figure-innerposition"></a><span><code class="code">innerposition</code>: four-element vector, def. <code class="code">[300 200 560 420]</code><a class="copiable-link" href="#index-figure-innerposition"> ¶</a></span></dt>
<dd><p>The <code class="code">"innerposition"</code> property is the same as the <a class="ref" href="#XREFfigureposition"><code class="code">"position"</code> property<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFfigureouterposition"></a></dd>
<dt><a id="index-figure-outerposition"></a><span><code class="code">outerposition</code>: four-element vector, def. <code class="code">[-1 -1 -1 -1]</code><a class="copiable-link" href="#index-figure-outerposition"> ¶</a></span></dt>
<dd><p>Specify the position and size of the figure including the top menubar and the bottom status bar. The four elements of the vector are the coordinates of the lower left corner and width and height of the figure. See <a class="xref" href="#XREFfigureunits">units property<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFfigureposition"></a></dd>
<dt><a id="index-figure-position"></a><span><code class="code">position</code>: four-element vector, def. <code class="code">[300 200 560 420]</code><a class="copiable-link" href="#index-figure-position"> ¶</a></span></dt>
<dd><p>Specify the position and size of the figure canvas. The four elements of the vector are the coordinates of the lower left corner and width and height of the figure. See <a class="xref" href="#XREFfigureunits">units property<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFfigureunits"></a></dd>
<dt><a id="index-figure-units"></a><span><code class="code">units</code>: <code class="code">"centimeters"</code> | <code class="code">"characters"</code> | <code class="code">"inches"</code> | <code class="code">"normalized"</code> | {<code class="code">"pixels"</code>} | <code class="code">"points"</code><a class="copiable-link" href="#index-figure-units"> ¶</a></span></dt>
<dd><p>The unit used to compute the <a class="ref" href="#XREFfigureposition">position</a> and <a class="ref" href="#XREFfigureouterposition">outerposition</a> properties.
</p>
</dd>
</dl>
<a class="anchor" id="XREFfigurecategoryParent_002fChildren"></a><h4 class="subsubheading" id="Parent_002fChildren-1"><span>Parent/Children<a class="copiable-link" href="#Parent_002fChildren-1"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFfigurechildren"></a></dd>
<dt><a id="index-figure-children"></a><span><code class="code">children</code> (read-only): vector of graphics handles, def. <code class="code">[](0x1)</code><a class="copiable-link" href="#index-figure-children"> ¶</a></span></dt>
<dd><p>Graphics handles of the figure’s children.
</p>
<a class="anchor" id="XREFfigurehandlevisibility"></a></dd>
<dt><a id="index-figure-handlevisibility"></a><span><code class="code">handlevisibility</code>: <code class="code">"callback"</code> | <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-figure-handlevisibility"> ¶</a></span></dt>
<dd><p>If <code class="code">handlevisibility</code> is <code class="code">"off"</code>, the figure’s handle is not visible in its parent’s <code class="code">"children"</code> property.
</p>
<a class="anchor" id="XREFfigureparent"></a></dd>
<dt><a id="index-figure-parent"></a><span><code class="code">parent</code>: graphics handle, def. <code class="code">0</code><a class="copiable-link" href="#index-figure-parent"> ¶</a></span></dt>
<dd><p>Handle of the parent graphics object.
</p>
</dd>
</dl>
<a class="anchor" id="XREFfigurecategoryPrinting_002fSaving"></a><h4 class="subsubheading" id="Printing_002fSaving"><span>Printing/Saving<a class="copiable-link" href="#Printing_002fSaving"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFfigurefilename"></a></dd>
<dt><a id="index-figure-filename"></a><span><code class="code">filename</code>: string, def. <code class="code">""</code><a class="copiable-link" href="#index-figure-filename"> ¶</a></span></dt>
<dd><p>The filename used when saving the plot figure.
</p>
<a class="anchor" id="XREFfigureinverthardcopy"></a></dd>
<dt><a id="index-figure-inverthardcopy"></a><span><code class="code">inverthardcopy</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-figure-inverthardcopy"> ¶</a></span></dt>
<dd><p>Replace the figure and axes background color with white when printing.
</p>
<a class="anchor" id="XREFfigurepaperorientation"></a></dd>
<dt><a id="index-figure-paperorientation"></a><span><code class="code">paperorientation</code>: <code class="code">"landscape"</code> | {<code class="code">"portrait"</code>}<a class="copiable-link" href="#index-figure-paperorientation"> ¶</a></span></dt>
<dd><p>The value for the <code class="code">papersize</code>, and <code class="code">paperposition</code> properties depends upon <code class="code">paperorientation</code>. The horizontal and vertical values for <code class="code">papersize</code> and <code class="code">paperposition</code> reverse order when <code class="code">paperorientation</code> is switched between <code class="code">"portrait"</code> and <code class="code">"landscape"</code>.
</p>
<a class="anchor" id="XREFfigurepaperposition"></a></dd>
<dt><a id="index-figure-paperposition"></a><span><code class="code">paperposition</code>: four-element vector, def. <code class="code">[1.3422 3.3191 5.8156 4.3617]</code><a class="copiable-link" href="#index-figure-paperposition"> ¶</a></span></dt>
<dd><p>Vector <code class="code">[left bottom width height]</code> defining the position and size of the figure (in <code class="code">paperunits</code> units) on the printed page. The position <code class="code">[left bottom]</code> defines the lower left corner of the figure on the page, and the size is defined by <code class="code">[width height]</code>. For output formats not implicitly rendered on paper, <code class="code">width</code> and <code class="code">height</code> define the size of the image and the position information is ignored. Setting <code class="code">paperposition</code> also forces the <code class="code">paperpositionmode</code> property to be set to <code class="code">"manual"</code>.
</p>
<a class="anchor" id="XREFfigurepaperpositionmode"></a></dd>
<dt><a id="index-figure-paperpositionmode"></a><span><code class="code">paperpositionmode</code>: {<code class="code">"auto"</code>} | <code class="code">"manual"</code><a class="copiable-link" href="#index-figure-paperpositionmode"> ¶</a></span></dt>
<dd><p>If <code class="code">paperpositionmode</code> is set to <code class="code">"auto"</code>, the <code class="code">paperposition</code> property is automatically computed: the printed figure will have the same size as the on-screen figure and will be centered on the output page. Setting the <code class="code">paperpositionmode</code> to <code class="code">"auto"</code> does not modify the value of the <code class="code">paperposition</code> property.
</p>
<a class="anchor" id="XREFfigurepapersize"></a></dd>
<dt><a id="index-figure-papersize"></a><span><code class="code">papersize</code>: two-element vector, def. <code class="code">[8.5000 11.0000]</code><a class="copiable-link" href="#index-figure-papersize"> ¶</a></span></dt>
<dd><p>Vector <code class="code">[width height]</code> defining the size of the paper for printing. Setting the <code class="code">papersize</code> property to a value, not associated with one of the defined <code class="code">papertypes</code> and consistent with the setting for <code class="code">paperorientation</code>, forces the <code class="code">papertype</code> property to the value <code class="code">"<custom>"</code>. If <code class="code">papersize</code> is set to a value associated with a supported <code class="code">papertype</code> and consistent with the <code class="code">paperorientation</code>, the <code class="code">papertype</code> value is modified to the associated value.
</p>
<a class="anchor" id="XREFfigurepapertype"></a></dd>
<dt><a id="index-figure-papertype"></a><span><code class="code">papertype</code>: <code class="code">"<custom>"</code> | <code class="code">"a"</code> | <code class="code">"a0"</code> | <code class="code">"a1"</code> | <code class="code">"a2"</code> | <code class="code">"a3"</code> | <code class="code">"a4"</code> | <code class="code">"a5"</code> | <code class="code">"arch-a"</code> | <code class="code">"arch-b"</code> | <code class="code">"arch-c"</code> | <code class="code">"arch-d"</code> | <code class="code">"arch-e"</code> | <code class="code">"b"</code> | <code class="code">"b0"</code> | <code class="code">"b1"</code> | <code class="code">"b2"</code> | <code class="code">"b3"</code> | <code class="code">"b4"</code> | <code class="code">"b5"</code> | <code class="code">"c"</code> | <code class="code">"d"</code> | <code class="code">"e"</code> | <code class="code">"tabloid"</code> | <code class="code">"uslegal"</code> | {<code class="code">"usletter"</code>}<a class="copiable-link" href="#index-figure-papertype"> ¶</a></span></dt>
<dd><p>Name of the paper used for printed output. Setting <code class="code">papertype</code> also changes <code class="code">papersize</code>, while maintaining consistency with the <code class="code">paperorientation</code> property.
</p>
<a class="anchor" id="XREFfigurepaperunits"></a></dd>
<dt><a id="index-figure-paperunits"></a><span><code class="code">paperunits</code>: <code class="code">"centimeters"</code> | {<code class="code">"inches"</code>} | <code class="code">"normalized"</code> | <code class="code">"points"</code><a class="copiable-link" href="#index-figure-paperunits"> ¶</a></span></dt>
<dd><p>The unit used to compute the <code class="code">paperposition</code> property. The conversion from physical units (e.g., <code class="code">"inches"</code>) is dependent on the <code class="code">screenpixelsperinch</code> property of the root object.
</p>
<a class="anchor" id="XREFfigurerenderer"></a></dd>
<dt><a id="index-figure-renderer"></a><span><code class="code">renderer</code>: {<code class="code">"opengl"</code>} | <code class="code">"painters"</code><a class="copiable-link" href="#index-figure-renderer"> ¶</a></span></dt>
<dd><p>Rendering engine used for printing when <code class="code">renderermode</code> is <code class="code">"manual"</code>. Setting <code class="code">renderer</code> also forces the <code class="code">renderermode</code> property to be set to <code class="code">"manual"</code>.
</p>
<a class="anchor" id="XREFfigurerenderermode"></a></dd>
<dt><a id="index-figure-renderermode"></a><span><code class="code">renderermode</code>: {<code class="code">"auto"</code>} | <code class="code">"manual"</code><a class="copiable-link" href="#index-figure-renderermode"> ¶</a></span></dt>
<dd><p>Control whether the rendering engine used for printing is chosen automatically or specified by the <code class="code">renderer</code> property. See <a class="xref" href="Printing-and-Saving-Plots.html#XREFprint">print function<!-- /@w --></a>.
</p>
</dd>
</dl>
<a class="anchor" id="XREFfigurecategoryUnused"></a><h4 class="subsubheading" id="Unused-1"><span>Unused<a class="copiable-link" href="#Unused-1"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFfigureclipping"></a></dd>
<dt><a id="index-figure-clipping"></a><span><code class="code">clipping</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-figure-clipping"> ¶</a></span></dt>
<dd><p><code class="code">clipping</code> is unused.
</p>
<a class="anchor" id="XREFfigurepickableparts"></a></dd>
<dt><a id="index-figure-pickableparts"></a><span><code class="code">pickableparts</code> (read-only): <code class="code">"all"</code> | <code class="code">"none"</code> | {<code class="code">"visible"</code>}<a class="copiable-link" href="#index-figure-pickableparts"> ¶</a></span></dt>
<dd><p><code class="code">pickableparts</code> is unused.
</p>
</dd>
</dl>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Axes-Properties.html">Axes Properties</a>, Previous: <a href="Root-Properties.html">Root Properties</a>, Up: <a href="Graphics-Object-Properties.html">Graphics Object Properties</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>
|
