<!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>Image Properties (GNU Octave (version 5.1.0))</title>
<meta name="description" content="Image Properties (GNU Octave (version 5.1.0))">
<meta name="keywords" content="Image Properties (GNU Octave (version 5.1.0))">
<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="Patch-Properties.html#Patch-Properties" rel="next" title="Patch Properties">
<link href="Text-Properties.html#Text-Properties" rel="prev" title="Text 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="Image-Properties"></a>
<div class="header">
<p>
Next: <a href="Patch-Properties.html#Patch-Properties" accesskey="n" rel="next">Patch Properties</a>, Previous: <a href="Text-Properties.html#Text-Properties" accesskey="p" rel="prev">Text 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="Image-Properties-1"></a>
<h4 class="subsubsection">15.3.3.6 Image Properties</h4>
<a name="index--Image-PropertiesImage-Properties"></a>
<p>The <code>image</code> properties are:
</p>
<dl compact="compact">
<dd>
<a name="XREFimagealphadata"></a><a name="index-image-alphadata"></a>
</dd>
<dt><code>alphadata</code>: scalar | matrix, def. <code>1</code></dt>
<dd><p>Transparency is not yet implemented for image objects. <code>alphadata</code> is unused.
</p>
<a name="XREFimagealphadatamapping"></a><a name="index-image-alphadatamapping"></a>
</dd>
<dt><code>alphadatamapping</code>: <code>"direct"</code> | {<code>"none"</code>} | <code>"scaled"</code></dt>
<dd><p>Transparency is not yet implemented for image objects. <code>alphadatamapping</code> is unused.
</p>
<a name="XREFimagebeingdeleted"></a><a name="index-image-beingdeleted"></a>
</dd>
<dt><code>beingdeleted</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd>
<a name="XREFimagebusyaction"></a><a name="index-image-busyaction"></a>
</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">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFimagebuttondownfcn"></a><a name="index-image-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="XREFimagecdata"></a><a name="index-image-cdata"></a>
</dd>
<dt><code>cdata</code>: matrix, def. 64-by-64 double</dt>
<dd>
<a name="XREFimagecdatamapping"></a><a name="index-image-cdatamapping"></a>
</dd>
<dt><code>cdatamapping</code>: {<code>"direct"</code>} | <code>"scaled"</code></dt>
<dd>
<a name="XREFimagechildren"></a><a name="index-image-children"></a>
</dd>
<dt><code>children</code> (read-only): vector of graphics handles, def. <code>[](0x1)</code></dt>
<dd><p><code>children</code> is unused.
</p>
<a name="XREFimageclipping"></a><a name="index-image-clipping"></a>
</dd>
<dt><code>clipping</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>If <code>clipping</code> is <code>"on"</code>, the image is clipped in its parent axes limits.
</p>
<a name="XREFimagecreatefcn"></a><a name="index-image-createfcn"></a>
</dd>
<dt><code>createfcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>Callback function executed immediately after image has been created. Function is set by using default property on root object, e.g., <code>set (groot, "defaultimagecreatefcn", 'disp ("image 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="XREFimagedeletefcn"></a><a name="index-image-deletefcn"></a>
</dd>
<dt><code>deletefcn</code>: string | function handle, def. <code>[](0x0)</code></dt>
<dd><p>Callback function executed immediately before image 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="XREFimagehandlevisibility"></a><a name="index-image-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 image’s handle is not visible in its parent’s "children" property.
</p>
<a name="XREFimagehittest"></a><a name="index-image-hittest"></a>
</dd>
<dt><code>hittest</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd><p>Specify whether image 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="#XREFimagepickableparts">pickableparts property<!-- /@w --></a>.
</p>
<a name="XREFimageinterruptible"></a><a name="index-image-interruptible"></a>
</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">Callbacks section<!-- /@w --></a>.
</p>
<a name="XREFimageparent"></a><a name="index-image-parent"></a>
</dd>
<dt><code>parent</code>: graphics handle</dt>
<dd><p>Handle of the parent graphics object.
</p>
<a name="XREFimagepickableparts"></a><a name="index-image-pickableparts"></a>
</dd>
<dt><code>pickableparts</code>: <code>"all"</code> | <code>"none"</code> | {<code>"visible"</code>}</dt>
<dd><p>Specify whether image will accept mouse clicks. By default, <code>pickableparts</code> is <code>"visible"</code> and only visible parts of the image or its children may react to mouse clicks. When <code>pickableparts</code> is <code>"all"</code> both visible and invisible parts (or children) may react to mouse clicks. When <code>pickableparts</code> is <code>"none"</code> mouse clicks on the object are ignored and transmitted to any objects underneath this one. When an object is configured to accept mouse clicks the <code>"hittest"</code> property will determine how they are processed. See <a href="#XREFimagehittest">hittest property<!-- /@w --></a>.
</p>
<a name="XREFimageselected"></a><a name="index-image-selected"></a>
</dd>
<dt><code>selected</code>: {<code>"off"</code>} | <code>"on"</code></dt>
<dd>
<a name="XREFimageselectionhighlight"></a><a name="index-image-selectionhighlight"></a>
</dd>
<dt><code>selectionhighlight</code>: <code>"off"</code> | {<code>"on"</code>}</dt>
<dd>
<a name="XREFimagetag"></a><a name="index-image-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="XREFimagetype"></a><a name="index-image-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>"image"</code>
</p>
<a name="XREFimageuicontextmenu"></a><a name="index-image-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 image object.
</p>
<a name="XREFimageuserdata"></a><a name="index-image-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="XREFimagevisible"></a><a name="index-image-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 image is not rendered on screen.
</p>
<a name="XREFimagexdata"></a><a name="index-image-xdata"></a>
</dd>
<dt><code>xdata</code>: two-element vector, def. <code>[1 64]</code></dt>
<dd><p>Two-element vector <code>[xfirst xlast]</code> specifying the x coordinates of the centers of the first and last columns of the image.
</p>
<p>Setting <code>xdata</code> to the empty matrix ([]) will restore the default value of <code>[1 columns(image)]</code>.
</p>
<a name="XREFimageydata"></a><a name="index-image-ydata"></a>
</dd>
<dt><code>ydata</code>: two-element vector, def. <code>[1 64]</code></dt>
<dd><p>Two-element vector <code>[yfirst ylast]</code> specifying the y coordinates of the centers of the first and last rows of the image.
</p>
<p>Setting <code>ydata</code> to the empty matrix ([]) will restore the default value of <code>[1 rows(image)]</code>.
</p>
</dd>
</dl>
<hr>
<div class="header">
<p>
Next: <a href="Patch-Properties.html#Patch-Properties" accesskey="n" rel="next">Patch Properties</a>, Previous: <a href="Text-Properties.html#Text-Properties" accesskey="p" rel="prev">Text 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>
