15.3.3.6 Image Properties

The image properties are:

__modified__: "off" | {"on"}

alphadata: scalar | matrix, def. 1

Transparency is not yet implemented for image objects. alphadata is unused.

alphadatamapping: "direct" | {"none"} | "scaled"

Transparency is not yet implemented for image objects. alphadatamapping is unused.

beingdeleted: {"off"} | "on"

busyaction: "cancel" | {"queue"}

buttondownfcn: string | function handle, def. [](0x0)

cdata: matrix, def. 64-by-64 double

cdatamapping: {"direct"} | "scaled"

children (read-only): vector of graphics handles, def. [](0x1)

children is unused.

clipping: "off" | {"on"}

If clipping is "on", the image is clipped in its parent axes limits.

createfcn: string | function handle, def. [](0x0)

Callback function executed immediately after image has been created. Function is set by using default property on root object, e.g., set (0, "defaultimagecreatefcn", 'disp ("image created!")').

deletefcn: string | function handle, def. [](0x0)

Callback function executed immediately before image is deleted.

displayname: string | cell array of strings, def. ""

Text for the legend entry corresponding to this image.

erasemode: "background" | "none" | {"normal"} | "xor"

erasemode is unused.

handlevisibility: "callback" | "off" | {"on"}

If handlevisibility is "off", the image’s handle is not visible in its parent’s "children" property.

hittest: "off" | {"on"}

interruptible: "off" | {"on"}

parent: graphics handle

Handle of the parent graphics object.

selected: {"off"} | "on"

selectionhighlight: "off" | {"on"}

tag: string, def. ""

A user-defined string to label the graphics object.

type (read-only): string

Class name of the graphics object. type is always "image"

uicontextmenu: graphics handle, def. [](0x0)

Graphics handle of the uicontextmenu object that is currently associated to this image object.

userdata: Any Octave data, def. [](0x0)

User-defined data to associate with the graphics object.

visible: "off" | {"on"}

If visible is "off", the image is not rendered on screen.

xdata: two-element vector, def. [1 64]

Two-element vector [xmin xmax] specifying the x coordinates of the first and last columns of the image.

Setting xdata to the empty matrix ([]) will restore the default value of [1 columns(image)].

ydata: two-element vector, def. [1 64]

Two-element vector [ymin ymax] specifying the y coordinates of the first and last rows of the image.

Setting ydata to the empty matrix ([]) will restore the default value of [1 rows(image)].