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
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Text Properties (GNU Octave (version 7.3.0))</title>
<meta name="description" content="Text Properties (GNU Octave (version 7.3.0))">
<meta name="keywords" content="Text Properties (GNU Octave (version 7.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="Image-Properties.html" rel="next" title="Image Properties">
<link href="Line-Properties.html" rel="prev" title="Line Properties">
<style type="text/css">
<!--
a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em}
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {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}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
span:hover a.copiable-anchor {visibility: visible}
ul.no-bullet {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">
</head>
<body lang="en">
<div class="subsubsection" id="Text-Properties">
<div class="header">
<p>
Next: <a href="Image-Properties.html" accesskey="n" rel="next">Image Properties</a>, Previous: <a href="Line-Properties.html" accesskey="p" rel="prev">Line 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>
<span id="Text-Properties-1"></span><h4 class="subsubsection">15.3.3.6 Text Properties</h4>
<span id="index--Text-PropertiesText-Properties"></span>
<p>Properties of <code>text</code> objects (see <a href="Plot-Annotations.html#XREFtext">text</a>):
</p>
<dl compact="compact">
<dd>
<span id="XREFtextbackgroundcolor"></span><span id="index-text-backgroundcolor"></span>
</dd>
<dt><span><code>backgroundcolor</code>: colorspec, def. <code>"none"</code></span></dt>
<dd><p>Color of the background area. See <a href="Colors.html">colorspec</a>.
</p>
<span id="XREFtextbeingdeleted"></span><span id="index-text-beingdeleted"></span>
</dd>
<dt><span><code>beingdeleted</code>: {<code>"off"</code>} | <code>"on"</code></span></dt>
<dd>
<span id="XREFtextbusyaction"></span><span id="index-text-busyaction"></span>
</dd>
<dt><span><code>busyaction</code>: <code>"cancel"</code> | {<code>"queue"</code>}</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>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 section<!-- /@w --></a>.
</p>
<span id="XREFtextbuttondownfcn"></span><span id="index-text-buttondownfcn"></span>
</dd>
<dt><span><code>buttondownfcn</code>: string | function handle, def. <code>[](0x0)</code></span></dt>
<dd><p>For information on how to write graphics listener functions see <a href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFtextchildren"></span><span id="index-text-children"></span>
</dd>
<dt><span><code>children</code> (read-only): vector of graphics handles, def. <code>[](0x1)</code></span></dt>
<dd><p><code>children</code> is unused.
</p>
<span id="XREFtextclipping"></span><span id="index-text-clipping"></span>
</dd>
<dt><span><code>clipping</code>: <code>"off"</code> | {<code>"on"</code>}</span></dt>
<dd><p>If <code>clipping</code> is <code>"on"</code>, the text is clipped in its parent axes limits.
</p>
<span id="XREFtextcolor"></span><span id="index-text-color"></span>
</dd>
<dt><span><code>color</code>: colorspec, def. <code>[0 0 0]</code></span></dt>
<dd><p>Color of the text. See <a href="Colors.html">colorspec</a>.
</p>
<span id="XREFtextcontextmenu"></span><span id="index-text-contextmenu"></span>
</dd>
<dt><span><code>contextmenu</code>: graphics handle, def. <code>[](0x0)</code></span></dt>
<dd><p>Graphics handle of the uicontextmenu object that is currently associated to this text object.
</p>
<span id="XREFtextcreatefcn"></span><span id="index-text-createfcn"></span>
</dd>
<dt><span><code>createfcn</code>: string | function handle, def. <code>[](0x0)</code></span></dt>
<dd><p>Callback function executed immediately after text has been created. Function is set by using default property on root object, e.g., <code>set (groot, "defaulttextcreatefcn", 'disp ("text created!")')</code>.
</p>
<p>For information on how to write graphics listener functions see <a href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFtextdeletefcn"></span><span id="index-text-deletefcn"></span>
</dd>
<dt><span><code>deletefcn</code>: string | function handle, def. <code>[](0x0)</code></span></dt>
<dd><p>Callback function executed immediately before text is deleted.
</p>
<p>For information on how to write graphics listener functions see <a href="Callbacks.html">Callbacks section<!-- /@w --></a>.
</p>
<span id="XREFtextedgecolor"></span><span id="index-text-edgecolor"></span>
</dd>
<dt><span><code>edgecolor</code>: colorspec, def. <code>"none"</code></span></dt>
<dd><p>Color of the outline of the background area. See <a href="Colors.html">colorspec</a>.
</p>
<span id="XREFtextediting"></span><span id="index-text-editing"></span>
</dd>
<dt><span><code>editing</code>: {<code>"off"</code>} | <code>"on"</code></span></dt>
<dd><p><code>editing</code> is unused.
</p>
<span id="XREFtextextent"></span><span id="index-text-extent"></span>
</dd>
<dt><span><code>extent</code> (read-only): four-element vector</span></dt>
<dd><p>Vector <code>[x0 y0 width height]</code> indicating the size and location of the text string.
</p>
<span id="XREFtextfontangle"></span><span id="index-text-fontangle"></span>
</dd>
<dt><span><code>fontangle</code>: <code>"italic"</code> | {<code>"normal"</code>}</span></dt>
<dd><p>Control whether the font is italic or normal.
</p>
<span id="XREFtextfontname"></span><span id="index-text-fontname"></span>
</dd>
<dt><span><code>fontname</code>: string, def. <code>"*"</code></span></dt>
<dd><p>Name of font used for text rendering. When setting this property, the text rendering engine will search for a matching font in your system. If none is found then text is rendered using a default sans serif font (same as the default <code>"*"</code> value).
</p>
<p>Programming Note: On systems that don’t use FontConfig natively (all but Linux), the font cache is built when Octave is installed. You will need to run <code>system ("fc-cache -fv")</code> manually after installing new fonts.
</p>
<span id="XREFtextfontsize"></span><span id="index-text-fontsize"></span>
</dd>
<dt><span><code>fontsize</code>: scalar, def. <code>10</code></span></dt>
<dd><p>Size of the font used for text rendering. See <a href="#XREFtextfontunits">fontunits property</a>.
</p>
<span id="XREFtextfontsmoothing"></span><span id="index-text-fontsmoothing"></span>
</dd>
<dt><span><code>fontsmoothing</code>: <code>"off"</code> | {<code>"on"</code>}</span></dt>
<dd><p>Control whether anti-aliasing is used when rendering text.
</p>
<span id="XREFtextfontunits"></span><span id="index-text-fontunits"></span>
</dd>
<dt><span><code>fontunits</code>: <code>"centimeters"</code> | <code>"inches"</code> | <code>"normalized"</code> | <code>"pixels"</code> | {<code>"points"</code>}</span></dt>
<dd><p>Units used to interpret the <code>"fontsize"</code> property.
</p>
<span id="XREFtextfontweight"></span><span id="index-text-fontweight"></span>
</dd>
<dt><span><code>fontweight</code>: <code>"bold"</code> | {<code>"normal"</code>}</span></dt>
<dd><p>Control the variant of the base font used for text rendering.
</p>
<span id="XREFtexthandlevisibility"></span><span id="index-text-handlevisibility"></span>
</dd>
<dt><span><code>handlevisibility</code>: <code>"callback"</code> | <code>"off"</code> | {<code>"on"</code>}</span></dt>
<dd><p>If <code>handlevisibility</code> is <code>"off"</code>, the text’s handle is not visible in its parent’s "children" property.
</p>
<span id="XREFtexthittest"></span><span id="index-text-hittest"></span>
</dd>
<dt><span><code>hittest</code>: <code>"off"</code> | {<code>"on"</code>}</span></dt>
<dd><p>Specify whether text 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="#XREFtextpickableparts">pickableparts property<!-- /@w --></a>.
</p>
<span id="XREFtexthorizontalalignment"></span><span id="index-text-horizontalalignment"></span>
</dd>
<dt><span><code>horizontalalignment</code>: <code>"center"</code> | {<code>"left"</code>} | <code>"right"</code></span></dt>
<dd>
<span id="XREFtextinterpreter"></span><span id="index-text-interpreter"></span>
</dd>
<dt><span><code>interpreter</code>: <code>"latex"</code> | <code>"none"</code> | {<code>"tex"</code>}</span></dt>
<dd><p>Control the way the <code>"string"</code> property is interpreted.
See <a href="Use-of-the-interpreter-Property.html#XREFinterpreterusage">Use of the interpreter property<!-- /@w --></a>.
</p>
<span id="XREFtextinterruptible"></span><span id="index-text-interruptible"></span>
</dd>
<dt><span><code>interruptible</code>: <code>"off"</code> | {<code>"on"</code>}</span></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 section<!-- /@w --></a>.
</p>
<span id="XREFtextlinestyle"></span><span id="index-text-linestyle"></span>
</dd>
<dt><span><code>linestyle</code>: {<code>"-"</code>} | <code>"--"</code> | <code>"-."</code> | <code>":"</code> | <code>"none"</code></span></dt>
<dd><p>Style of the outline. See <a href="Line-Styles.html">Line Styles</a>.
</p>
<span id="XREFtextlinewidth"></span><span id="index-text-linewidth"></span>
</dd>
<dt><span><code>linewidth</code>: scalar, def. <code>0.5000</code></span></dt>
<dd><p>Width of the outline.
</p>
<span id="XREFtextmargin"></span><span id="index-text-margin"></span>
</dd>
<dt><span><code>margin</code>: scalar, def. <code>3</code></span></dt>
<dd><p>Margins between the borders of the background area and the texts. The value is currently interpreted as pixels, regardless of the <code>"fontunits"</code> property.
</p>
<span id="XREFtextparent"></span><span id="index-text-parent"></span>
</dd>
<dt><span><code>parent</code>: graphics handle</span></dt>
<dd><p>Handle of the parent graphics object.
</p>
<span id="XREFtextpickableparts"></span><span id="index-text-pickableparts"></span>
</dd>
<dt><span><code>pickableparts</code>: <code>"all"</code> | <code>"none"</code> | {<code>"visible"</code>}</span></dt>
<dd><p>Specify whether text will accept mouse clicks. By default, <code>pickableparts</code> is <code>"visible"</code> and only visible parts of the text 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="#XREFtexthittest">hittest property<!-- /@w --></a>.
</p>
<span id="XREFtextposition"></span><span id="index-text-position"></span>
</dd>
<dt><span><code>position</code>: three-element vector, def. <code>[0 0 0]</code></span></dt>
<dd><p>Vector <code>[X0 Y0 Z0]</code> where X0, Y0, and Z0 indicate the position of the text anchor as defined by <code>verticalalignment</code> and <code>horizontalalignment</code>.
</p>
<span id="XREFtextrotation"></span><span id="index-text-rotation"></span>
</dd>
<dt><span><code>rotation</code>: scalar, def. <code>0</code></span></dt>
<dd><p>The angle of rotation for the displayed text, measured in degrees.
</p>
<span id="XREFtextselected"></span><span id="index-text-selected"></span>
</dd>
<dt><span><code>selected</code>: {<code>"off"</code>} | <code>"on"</code></span></dt>
<dd>
<span id="XREFtextselectionhighlight"></span><span id="index-text-selectionhighlight"></span>
</dd>
<dt><span><code>selectionhighlight</code>: <code>"off"</code> | {<code>"on"</code>}</span></dt>
<dd>
<span id="XREFtextstring"></span><span id="index-text-string"></span>
</dd>
<dt><span><code>string</code>: string, def. <code>""</code></span></dt>
<dd><p>The text object string content.
</p>
<span id="XREFtexttag"></span><span id="index-text-tag"></span>
</dd>
<dt><span><code>tag</code>: string, def. <code>""</code></span></dt>
<dd><p>A user-defined string to label the graphics object.
</p>
<span id="XREFtexttype"></span><span id="index-text-type"></span>
</dd>
<dt><span><code>type</code> (read-only): string</span></dt>
<dd><p>Class name of the graphics object. <code>type</code> is always <code>"text"</code>
</p>
<span id="XREFtextunits"></span><span id="index-text-units"></span>
</dd>
<dt><span><code>units</code>: <code>"centimeters"</code> | {<code>"data"</code>} | <code>"inches"</code> | <code>"normalized"</code> | <code>"pixels"</code> | <code>"points"</code></span></dt>
<dd>
<span id="XREFtextuserdata"></span><span id="index-text-userdata"></span>
</dd>
<dt><span><code>userdata</code>: Any Octave data, def. <code>[](0x0)</code></span></dt>
<dd><p>User-defined data to associate with the graphics object.
</p>
<span id="XREFtextverticalalignment"></span><span id="index-text-verticalalignment"></span>
</dd>
<dt><span><code>verticalalignment</code>: <code>"baseline"</code> | <code>"bottom"</code> | <code>"cap"</code> | {<code>"middle"</code>} | <code>"top"</code></span></dt>
<dd>
<span id="XREFtextvisible"></span><span id="index-text-visible"></span>
</dd>
<dt><span><code>visible</code>: <code>"off"</code> | {<code>"on"</code>}</span></dt>
<dd><p>If <code>visible</code> is <code>"off"</code>, the text is not rendered on screen.
</p>
</dd>
</dl>
</div>
<hr>
<div class="header">
<p>
Next: <a href="Image-Properties.html">Image Properties</a>, Previous: <a href="Line-Properties.html">Line 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>
|
