15.3.3.7 Patch Properties

The patch properties are:

__modified__: "off" | {"on"}

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

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

ambientstrength: scalar, def. 0.30000

Light is not yet implemented for patch objects. ambientstrength is unused.

backfacelighting: "lit" | {"reverselit"} | "unlit"

Light is not yet implemented for patch objects. backfacelighting is unused.

beingdeleted: {"off"} | "on"

busyaction: "cancel" | {"queue"}

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

cdata: scalar | matrix, def. [](0x0)

Data defining the patch object color. Patch color can be defined for faces or for vertices.

If cdata is a scalar index into the current colormap or a RGB triplet, it defines the color of all faces.

If cdata is an N-by-1 vector of indices or an N-by-3 (RGB) matrix, it defines the color of each one of the N faces.

If cdata is an N-by-M or an N-by-M-by-3 (RGB) matrix, it defines the color at each vertex.

cdatamapping: "direct" | {"scaled"}

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

children is unused.

clipping: "off" | {"on"}

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

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

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

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

Callback function executed immediately before patch is deleted.

diffusestrength: scalar, def. 0.60000

Light is not yet implemented for patch objects. diffusestrength is unused.

displayname: def. ""

Text of the legend entry corresponding to this patch.

edgealpha: scalar | matrix, def. 1

Transparency is not yet implemented for patch objects. edgealpha is unused.

edgecolor: def. [0 0 0]

edgelighting: "flat" | "gouraud" | {"none"} | "phong"

Light is not yet implemented for patch objects. edgelighting is unused.

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

erasemode is unused.

facealpha: scalar | matrix, def. 1

Transparency is not yet implemented for patch objects. facealpha is unused.

facecolor: {colorspec} | "none" | "flat" | "interp", def. [0 0 0]

facelighting: "flat" | "gouraud" | {"none"} | "phong"

Light is not yet implemented for patch objects. facelighting is unused.

faces: def. [1 2 3]

facevertexalphadata: scalar | matrix, def. [](0x0)

Transparency is not yet implemented for patch objects. facevertexalphadata is unused.

facevertexcdata: def. [](0x0)

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

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

hittest: "off" | {"on"}

interpreter: "latex" | "none" | {"tex"}

interpreter is unused.

interruptible: "off" | {"on"}

linestyle: {"-"} | "--" | "-." | ":" | "none"

linewidth: def. 0.50000

marker: "*" | "+" | "." | "<" | ">" | "^" | "d" | "diamond" | "h" | "hexagram" | {"none"} | "o" | "p" | "pentagram" | "s" | "square" | "v" | "x"

See line marker property.

markeredgecolor: {"auto"} | "flat" | "none"

See line markeredgecolor property.

markerfacecolor: "auto" | "flat" | {"none"}

See line markerfacecolor property.

markersize: scalar, def. 6

See line markersize property.

normalmode: {"auto"} | "manual"

parent: graphics handle

Handle of the parent graphics object.

selected: {"off"} | "on"

selectionhighlight: "off" | {"on"}

specularcolorreflectance: scalar, def. 1

Light is not yet implemented for patch objects. specularcolorreflectance is unused.

specularexponent: scalar, def. 10

Light is not yet implemented for patch objects. specularexponent is unused.

specularstrength: scalar, def. 0.90000

Light is not yet implemented for patch objects. specularstrength is unused.

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 "patch"

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

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

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

User-defined data to associate with the graphics object.

vertexnormals: def. [](0x0)

vertices: vector | matrix, def. 3-by-2 double

visible: "off" | {"on"}

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

xdata: vector | matrix, def. [0; 1; 0]

ydata: vector | matrix, def. [1; 1; 0]

zdata: vector | matrix, def. [](0x0)