15.3.3.5 Line Properties

Properties of line objects (see line):

beingdeleted: {"off"} | "on"

busyaction: "cancel" | {"queue"}

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 interruptible property set to "off". The busyaction property of the interrupting callback object indicates whether the interrupting callback is queued ("queue" (default)) or discarded ("cancel"). See Callbacks section.

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

For information on how to write graphics listener functions see Callbacks section.

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

children is unused.

clipping: "off" | {"on"}

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

color: colorspec, def. [0 0 0]

Color of the line object. See colorspec.

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

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

For information on how to write graphics listener functions see Callbacks section.

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

Callback function executed immediately before line is deleted.

For information on how to write graphics listener functions see Callbacks section.

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

Text for the legend entry corresponding to this line.

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

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

hittest: "off" | {"on"}

Specify whether line processes mouse events or passes them to ancestors of the object. When enabled, the object may respond to mouse clicks by evaluating the "buttondownfcn", showing the uicontextmenu, and eventually becoming the root "currentobject". This property is only relevant when the object can accept mouse clicks which is determined by the "pickableparts" property. See pickableparts property.

interruptible: "off" | {"on"}

Specify whether this object’s callback functions may be interrupted by other callbacks. By default interruptible is "on" and callbacks that make use of drawnow, figure, waitfor, getframe or pause functions are eventually interrupted. See Callbacks section.

linejoin: "chamfer" | "miter" | {"round"}

Control the shape of the junction of line segments. This property currently only affects the printed output.

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

See Line Styles.

linewidth: def. 0.5000

Width of the line object measured in points.

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

Shape of the marker for each data point. See Marker Styles.

markeredgecolor: {"auto"} | "none"

Color of the edge of the markers. When set to "auto", the marker edges have the same color as the line. If set to "none", no marker edges are displayed. This property can also be set to any color. See colorspec.

markerfacecolor: "auto" | {"none"}

Color of the face of the markers. When set to "auto", the marker faces have the same color as the line. If set to "none", the marker faces are not displayed. This property can also be set to any color. See colorspec.

markersize: scalar, def. 6

Size of the markers measured in points.

parent: graphics handle

Handle of the parent graphics object.

pickableparts: "all" | "none" | {"visible"}

Specify whether line will accept mouse clicks. By default, pickableparts is "visible" and only visible parts of the line or its children may react to mouse clicks. When pickableparts is "all" both visible and invisible parts (or children) may react to mouse clicks. When pickableparts is "none" 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 "hittest" property will determine how they are processed. See hittest property.

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

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

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

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

User-defined data to associate with the graphics object.

visible: "off" | {"on"}

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

xdata: vector, def. [0 1]

Vector of x data to be plotted.

xdatasource: string, def. ""

Name of a vector in the current base workspace to use as x data.

ydata: vector, def. [0 1]

Vector of y data to be plotted.

ydatasource: string, def. ""

Name of a vector in the current base workspace to use as y data.

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

Vector of z data to be plotted.

zdatasource: string, def. ""

Name of a vector in the current base workspace to use as z data.