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
|
<!DOCTYPE html>
<html>
<!-- Created by GNU Texinfo 7.1.1, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Line Properties (GNU Octave (version 10.3.0))</title>
<meta name="description" content="Line Properties (GNU Octave (version 10.3.0))">
<meta name="keywords" content="Line Properties (GNU Octave (version 10.3.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Concept-Index.html" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Graphics-Object-Properties.html" rel="up" title="Graphics Object Properties">
<link href="Text-Properties.html" rel="next" title="Text Properties">
<link href="Legend-Properties.html" rel="prev" title="Legend Properties">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<div class="subsubsection-level-extent" id="Line-Properties">
<div class="nav-panel">
<p>
Next: <a href="Text-Properties.html" accesskey="n" rel="next">Text Properties</a>, Previous: <a href="Legend-Properties.html" accesskey="p" rel="prev">Legend Properties</a>, Up: <a href="Graphics-Object-Properties.html" 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" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h4 class="subsubsection" id="Line-Properties-1"><span>15.3.3.5 Line Properties<a class="copiable-link" href="#Line-Properties-1"> ¶</a></span></h4>
<a class="index-entry-id" id="index-Line-Properties"></a>
<p>Properties of <code class="code">line</code> objects (see <a class="pxref" href="Creating-Graphics-Objects.html#XREFline">line</a>):
</p>
<h4 class="subsubheading" id="Categories_003a-4"><span>Categories:<a class="copiable-link" href="#Categories_003a-4"> ¶</a></span></h4>
<p><a class="ref" href="#XREFlinecategoryCallbackExecution">Callback Execution<!-- /@w --></a> | <a class="ref" href="#XREFlinecategoryCoordinateData">Coordinate Data<!-- /@w --></a> | <a class="ref" href="#XREFlinecategoryCreation_002fDeletion">Creation/Deletion<!-- /@w --></a> | <a class="ref" href="#XREFlinecategoryDisplay">Display<!-- /@w --></a> | <a class="ref" href="#XREFlinecategoryLegendOptions">Legend Options<!-- /@w --></a> | <a class="ref" href="#XREFlinecategoryLineAppearance">Line Appearance<!-- /@w --></a> | <a class="ref" href="#XREFlinecategoryMarkerAppearance">Marker Appearance<!-- /@w --></a> | <a class="ref" href="#XREFlinecategoryMouseInteraction">Mouse Interaction<!-- /@w --></a> | <a class="ref" href="#XREFlinecategoryObjectIdentification">Object Identification<!-- /@w --></a> | <a class="ref" href="#XREFlinecategoryParent_002fChildren">Parent/Children<!-- /@w --></a>
</p>
<a class="anchor" id="XREFlinecategoryCallbackExecution"></a><h4 class="subsubheading" id="Callback-Execution-4"><span>Callback Execution<a class="copiable-link" href="#Callback-Execution-4"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFlinebusyaction"></a></dd>
<dt><a id="index-line-busyaction"></a><span><code class="code">busyaction</code>: <code class="code">"cancel"</code> | {<code class="code">"queue"</code>}<a class="copiable-link" href="#index-line-busyaction"> ¶</a></span></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 class="code">interruptible</code> property set to <code class="code">"off"</code>. The <code class="code">busyaction</code> property of the interrupting callback object indicates whether the interrupting callback is queued (<code class="code">"queue"</code> (default)) or discarded (<code class="code">"cancel"</code>).
See <a class="xref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFlineinterruptible"></a></dd>
<dt><a id="index-line-interruptible"></a><span><code class="code">interruptible</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-line-interruptible"> ¶</a></span></dt>
<dd><p>Specify whether this object’s callback functions may be interrupted by other callbacks. By default <code class="code">interruptible</code> is <code class="code">"on"</code> and callbacks that make use of <code class="code">drawnow</code>, <code class="code">figure</code>, <code class="code">waitfor</code>, <code class="code">getframe</code> or <code class="code">pause</code> functions are eventually interrupted.
See <a class="xref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
</dd>
</dl>
<a class="anchor" id="XREFlinecategoryCoordinateData"></a><h4 class="subsubheading" id="Coordinate-Data"><span>Coordinate Data<a class="copiable-link" href="#Coordinate-Data"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFlinexdata"></a></dd>
<dt><a id="index-line-xdata"></a><span><code class="code">xdata</code>: vector, def. <code class="code">[0 1]</code><a class="copiable-link" href="#index-line-xdata"> ¶</a></span></dt>
<dd><p>Vector of x data to be plotted.
</p>
<a class="anchor" id="XREFlinexdatasource"></a></dd>
<dt><a id="index-line-xdatasource"></a><span><code class="code">xdatasource</code>: string, def. <code class="code">""</code><a class="copiable-link" href="#index-line-xdatasource"> ¶</a></span></dt>
<dd><p>Name of a vector in the current base workspace to use as x data.
</p>
<a class="anchor" id="XREFlineydata"></a></dd>
<dt><a id="index-line-ydata"></a><span><code class="code">ydata</code>: vector, def. <code class="code">[0 1]</code><a class="copiable-link" href="#index-line-ydata"> ¶</a></span></dt>
<dd><p>Vector of y data to be plotted.
</p>
<a class="anchor" id="XREFlineydatasource"></a></dd>
<dt><a id="index-line-ydatasource"></a><span><code class="code">ydatasource</code>: string, def. <code class="code">""</code><a class="copiable-link" href="#index-line-ydatasource"> ¶</a></span></dt>
<dd><p>Name of a vector in the current base workspace to use as y data.
</p>
<a class="anchor" id="XREFlinezdata"></a></dd>
<dt><a id="index-line-zdata"></a><span><code class="code">zdata</code>: vector, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-line-zdata"> ¶</a></span></dt>
<dd><p>Vector of z data to be plotted.
</p>
<a class="anchor" id="XREFlinezdatasource"></a></dd>
<dt><a id="index-line-zdatasource"></a><span><code class="code">zdatasource</code>: string, def. <code class="code">""</code><a class="copiable-link" href="#index-line-zdatasource"> ¶</a></span></dt>
<dd><p>Name of a vector in the current base workspace to use as z data.
</p>
</dd>
</dl>
<a class="anchor" id="XREFlinecategoryCreation_002fDeletion"></a><h4 class="subsubheading" id="Creation_002fDeletion-2"><span>Creation/Deletion<a class="copiable-link" href="#Creation_002fDeletion-2"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFlinebeingdeleted"></a></dd>
<dt><a id="index-line-beingdeleted"></a><span><code class="code">beingdeleted</code>: {<code class="code">"off"</code>} | <code class="code">"on"</code><a class="copiable-link" href="#index-line-beingdeleted"> ¶</a></span></dt>
<dd><p>Property indicating that a function has initiated deletion of the object. <code class="code">beingdeleted</code> is set to true until the object no longer exists.
</p>
<a class="anchor" id="XREFlinecreatefcn"></a></dd>
<dt><a id="index-line-createfcn"></a><span><code class="code">createfcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-line-createfcn"> ¶</a></span></dt>
<dd><p>Callback function executed immediately after line has been created. Function is set by using default property on root object, e.g., <code class="code">set (groot, "defaultlinecreatefcn", 'disp ("line created!")')</code>.
</p>
<p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFlinedeletefcn"></a></dd>
<dt><a id="index-line-deletefcn"></a><span><code class="code">deletefcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-line-deletefcn"> ¶</a></span></dt>
<dd><p>Callback function executed immediately before line is deleted.
</p>
<p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
</dd>
</dl>
<a class="anchor" id="XREFlinecategoryDisplay"></a><h4 class="subsubheading" id="Display-2"><span>Display<a class="copiable-link" href="#Display-2"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFlineclipping"></a></dd>
<dt><a id="index-line-clipping"></a><span><code class="code">clipping</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-line-clipping"> ¶</a></span></dt>
<dd><p>If <code class="code">clipping</code> is <code class="code">"on"</code>, the line is clipped in its parent axes limits.
</p>
<a class="anchor" id="XREFlinevisible"></a></dd>
<dt><a id="index-line-visible"></a><span><code class="code">visible</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-line-visible"> ¶</a></span></dt>
<dd><p>If <code class="code">visible</code> is <code class="code">"off"</code>, the line is not rendered on screen.
</p>
</dd>
</dl>
<a class="anchor" id="XREFlinecategoryLegendOptions"></a><h4 class="subsubheading" id="Legend-Options"><span>Legend Options<a class="copiable-link" href="#Legend-Options"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFlinedisplayname"></a></dd>
<dt><a id="index-line-displayname"></a><span><code class="code">displayname</code>: string | cell array of strings, def. <code class="code">""</code><a class="copiable-link" href="#index-line-displayname"> ¶</a></span></dt>
<dd><p>Text for the legend entry corresponding to this line.
</p>
</dd>
</dl>
<a class="anchor" id="XREFlinecategoryLineAppearance"></a><h4 class="subsubheading" id="Line-Appearance"><span>Line Appearance<a class="copiable-link" href="#Line-Appearance"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFlinecolor"></a></dd>
<dt><a id="index-line-color"></a><span><code class="code">color</code>: colorspec, def. <code class="code">[0 0 0]</code><a class="copiable-link" href="#index-line-color"> ¶</a></span></dt>
<dd><p>Color of the line object. See <a class="xref" href="Colors.html">colorspec</a>.
</p>
<a class="anchor" id="XREFlinelinejoin"></a></dd>
<dt><a id="index-line-linejoin"></a><span><code class="code">linejoin</code>: <code class="code">"chamfer"</code> | <code class="code">"miter"</code> | {<code class="code">"round"</code>}<a class="copiable-link" href="#index-line-linejoin"> ¶</a></span></dt>
<dd><p>Control the shape of the junction of line segments. This property currently only affects the printed output.
</p>
<a class="anchor" id="XREFlinelinestyle"></a></dd>
<dt><a id="index-line-linestyle"></a><span><code class="code">linestyle</code>: {<code class="code">"-"</code>} | <code class="code">"--"</code> | <code class="code">"-."</code> | <code class="code">":"</code> | <code class="code">"none"</code><a class="copiable-link" href="#index-line-linestyle"> ¶</a></span></dt>
<dd><p>See <a class="xref" href="Line-Styles.html">Line Styles</a>.
</p>
<a class="anchor" id="XREFlinelinewidth"></a></dd>
<dt><a id="index-line-linewidth"></a><span><code class="code">linewidth</code>: scalar, def. <code class="code">0.5000</code><a class="copiable-link" href="#index-line-linewidth"> ¶</a></span></dt>
<dd><p>Width of the line object measured in points.
</p>
</dd>
</dl>
<a class="anchor" id="XREFlinecategoryMarkerAppearance"></a><h4 class="subsubheading" id="Marker-Appearance"><span>Marker Appearance<a class="copiable-link" href="#Marker-Appearance"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFlinemarker"></a></dd>
<dt><a id="index-line-marker"></a><span><code class="code">marker</code>: <code class="code">"*"</code> | <code class="code">"+"</code> | <code class="code">"."</code> | <code class="code">"<"</code> | <code class="code">">"</code> | <code class="code">"^"</code> | <code class="code">"_"</code> | <code class="code">"d"</code> | <code class="code">"diamond"</code> | <code class="code">"h"</code> | <code class="code">"hexagram"</code> | {<code class="code">"none"</code>} | <code class="code">"o"</code> | <code class="code">"p"</code> | <code class="code">"pentagram"</code> | <code class="code">"s"</code> | <code class="code">"square"</code> | <code class="code">"v"</code> | <code class="code">"x"</code> | <code class="code">"|"</code><a class="copiable-link" href="#index-line-marker"> ¶</a></span></dt>
<dd><p>Shape of the marker for each data point. See <a class="xref" href="Marker-Styles.html">Marker Styles</a>.
</p>
<a class="anchor" id="XREFlinemarkeredgecolor"></a></dd>
<dt><a id="index-line-markeredgecolor"></a><span><code class="code">markeredgecolor</code>: {<code class="code">"auto"</code>} | <code class="code">"none"</code><a class="copiable-link" href="#index-line-markeredgecolor"> ¶</a></span></dt>
<dd><p>Color of the edge of the markers. When set to <code class="code">"auto"</code>, the marker edges have the same color as the line. If set to <code class="code">"none"</code>, no marker edges are displayed. This property can also be set to any color. See <a class="xref" href="Colors.html">colorspec</a>.
</p>
<a class="anchor" id="XREFlinemarkerfacecolor"></a></dd>
<dt><a id="index-line-markerfacecolor"></a><span><code class="code">markerfacecolor</code>: <code class="code">"auto"</code> | {<code class="code">"none"</code>}<a class="copiable-link" href="#index-line-markerfacecolor"> ¶</a></span></dt>
<dd><p>Color of the face of the markers. When set to <code class="code">"auto"</code>, the marker faces have the same color as the line. If set to <code class="code">"none"</code>, the marker faces are not displayed. This property can also be set to any color. See <a class="xref" href="Colors.html">colorspec</a>.
</p>
<a class="anchor" id="XREFlinemarkersize"></a></dd>
<dt><a id="index-line-markersize"></a><span><code class="code">markersize</code>: scalar, def. <code class="code">6</code><a class="copiable-link" href="#index-line-markersize"> ¶</a></span></dt>
<dd><p>Size of the markers measured in points.
</p>
</dd>
</dl>
<a class="anchor" id="XREFlinecategoryMouseInteraction"></a><h4 class="subsubheading" id="Mouse-Interaction-3"><span>Mouse Interaction<a class="copiable-link" href="#Mouse-Interaction-3"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFlinebuttondownfcn"></a></dd>
<dt><a id="index-line-buttondownfcn"></a><span><code class="code">buttondownfcn</code>: string | function handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-line-buttondownfcn"> ¶</a></span></dt>
<dd><p>For information on how to write graphics listener functions see <a class="ref" href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFlinecontextmenu"></a></dd>
<dt><a id="index-line-contextmenu"></a><span><code class="code">contextmenu</code>: graphics handle, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-line-contextmenu"> ¶</a></span></dt>
<dd><p>Graphics handle of the uicontextmenu object that is currently associated to this line object.
</p>
<a class="anchor" id="XREFlinehittest"></a></dd>
<dt><a id="index-line-hittest"></a><span><code class="code">hittest</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-line-hittest"> ¶</a></span></dt>
<dd><p>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 <code class="code">"buttondownfcn"</code>, showing the uicontextmenu, and eventually becoming the root <code class="code">"currentobject"</code>. This property is only relevant when the object can accept mouse clicks which is determined by the <code class="code">"pickableparts"</code> property. See <a class="xref" href="#XREFlinepickableparts">pickableparts property<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFlinepickableparts"></a></dd>
<dt><a id="index-line-pickableparts"></a><span><code class="code">pickableparts</code>: <code class="code">"all"</code> | <code class="code">"none"</code> | {<code class="code">"visible"</code>}<a class="copiable-link" href="#index-line-pickableparts"> ¶</a></span></dt>
<dd><p>Specify whether line will accept mouse clicks. By default, <code class="code">pickableparts</code> is <code class="code">"visible"</code> and only visible parts of the line or its children may react to mouse clicks. When <code class="code">pickableparts</code> is <code class="code">"all"</code> both visible and invisible parts (or children) may react to mouse clicks. When <code class="code">pickableparts</code> is <code class="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 class="code">"hittest"</code> property will determine how they are processed. See <a class="xref" href="#XREFlinehittest">hittest property<!-- /@w --></a>.
</p>
<a class="anchor" id="XREFlineselected"></a></dd>
<dt><a id="index-line-selected"></a><span><code class="code">selected</code>: {<code class="code">"off"</code>} | <code class="code">"on"</code><a class="copiable-link" href="#index-line-selected"> ¶</a></span></dt>
<dd><p>Property indicates whether this line is selected.
</p>
<a class="anchor" id="XREFlineselectionhighlight"></a></dd>
<dt><a id="index-line-selectionhighlight"></a><span><code class="code">selectionhighlight</code>: <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-line-selectionhighlight"> ¶</a></span></dt>
<dd><p>If <code class="code">selectionhighlight</code> is <code class="code">"on"</code>, then the line’s selection state is visually highlighted.
</p>
</dd>
</dl>
<a class="anchor" id="XREFlinecategoryObjectIdentification"></a><h4 class="subsubheading" id="Object-Identification-4"><span>Object Identification<a class="copiable-link" href="#Object-Identification-4"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFlinetag"></a></dd>
<dt><a id="index-line-tag"></a><span><code class="code">tag</code>: string, def. <code class="code">""</code><a class="copiable-link" href="#index-line-tag"> ¶</a></span></dt>
<dd><p>A user-defined string to label the graphics object.
</p>
<a class="anchor" id="XREFlinetype"></a></dd>
<dt><a id="index-line-type"></a><span><code class="code">type</code> (read-only): string<a class="copiable-link" href="#index-line-type"> ¶</a></span></dt>
<dd><p>Class name of the graphics object. <code class="code">type</code> is always <code class="code">"line"</code>.
</p>
<a class="anchor" id="XREFlineuserdata"></a></dd>
<dt><a id="index-line-userdata"></a><span><code class="code">userdata</code>: Any Octave data, def. <code class="code">[](0x0)</code><a class="copiable-link" href="#index-line-userdata"> ¶</a></span></dt>
<dd><p>User-defined data to associate with the graphics object.
</p>
</dd>
</dl>
<a class="anchor" id="XREFlinecategoryParent_002fChildren"></a><h4 class="subsubheading" id="Parent_002fChildren-3"><span>Parent/Children<a class="copiable-link" href="#Parent_002fChildren-3"> ¶</a></span></h4>
<dl class="table">
<dd>
<a class="anchor" id="XREFlinechildren"></a></dd>
<dt><a id="index-line-children"></a><span><code class="code">children</code> (read-only): vector of graphics handles, def. <code class="code">[](0x1)</code><a class="copiable-link" href="#index-line-children"> ¶</a></span></dt>
<dd><p>Child objects for lines is not yet implemented for line objects. <code class="code">children</code> is unused.
</p>
<a class="anchor" id="XREFlinehandlevisibility"></a></dd>
<dt><a id="index-line-handlevisibility"></a><span><code class="code">handlevisibility</code>: <code class="code">"callback"</code> | <code class="code">"off"</code> | {<code class="code">"on"</code>}<a class="copiable-link" href="#index-line-handlevisibility"> ¶</a></span></dt>
<dd><p>If <code class="code">handlevisibility</code> is <code class="code">"off"</code>, the line’s handle is not visible in its parent’s <code class="code">"children"</code> property.
</p>
<a class="anchor" id="XREFlineparent"></a></dd>
<dt><a id="index-line-parent"></a><span><code class="code">parent</code>: graphics handle<a class="copiable-link" href="#index-line-parent"> ¶</a></span></dt>
<dd><p>Handle of the parent graphics object.
</p>
</dd>
</dl>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Text-Properties.html">Text Properties</a>, Previous: <a href="Legend-Properties.html">Legend Properties</a>, Up: <a href="Graphics-Object-Properties.html">Graphics Object Properties</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|
