/usr/share/doc/octave/octave.html/Figure-Properties.html is in octave-doc 4.2.2-1ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Figure Properties (GNU Octave)</title>
<meta name="description" content="Figure Properties (GNU Octave)">
<meta name="keywords" content="Figure Properties (GNU Octave)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Graphics-Object-Properties.html#Graphics-Object-Properties" rel="up" title="Graphics Object Properties">
<link href="Axes-Properties.html#Axes-Properties" rel="next" title="Axes Properties">
<link href="Root-Figure-Properties.html#Root-Figure-Properties" rel="prev" title="Root Figure Properties">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {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}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
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">
<a name="Figure-Properties"></a>
<div class="header">
<p>
Next: <a href="Axes-Properties.html#Axes-Properties" accesskey="n" rel="next">Axes Properties</a>, Previous: <a href="Root-Figure-Properties.html#Root-Figure-Properties" accesskey="p" rel="prev">Root Figure Properties</a>, Up: <a href="Graphics-Object-Properties.html#Graphics-Object-Properties" 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#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Figure-Properties-1"></a>
<h4 class="subsubsection">15.3.3.2 Figure Properties</h4>
<a name="index-figure-properties"></a>
<p>The <code>figure</code> properties are:
</p>
<dl compact="compact">
<dd>
<a name="XREFfigure_005f_005fmodified_005f_005f"></a><a name="index-figure-_005f_005fmodified_005f_005f"></a>
</dd>
<dt><code>__modified__</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd>
<a name="XREFfigurealphamap"></a><a name="index-figure-alphamap"></a>
</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>
<a name="XREFfigurebeingdeleted"></a><a name="index-figure-beingdeleted"></a>
</dd>
<dt><code>beingdeleted</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd>
<a name="XREFfigurebusyaction"></a><a name="index-figure-busyaction"></a>
</dd>
<dt><code>busyaction</code>: <code>"cancel"</code> | {<code>"queue"</code>}</dt>
<dd>
<a name="XREFfigurebuttondownfcn"></a><a name="index-figure-buttondownfcn"></a>
</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">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFfigurechildren"></a><a name="index-figure-children"></a>
</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>
<a name="XREFfigureclipping"></a><a name="index-figure-clipping"></a>
</dd>
<dt><code>clipping</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p><code>clipping</code> is unused.
</p>
<a name="XREFfigurecloserequestfcn"></a><a name="index-figure-closerequestfcn"></a>
</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">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFfigurecolor"></a><a name="index-figure-color"></a>
</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#Colors">colorspec</a>.
</p>
<a name="XREFfigurecolormap"></a><a name="index-figure-colormap"></a>
</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>
<a name="XREFfigurecreatefcn"></a><a name="index-figure-createfcn"></a>
</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 (0, "defaultfigurecreatefcn", 'disp ("figure created!")')</code>.
</p>
<p>For information on how to write graphics listener functions see <a href="Callbacks.html#Callbacks">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFfigurecurrentaxes"></a><a name="index-figure-currentaxes"></a>
</dd>
<dt><code>currentaxes</code>: graphics handle, def. <code>[](0x0)</code></dt>
<dd><p>Handle to the graphics object of the current axes.
</p>
<a name="XREFfigurecurrentcharacter"></a><a name="index-figure-currentcharacter"></a>
</dd>
<dt><code>currentcharacter</code> (read-only): def. <code>""</code></dt>
<dd><p><code>currentcharacter</code> is unused.
</p>
<a name="XREFfigurecurrentobject"></a><a name="index-figure-currentobject"></a>
</dd>
<dt><code>currentobject</code> (read-only): graphics handle, def. <code>[](0x0)</code></dt>
<dd>
<a name="XREFfigurecurrentpoint"></a><a name="index-figure-currentpoint"></a>
</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>
<a name="XREFfiguredeletefcn"></a><a name="index-figure-deletefcn"></a>
</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">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFfiguredockcontrols"></a><a name="index-figure-dockcontrols"></a>
</dd>
<dt><code>dockcontrols</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd><p><code>dockcontrols</code> is unused.
</p>
<a name="XREFfigurefilename"></a><a name="index-figure-filename"></a>
</dd>
<dt><code>filename</code>: string, def. <code>""</code></dt>
<dd><p>The filename used when saving the plot figure.
</p>
<a name="XREFfiguregraphicssmoothing"></a><a name="index-figure-graphicssmoothing"></a>
</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>
<a name="XREFfigurehandlevisibility"></a><a name="index-figure-handlevisibility"></a>
</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>
<a name="XREFfigurehittest"></a><a name="index-figure-hittest"></a>
</dd>
<dt><code>hittest</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd>
<a name="XREFfigureintegerhandle"></a><a name="index-figure-integerhandle"></a>
</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>
<a name="XREFfigureinterruptible"></a><a name="index-figure-interruptible"></a>
</dd>
<dt><code>interruptible</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd>
<a name="XREFfigureinverthardcopy"></a><a name="index-figure-inverthardcopy"></a>
</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>
<a name="XREFfigurekeypressfcn"></a><a name="index-figure-keypressfcn"></a>
</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">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFfigurekeyreleasefcn"></a><a name="index-figure-keyreleasefcn"></a>
</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">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFfiguremenubar"></a><a name="index-figure-menubar"></a>
</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>
<a name="XREFfigurename"></a><a name="index-figure-name"></a>
</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>
<a name="XREFfigurenextplot"></a><a name="index-figure-nextplot"></a>
</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>
<a name="XREFfigurenumbertitle"></a><a name="index-figure-numbertitle"></a>
</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>
<a name="XREFfigureouterposition"></a><a name="index-figure-outerposition"></a>
</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>
<a name="XREFfigurepaperorientation"></a><a name="index-figure-paperorientation"></a>
</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>
<a name="XREFfigurepaperposition"></a><a name="index-figure-paperposition"></a>
</dd>
<dt><code>paperposition</code>: four-element vector, def. <code>[0.25000 2.50000 8.00000 6.00000]</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>
<a name="XREFfigurepaperpositionmode"></a><a name="index-figure-paperpositionmode"></a>
</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>
<a name="XREFfigurepapersize"></a><a name="index-figure-papersize"></a>
</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>
<a name="XREFfigurepapertype"></a><a name="index-figure-papertype"></a>
</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>
<a name="XREFfigurepaperunits"></a><a name="index-figure-paperunits"></a>
</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. For <code>paperunits</code> set to <code>"pixels"</code>, the conversion between physical units (ex: <code>"inches"</code>) and <code>"pixels"</code> is dependent on the <code>screenpixelsperinch</code> property of the root object.
</p>
<a name="XREFfigureparent"></a><a name="index-figure-parent"></a>
</dd>
<dt><code>parent</code>: graphics handle, def. <code>0</code></dt>
<dd><p>Handle of the parent graphics object.
</p>
<a name="XREFfigurepointer"></a><a name="index-figure-pointer"></a>
</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>"fullcrosshair"</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><code>pointer</code> is unused.
</p>
<a name="XREFfigurepointershapecdata"></a><a name="index-figure-pointershapecdata"></a>
</dd>
<dt><code>pointershapecdata</code>: def. 16-by-16 double</dt>
<dd><p><code>pointershapecdata</code> is unused.
</p>
<a name="XREFfigurepointershapehotspot"></a><a name="index-figure-pointershapehotspot"></a>
</dd>
<dt><code>pointershapehotspot</code>: def. <code>[0 0]</code></dt>
<dd><p><code>pointershapehotspot</code> is unused.
</p>
<a name="XREFfigureposition"></a><a name="index-figure-position"></a>
</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>
<a name="XREFfigurerenderer"></a><a name="index-figure-renderer"></a>
</dd>
<dt><code>renderer</code>: {<code>"opengl"</code>} | <code>"painters"</code></dt>
<dd><p><code>renderer</code> is unused.
</p>
<a name="XREFfigurerenderermode"></a><a name="index-figure-renderermode"></a>
</dd>
<dt><code>renderermode</code>: {<code>"auto"</code>} | <code>"manual"</code></dt>
<dd><p><code>renderermode</code> is unused.
</p>
<a name="XREFfigureresize"></a><a name="index-figure-resize"></a>
</dd>
<dt><code>resize</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p><code>resize</code> is unused.
</p>
<a name="XREFfigureresizefcn"></a><a name="index-figure-resizefcn"></a>
</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>
<a name="XREFfigureselected"></a><a name="index-figure-selected"></a>
</dd>
<dt><code>selected</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd>
<a name="XREFfigureselectionhighlight"></a><a name="index-figure-selectionhighlight"></a>
</dd>
<dt><code>selectionhighlight</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd>
<a name="XREFfigureselectiontype"></a><a name="index-figure-selectiontype"></a>
</dd>
<dt><code>selectiontype</code>: <code>"alt"</code> | <code>"extend"</code> | {<code>"normal"</code>} | <code>"open"</code></dt>
<dd>
<a name="XREFfiguresizechangedfcn"></a><a name="index-figure-sizechangedfcn"></a>
</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">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFfiguretag"></a><a name="index-figure-tag"></a>
</dd>
<dt><code>tag</code>: string, def. <code>""</code></dt>
<dd><p>A user-defined string to label the graphics object.
</p>
<a name="XREFfiguretoolbar"></a><a name="index-figure-toolbar"></a>
</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>
<a name="XREFfiguretype"></a><a name="index-figure-type"></a>
</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>
<a name="XREFfigureuicontextmenu"></a><a name="index-figure-uicontextmenu"></a>
</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>
<a name="XREFfigureunits"></a><a name="index-figure-units"></a>
</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>
<a name="XREFfigureuserdata"></a><a name="index-figure-userdata"></a>
</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>
<a name="XREFfigurevisible"></a><a name="index-figure-visible"></a>
</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>
<a name="XREFfigurewindowbuttondownfcn"></a><a name="index-figure-windowbuttondownfcn"></a>
</dd>
<dt><code>windowbuttondownfcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>See <a href="#XREFfigurewindowbuttonupfcn">windowbuttonupfcn property<!-- /@w --></a>.
</p>
<a name="XREFfigurewindowbuttonmotionfcn"></a><a name="index-figure-windowbuttonmotionfcn"></a>
</dd>
<dt><code>windowbuttonmotionfcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>See <a href="#XREFfigurewindowbuttonupfcn">windowbuttonupfcn property<!-- /@w --></a>.
</p>
<a name="XREFfigurewindowbuttonupfcn"></a><a name="index-figure-windowbuttonupfcn"></a>
</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">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFfigurewindowkeypressfcn"></a><a name="index-figure-windowkeypressfcn"></a>
</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">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFfigurewindowkeyreleasefcn"></a><a name="index-figure-windowkeyreleasefcn"></a>
</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">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFfigurewindowscrollwheelfcn"></a><a name="index-figure-windowscrollwheelfcn"></a>
</dd>
<dt><code>windowscrollwheelfcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p><code>windowscrollwheelfcn</code> is unused.
</p>
<a name="XREFfigurewindowstyle"></a><a name="index-figure-windowstyle"></a>
</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#Axes-Properties" accesskey="n" rel="next">Axes Properties</a>, Previous: <a href="Root-Figure-Properties.html#Root-Figure-Properties" accesskey="p" rel="prev">Root Figure Properties</a>, Up: <a href="Graphics-Object-Properties.html#Graphics-Object-Properties" 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#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|