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
|
<!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>Figure Properties (GNU Octave (version 6.2.0))</title>
<meta name="description" content="Figure Properties (GNU Octave (version 6.2.0))">
<meta name="keywords" content="Figure 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="Axes-Properties.html" rel="next" title="Axes Properties">
<link href="Root-Properties.html" rel="prev" title="Root 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="Figure-Properties"></span><div class="header">
<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>
<span id="Figure-Properties-1"></span><h4 class="subsubsection">15.3.3.2 Figure Properties</h4>
<span id="index--Figure-PropertiesFigure-Properties"></span>
<p>Properties of <code>figure</code> objects (see <a href="Multiple-Plot-Windows.html#XREFfigure">figure</a>):
</p>
<dl compact="compact">
<dd>
<span id="XREFfigurealphamap"></span><span id="index-figure-alphamap"></span>
</dd>
<dt><code>alphamap</code>: def. 64-by-1 double</dt>
<dd><p>Transparency is not yet implemented for figure objects. <code>alphamap</code> is unused.
</p>
<span id="XREFfigurebeingdeleted"></span><span id="index-figure-beingdeleted"></span>
</dd>
<dt><code>beingdeleted</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd>
<span id="XREFfigurebusyaction"></span><span id="index-figure-busyaction"></span>
</dd>
<dt><code>busyaction</code>: <code>"cancel"</code> | {<code>"queue"</code>}</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>interruptible</code> property set to <code>"off"</code>. The <code>busyaction</code> property of the interrupting callback object indicates whether the interrupting callback is queued (<code>"queue"</code> (default)) or discarded (<code>"cancel"</code>).
See <a href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFfigurebuttondownfcn"></span><span id="index-figure-buttondownfcn"></span>
</dd>
<dt><code>buttondownfcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>For information on how to write graphics listener functions see <a href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFfigurechildren"></span><span id="index-figure-children"></span>
</dd>
<dt><code>children</code> (read-only): vector of graphics handles, def. <code>[](0x1)</code></dt>
<dd><p>Graphics handles of the figure’s children.
</p>
<span id="XREFfigureclipping"></span><span id="index-figure-clipping"></span>
</dd>
<dt><code>clipping</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p><code>clipping</code> is unused.
</p>
<span id="XREFfigurecloserequestfcn"></span><span id="index-figure-closerequestfcn"></span>
</dd>
<dt><code>closerequestfcn</code>: string | function handle, def. <code>"closereq"</code></dt>
<dd><p>Function that is executed when a figure is deleted. See <a href="Manipulation-of-Plot-Windows.html#XREFclosereq">closereq function</a>.
</p>
<p>For information on how to write graphics listener functions see <a href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFfigurecolor"></span><span id="index-figure-color"></span>
</dd>
<dt><code>color</code>: colorspec, def. <code>[1 1 1]</code></dt>
<dd><p>Color of the figure background. See <a href="Colors.html">colorspec</a>.
</p>
<span id="XREFfigurecolormap"></span><span id="index-figure-colormap"></span>
</dd>
<dt><code>colormap</code>: N-by-3 matrix, def. 64-by-3 double</dt>
<dd><p>A matrix containing the RGB color map for the current axes.
</p>
<span id="XREFfigurecreatefcn"></span><span id="index-figure-createfcn"></span>
</dd>
<dt><code>createfcn</code>: string | function handle, def. <code>[](0x0)</code></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>set (groot, "defaultfigurecreatefcn", 'disp ("figure created!")')</code>.
</p>
<p>For information on how to write graphics listener functions see <a href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFfigurecurrentaxes"></span><span id="index-figure-currentaxes"></span>
</dd>
<dt><code>currentaxes</code>: graphics handle, def. <code>[](0x0)</code></dt>
<dd><p>Handle to the graphics object of the current axes.
</p>
<span id="XREFfigurecurrentcharacter"></span><span id="index-figure-currentcharacter"></span>
</dd>
<dt><code>currentcharacter</code> (read-only): def. <code>""</code></dt>
<dd><p><code>currentcharacter</code> is unused.
</p>
<span id="XREFfigurecurrentobject"></span><span id="index-figure-currentobject"></span>
</dd>
<dt><code>currentobject</code> (read-only): graphics handle, def. <code>[](0x0)</code></dt>
<dd>
<span id="XREFfigurecurrentpoint"></span><span id="index-figure-currentpoint"></span>
</dd>
<dt><code>currentpoint</code> (read-only): two-element vector, def. <code>[0; 0]</code></dt>
<dd><p>A 1-by-2 matrix 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>units</code> property and their origin is the lower left corner of the plotting area.
</p>
<p>Events which set <code>currentpoint</code> are
</p><dl compact="compact">
<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>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>windowbuttonmotionfcn</code> is defined
</p></dd>
</dl>
<span id="XREFfiguredeletefcn"></span><span id="index-figure-deletefcn-1"></span>
</dd>
<dt><code>deletefcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>Callback function executed immediately before figure is deleted.
</p>
<p>For information on how to write graphics listener functions see <a href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFfiguredockcontrols"></span><span id="index-figure-dockcontrols"></span>
</dd>
<dt><code>dockcontrols</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd><p><code>dockcontrols</code> is unused.
</p>
<span id="XREFfigurefilename"></span><span id="index-figure-filename"></span>
</dd>
<dt><code>filename</code>: string, def. <code>""</code></dt>
<dd><p>The filename used when saving the plot figure.
</p>
<span id="XREFfiguregraphicssmoothing"></span><span id="index-figure-graphicssmoothing"></span>
</dd>
<dt><code>graphicssmoothing</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>Use smoothing techniques to reduce the appearance of jagged lines.
</p>
<span id="XREFfigurehandlevisibility"></span><span id="index-figure-handlevisibility"></span>
</dd>
<dt><code>handlevisibility</code>: <code>"callback"</code> | <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>If <code>handlevisibility</code> is <code>"off"</code>, the figure’s handle is not visible in its parent’s "children" property.
</p>
<span id="XREFfigurehittest"></span><span id="index-figure-hittest"></span>
</dd>
<dt><code>hittest</code>: <code>"off"</code> | {<code>"on"</code>}</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>"buttondownfcn"</code>, showing the uicontextmenu, and eventually becoming the root <code>"currentobject"</code>. This property is only relevant when the object can accept mouse clicks which is determined by the <code>"pickableparts"</code> property. See <a href="#XREFfigurepickableparts">pickableparts property<!-- /@w --></a>.
</p>
<span id="XREFfigureintegerhandle"></span><span id="index-figure-integerhandle"></span>
</dd>
<dt><code>integerhandle</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>Assign the next lowest unused integer as the Figure number.
</p>
<span id="XREFfigureinterruptible"></span><span id="index-figure-interruptible"></span>
</dd>
<dt><code>interruptible</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>Specify whether this object’s callback functions may be interrupted by other callbacks. By default <code>interruptible</code> is <code>"on"</code> and callbacks that make use of <code>drawnow</code>, <code>figure</code>, <code>waitfor</code>, <code>getframe</code> or <code>pause</code> functions are eventually interrupted.
See <a href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFfigureinverthardcopy"></span><span id="index-figure-inverthardcopy"></span>
</dd>
<dt><code>inverthardcopy</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>Replace the figure and axes background color with white when printing.
</p>
<span id="XREFfigurekeypressfcn"></span><span id="index-figure-keypressfcn"></span>
</dd>
<dt><code>keypressfcn</code>: string | function handle, def. <code>[](0x0)</code></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. For information on how to write graphics listener functions see <a href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFfigurekeyreleasefcn"></span><span id="index-figure-keyreleasefcn"></span>
</dd>
<dt><code>keyreleasefcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>With <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 compact="compact">
<dt><code>Character:</code></dt>
<dd><p>The ASCII value of the key
</p></dd>
<dt><code>Key:</code></dt>
<dd><p>Lowercase value of the key
</p></dd>
<dt><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 href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFfiguremenubar"></span><span id="index-figure-menubar"></span>
</dd>
<dt><code>menubar</code>: {<code>"figure"</code>} | <code>"none"</code></dt>
<dd><p>Control the display of the figure menu bar at the top of the figure.
</p>
<span id="XREFfigurename"></span><span id="index-figure-name"></span>
</dd>
<dt><code>name</code>: string, def. <code>""</code></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>numbertitle</code> property.
</p>
<span id="XREFfigurenextplot"></span><span id="index-figure-nextplot"></span>
</dd>
<dt><code>nextplot</code>: {<code>"add"</code>} | <code>"new"</code> | <code>"replace"</code> | <code>"replacechildren"</code></dt>
<dd><p><code>nextplot</code> is used by high level plotting functions to decide what to do with axes already present in the figure. See <a href="Manipulation-of-Plot-Windows.html#XREFnewplot">newplot function<!-- /@w --></a>.
</p>
<span id="XREFfigurenumber"></span><span id="index-figure-number"></span>
</dd>
<dt><code>number</code> (read-only):</dt>
<dd>
<span id="XREFfigurenumbertitle"></span><span id="index-figure-numbertitle"></span>
</dd>
<dt><code>numbertitle</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>Display "Figure" followed by the numerical figure handle value in the figure title bar.
</p>
<span id="XREFfigureouterposition"></span><span id="index-figure-outerposition"></span>
</dd>
<dt><code>outerposition</code>: four-element vector, def. <code>[-1 -1 -1 -1]</code></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 href="#XREFfigureunits">units property<!-- /@w --></a>.
</p>
<span id="XREFfigurepaperorientation"></span><span id="index-figure-paperorientation"></span>
</dd>
<dt><code>paperorientation</code>: <code>"landscape"</code> | {<code>"portrait"</code>}</dt>
<dd><p>The value for the <code>papersize</code>, and <code>paperposition</code> properties depends upon <code>paperorientation</code>. The horizontal and vertical values for <code>papersize</code> and <code>paperposition</code> reverse order when <code>paperorientation</code> is switched between <code>"portrait"</code> and <code>"landscape"</code>.
</p>
<span id="XREFfigurepaperposition"></span><span id="index-figure-paperposition"></span>
</dd>
<dt><code>paperposition</code>: four-element vector, def. <code>[1.3422 3.3191 5.8156 4.3617]</code></dt>
<dd><p>Vector <code>[left bottom width height]</code> defining the position and size of the figure (in <code>paperunits</code> units) on the printed page. The position <code>[left bottom]</code> defines the lower left corner of the figure on the page, and the size is defined by <code>[width height]</code>. For output formats not implicitly rendered on paper, <code>width</code> and <code>height</code> define the size of the image and the position information is ignored. Setting <code>paperposition</code> also forces the <code>paperpositionmode</code> property to be set to <code>"manual"</code>.
</p>
<span id="XREFfigurepaperpositionmode"></span><span id="index-figure-paperpositionmode"></span>
</dd>
<dt><code>paperpositionmode</code>: {<code>"auto"</code>} | <code>"manual"</code></dt>
<dd><p>If <code>paperpositionmode</code> is set to <code>"auto"</code>, the <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>paperpositionmode</code> to <code>"auto"</code> does not modify the value of the <code>paperposition</code> property.
</p>
<span id="XREFfigurepapersize"></span><span id="index-figure-papersize"></span>
</dd>
<dt><code>papersize</code>: two-element vector, def. <code>[8.5000 11.0000]</code></dt>
<dd><p>Vector <code>[width height]</code> defining the size of the paper for printing. Setting the <code>papersize</code> property to a value, not associated with one of the defined <code>papertypes</code> and consistent with the setting for <code>paperorientation</code>, forces the <code>papertype</code> property to the value <code>"<custom>"</code>. If <code>papersize</code> is set to a value associated with a supported <code>papertype</code> and consistent with the <code>paperorientation</code>, the <code>papertype</code> value is modified to the associated value.
</p>
<span id="XREFfigurepapertype"></span><span id="index-figure-papertype"></span>
</dd>
<dt><code>papertype</code>: <code>"<custom>"</code> | <code>"a"</code> | <code>"a0"</code> | <code>"a1"</code> | <code>"a2"</code> | <code>"a3"</code> | <code>"a4"</code> | <code>"a5"</code> | <code>"arch-a"</code> | <code>"arch-b"</code> | <code>"arch-c"</code> | <code>"arch-d"</code> | <code>"arch-e"</code> | <code>"b"</code> | <code>"b0"</code> | <code>"b1"</code> | <code>"b2"</code> | <code>"b3"</code> | <code>"b4"</code> | <code>"b5"</code> | <code>"c"</code> | <code>"d"</code> | <code>"e"</code> | <code>"tabloid"</code> | <code>"uslegal"</code> | {<code>"usletter"</code>}</dt>
<dd><p>Name of the paper used for printed output. Setting <code>papertype</code> also changes <code>papersize</code>, while maintaining consistency with the <code>paperorientation</code> property.
</p>
<span id="XREFfigurepaperunits"></span><span id="index-figure-paperunits"></span>
</dd>
<dt><code>paperunits</code>: <code>"centimeters"</code> | {<code>"inches"</code>} | <code>"normalized"</code> | <code>"points"</code></dt>
<dd><p>The unit used to compute the <code>paperposition</code> property. The conversion from physical units (e.g., <code>"inches"</code>) is dependent on the <code>screenpixelsperinch</code> property of the root object.
</p>
<span id="XREFfigureparent"></span><span id="index-figure-parent"></span>
</dd>
<dt><code>parent</code>: graphics handle, def. <code>0</code></dt>
<dd><p>Handle of the parent graphics object.
</p>
<span id="XREFfigurepickableparts"></span><span id="index-figure-pickableparts"></span>
</dd>
<dt><code>pickableparts</code> (read-only): <code>"all"</code> | <code>"none"</code> | {<code>"visible"</code>}</dt>
<dd><p><code>pickableparts</code> is unused.
</p>
<span id="XREFfigurepointer"></span><span id="index-figure-pointer"></span>
</dd>
<dt><code>pointer</code>: {<code>"arrow"</code>} | <code>"botl"</code> | <code>"botr"</code> | <code>"bottom"</code> | <code>"circle"</code> | <code>"cross"</code> | <code>"crosshair"</code> | <code>"custom"</code> | <code>"fleur"</code> | <code>"hand"</code> | <code>"ibeam"</code> | <code>"left"</code> | <code>"right"</code> | <code>"top"</code> | <code>"topl"</code> | <code>"topr"</code> | <code>"watch"</code></dt>
<dd><p>Name of the mouse pointer shape associated with the canvas of the figure. When <code>pointer</code> is "custom", the shape is determined by the <code>pointershapecdata</code> property.
</p>
<p><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>
<span id="XREFfigurepointershapecdata"></span><span id="index-figure-pointershapecdata"></span>
</dd>
<dt><code>pointershapecdata</code>: 16-by-16 or 32-by-32 Matrix, def. 16-by-16 double</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>
<span id="XREFfigurepointershapehotspot"></span><span id="index-figure-pointershapehotspot"></span>
</dd>
<dt><code>pointershapehotspot</code>: two-element vector, def. <code>[1 1]</code></dt>
<dd><p>For custom pointers only <code>pointershapehotspot</code> defines the row and column of the pixel in <code>pointershapecdata</code> that is used as the pointer location.
</p>
<span id="XREFfigureposition"></span><span id="index-figure-position"></span>
</dd>
<dt><code>position</code>: four-element vector, def. <code>[300 200 560 420]</code></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 href="#XREFfigureunits">units property<!-- /@w --></a>.
</p>
<span id="XREFfigurerenderer"></span><span id="index-figure-renderer"></span>
</dd>
<dt><code>renderer</code>: {<code>"opengl"</code>} | <code>"painters"</code></dt>
<dd><p>Rendering engine used for printing when <code>renderermode</code> is "manual". Setting <code>renderer</code> also forces the <code>renderermode</code> property to be set to <code>"manual"</code>.
</p>
<span id="XREFfigurerenderermode"></span><span id="index-figure-renderermode"></span>
</dd>
<dt><code>renderermode</code>: {<code>"auto"</code>} | <code>"manual"</code></dt>
<dd><p>Control whether the rendering engine used for printing is chosen automatically or specified by the <code>renderer</code> property. See <a href="Printing-and-Saving-Plots.html#XREFprint">print function<!-- /@w --></a>.
</p>
<span id="XREFfigureresize"></span><span id="index-figure-resize"></span>
</dd>
<dt><code>resize</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>Control whether the figure can be resized by dragging the window borders and corners using a mouse. When <code>resize</code> is <code>"off"</code> mouse interactions are disabled but the figure can still be resized by changing its <code>"position"</code> property.
</p>
<span id="XREFfigureresizefcn"></span><span id="index-figure-resizefcn"></span>
</dd>
<dt><code>resizefcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p><code>resizefcn</code> is deprecated. Use <code>sizechangedfcn</code> instead.
</p>
<span id="XREFfigureselected"></span><span id="index-figure-selected"></span>
</dd>
<dt><code>selected</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd>
<span id="XREFfigureselectionhighlight"></span><span id="index-figure-selectionhighlight"></span>
</dd>
<dt><code>selectionhighlight</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd>
<span id="XREFfigureselectiontype"></span><span id="index-figure-selectiontype"></span>
</dd>
<dt><code>selectiontype</code>: <code>"alt"</code> | <code>"extend"</code> | {<code>"normal"</code>} | <code>"open"</code></dt>
<dd><p>Selection type of the latest mouse click.
</p>
<p><code>selectiontype</code> may take different values depending on the combination of mouse button and keyboard modifier that were used:
</p><dl compact="compact">
<dt><code>normal:</code></dt>
<dd><p>Left-click.
</p></dd>
<dt><code>alt:</code></dt>
<dd><p>Right-click or Ctrl+Left-click.
</p></dd>
<dt><code>extend:</code></dt>
<dd><p>Shitf+Left-click, Middle click, or combined Left-click and Right-click.
</p></dd>
<dt><code>open:</code></dt>
<dd><p>Double Left-click.
</p></dd>
</dl>
<span id="XREFfiguresizechangedfcn"></span><span id="index-figure-sizechangedfcn"></span>
</dd>
<dt><code>sizechangedfcn</code>: string | function handle, def. <code>[](0x0)</code></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 href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFfiguretag"></span><span id="index-figure-tag"></span>
</dd>
<dt><code>tag</code>: string, def. <code>""</code></dt>
<dd><p>A user-defined string to label the graphics object.
</p>
<span id="XREFfiguretoolbar"></span><span id="index-figure-toolbar"></span>
</dd>
<dt><code>toolbar</code>: {<code>"auto"</code>} | <code>"figure"</code> | <code>"none"</code></dt>
<dd><p>Control the display of the toolbar (along the bottom of the menubar) and the status bar. When set to <code>"auto"</code>, the display is based on the value of the <code>menubar</code> property.
</p>
<span id="XREFfiguretype"></span><span id="index-figure-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>"figure"</code>
</p>
<span id="XREFfigureuicontextmenu"></span><span id="index-figure-uicontextmenu"></span>
</dd>
<dt><code>uicontextmenu</code>: graphics handle, def. <code>[](0x0)</code></dt>
<dd><p>Graphics handle of the uicontextmenu object that is currently associated to this figure object.
</p>
<span id="XREFfigureunits"></span><span id="index-figure-units"></span>
</dd>
<dt><code>units</code>: <code>"centimeters"</code> | <code>"characters"</code> | <code>"inches"</code> | <code>"normalized"</code> | {<code>"pixels"</code>} | <code>"points"</code></dt>
<dd><p>The unit used to compute the <code>position</code> and <code>outerposition</code> properties.
</p>
<span id="XREFfigureuserdata"></span><span id="index-figure-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="XREFfigurevisible"></span><span id="index-figure-visible"></span>
</dd>
<dt><code>visible</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>If <code>visible</code> is <code>"off"</code>, the figure is not rendered on screen.
</p>
<span id="XREFfigurewindowbuttondownfcn"></span><span id="index-figure-windowbuttondownfcn"></span>
</dd>
<dt><code>windowbuttondownfcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>See <a href="#XREFfigurewindowbuttonupfcn">windowbuttonupfcn property<!-- /@w --></a>.
</p>
<span id="XREFfigurewindowbuttonmotionfcn"></span><span id="index-figure-windowbuttonmotionfcn"></span>
</dd>
<dt><code>windowbuttonmotionfcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>See <a href="#XREFfigurewindowbuttonupfcn">windowbuttonupfcn property<!-- /@w --></a>.
</p>
<span id="XREFfigurewindowbuttonupfcn"></span><span id="index-figure-windowbuttonupfcn"></span>
</dd>
<dt><code>windowbuttonupfcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>With <code>windowbuttondownfcn</code> and <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>currentpoint</code> property holds the current coordinates of the cursor.
</p>
<p>For information on how to write graphics listener functions see <a href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFfigurewindowkeypressfcn"></span><span id="index-figure-windowkeypressfcn"></span>
</dd>
<dt><code>windowkeypressfcn</code>: string | function handle, def. <code>[](0x0)</code></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 href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFfigurewindowkeyreleasefcn"></span><span id="index-figure-windowkeyreleasefcn"></span>
</dd>
<dt><code>windowkeyreleasefcn</code>: string | function handle, def. <code>[](0x0)</code></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 href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFfigurewindowscrollwheelfcn"></span><span id="index-figure-windowscrollwheelfcn"></span>
</dd>
<dt><code>windowscrollwheelfcn</code>: string | function handle, def. <code>[](0x0)</code></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 compact="compact">
<dt><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>VerticalScrollAmount:</code></dt>
<dd><p>The number of lines a wheel step should scroll. This value is always 3.
</p></dd>
<dt><code>EventName:</code></dt>
<dd><p>The event name which is "WindowScrollWheel".
</p></dd>
</dl>
<p>For information on how to write graphics listener functions see <a href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFfigurewindowstyle"></span><span id="index-figure-windowstyle"></span>
</dd>
<dt><code>windowstyle</code>: <code>"docked"</code> | <code>"modal"</code> | {<code>"normal"</code>}</dt>
<dd><p>The window style of a figure. One of the following values:
</p><dl compact="compact">
<dt><code>normal</code></dt>
<dd><p>Set the window style as non modal.
</p></dd>
<dt><code>modal</code></dt>
<dd><p>Set the window as modal so that it will stay on top of all normal figures.
</p></dd>
<dt><code>docked</code></dt>
<dd><p>Setting the window style as docked currently does not dock the window.
</p></dd>
</dl>
<p>Changing modes of a visible figure may cause the figure to close and reopen.
</p>
</dd>
</dl>
<hr>
<div class="header">
<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>
</body>
</html>
|
