File: plot-textproperties.texi

package info (click to toggle)
octave 4.0.3-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 94,200 kB
  • ctags: 52,925
  • sloc: cpp: 316,850; ansic: 43,469; fortran: 23,670; sh: 13,805; yacc: 8,204; objc: 7,939; lex: 3,631; java: 2,127; makefile: 1,746; perl: 1,022; awk: 988
file content (268 lines) | stat: -rw-r--r-- 7,736 bytes parent folder | download | duplicates (2)
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
@c DO NOT EDIT!  Generated automatically by genpropdoc.m.

@c Copyright (C) 2014-2015 Pantxo Diribarne
@c
@c This file is part of Octave.
@c
@c Octave is free software; you can redistribute it and/or modify it
@c under the terms of the GNU General Public License as published by the
@c Free Software Foundation; either version 3 of the License, or (at
@c your option) any later version.
@c
@c Octave is distributed in the hope that it will be useful, but WITHOUT
@c ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
@c FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
@c for more details.
@c
@c You should have received a copy of the GNU General Public License
@c along with Octave; see the file COPYING.  If not, see
@c <http://www.gnu.org/licenses/>.

@table @asis

@anchor{XREFtext__modified__}
@cindex text __modified__
@item @code{__modified__}: @qcode{"off"} | @{@qcode{"on"}@}



@anchor{XREFtextbackgroundcolor}
@cindex text backgroundcolor
@item @code{backgroundcolor}: colorspec, def. @qcode{"none"}
Background area is not yet implemented for text objects.  @code{backgroundcolor} is unused.


@anchor{XREFtextbeingdeleted}
@cindex text beingdeleted
@item @code{beingdeleted}: @{@qcode{"off"}@} | @qcode{"on"}



@anchor{XREFtextbusyaction}
@cindex text busyaction
@item @code{busyaction}: @qcode{"cancel"} | @{@qcode{"queue"}@}



@anchor{XREFtextbuttondownfcn}
@cindex text buttondownfcn
@item @code{buttondownfcn}: string | function handle, def. @code{[](0x0)}



@anchor{XREFtextchildren}
@cindex text children
@item @code{children} (read-only): vector of graphics handles, def. @code{[](0x1)}
@code{children} is unused.


@anchor{XREFtextclipping}
@cindex text clipping
@item @code{clipping}: @qcode{"off"} | @{@qcode{"on"}@}
If @code{clipping} is @qcode{"on"}, the text is clipped in its parent axes limits.


@anchor{XREFtextcolor}
@cindex text color
@item @code{color}: colorspec, def. @code{[0   0   0]}
Color of the text.  @xref{Colors, ,colorspec}.


@anchor{XREFtextcreatefcn}
@cindex text createfcn
@item @code{createfcn}: string | function handle, def. @code{[](0x0)}
Callback function executed immediately after text has been created.  Function is set by using default property on root object, e.g., @code{set (0, "defaulttextcreatefcn", 'disp ("text created!")')}.


@anchor{XREFtextdeletefcn}
@cindex text deletefcn
@item @code{deletefcn}: string | function handle, def. @code{[](0x0)}
Callback function executed immediately before text is deleted.


@anchor{XREFtextdisplayname}
@cindex text displayname
@item @code{displayname}: def. @qcode{""}



@anchor{XREFtextedgecolor}
@cindex text edgecolor
@item @code{edgecolor}: colorspec, def. @qcode{"none"}
Background area is not yet implemented for text objects.  @code{edgecolor} is unused.


@anchor{XREFtextediting}
@cindex text editing
@item @code{editing}: @{@qcode{"off"}@} | @qcode{"on"}



@anchor{XREFtexterasemode}
@cindex text erasemode
@item @code{erasemode}: @qcode{"background"} | @qcode{"none"} | @{@qcode{"normal"}@} | @qcode{"xor"}
@code{erasemode} is unused.


@anchor{XREFtextextent}
@cindex text extent
@item @code{extent} (read-only): def. @code{[0.000000  -0.005843   0.000000   0.032136]}



@anchor{XREFtextfontangle}
@cindex text fontangle
@item @code{fontangle}: @qcode{"italic"} | @{@qcode{"normal"}@} | @qcode{"oblique"}
Flag whether the font is italic or normal.  @code{fontangle} is currently unused.


@anchor{XREFtextfontname}
@cindex text fontname
@item @code{fontname}: string, def. @qcode{"*"}
The font used for the text.


@anchor{XREFtextfontsize}
@cindex text fontsize
@item @code{fontsize}: scalar, def. @code{10}
The font size of the text as measured in @code{fontunits}.


@anchor{XREFtextfontunits}
@cindex text fontunits
@item @code{fontunits}: @qcode{"centimeters"} | @qcode{"inches"} | @qcode{"normalized"} | @qcode{"pixels"} | @{@qcode{"points"}@}
The units used to interpret @code{fontsize} property.


@anchor{XREFtextfontweight}
@cindex text fontweight
@item @code{fontweight}: @qcode{"bold"} | @qcode{"demi"} | @qcode{"light"} | @{@qcode{"normal"}@}
Control variant of base font used: bold, light, normal, etc.


@anchor{XREFtexthandlevisibility}
@cindex text handlevisibility
@item @code{handlevisibility}: @qcode{"callback"} | @qcode{"off"} | @{@qcode{"on"}@}
If @code{handlevisibility} is @qcode{"off"}, the text's handle is not visible in its parent's "children" property.


@anchor{XREFtexthittest}
@cindex text hittest
@item @code{hittest}: @qcode{"off"} | @{@qcode{"on"}@}



@anchor{XREFtexthorizontalalignment}
@cindex text horizontalalignment
@item @code{horizontalalignment}: @qcode{"center"} | @{@qcode{"left"}@} | @qcode{"right"}



@anchor{XREFtextinterpreter}
@cindex text interpreter
@item @code{interpreter}: @qcode{"latex"} | @qcode{"none"} | @{@qcode{"tex"}@}



@anchor{XREFtextinterruptible}
@cindex text interruptible
@item @code{interruptible}: @qcode{"off"} | @{@qcode{"on"}@}



@anchor{XREFtextlinestyle}
@cindex text linestyle
@item @code{linestyle}: @{@qcode{"-"}@} | @qcode{"--"} | @qcode{"-."} | @qcode{":"} | @qcode{"none"}
Background area is not yet implemented for text objects.  @code{linestyle} is unused.


@anchor{XREFtextlinewidth}
@cindex text linewidth
@item @code{linewidth}: scalar, def. @code{0.50000}
Background area is not yet implemented for text objects.  @code{linewidth} is unused.


@anchor{XREFtextmargin}
@cindex text margin
@item @code{margin}: scalar, def. @code{2}
Background area is not yet implemented for text objects.  @code{margin} is unused.


@anchor{XREFtextparent}
@cindex text parent
@item @code{parent}: graphics handle
Handle of the parent graphics object.


@anchor{XREFtextposition}
@cindex text position
@item @code{position}: four-element vector, def. @code{[0   0   0]}
Vector @code{[X0 Y0 Z0]} where X0, Y0 and Z0 indicate the position of the text anchor as defined by @code{verticalalignment} and @code{horizontalalignment}.


@anchor{XREFtextrotation}
@cindex text rotation
@item @code{rotation}: scalar, def. @code{0}
The angle of rotation for the displayed text, measured in degrees.


@anchor{XREFtextselected}
@cindex text selected
@item @code{selected}: @{@qcode{"off"}@} | @qcode{"on"}



@anchor{XREFtextselectionhighlight}
@cindex text selectionhighlight
@item @code{selectionhighlight}: @qcode{"off"} | @{@qcode{"on"}@}



@anchor{XREFtextstring}
@cindex text string
@item @code{string}: string, def. @qcode{""}
The text object string content.


@anchor{XREFtexttag}
@cindex text tag
@item @code{tag}: string, def. @qcode{""}
A user-defined string to label the graphics object.


@anchor{XREFtexttype}
@cindex text type
@item @code{type} (read-only): string
Class name of the graphics object.  @code{type} is always @qcode{"text"}


@anchor{XREFtextuicontextmenu}
@cindex text uicontextmenu
@item @code{uicontextmenu}: graphics handle, def. @code{[](0x0)}
Graphics handle of the uicontextmenu object that is currently associated to this text object.


@anchor{XREFtextunits}
@cindex text units
@item @code{units}: @qcode{"centimeters"} | @{@qcode{"data"}@} | @qcode{"inches"} | @qcode{"normalized"} | @qcode{"pixels"} | @qcode{"points"}



@anchor{XREFtextuserdata}
@cindex text userdata
@item @code{userdata}: Any Octave data, def. @code{[](0x0)}
User-defined data to associate with the graphics object.


@anchor{XREFtextverticalalignment}
@cindex text verticalalignment
@item @code{verticalalignment}: @qcode{"baseline"} | @qcode{"bottom"} | @qcode{"cap"} | @{@qcode{"middle"}@} | @qcode{"top"}



@anchor{XREFtextvisible}
@cindex text visible
@item @code{visible}: @qcode{"off"} | @{@qcode{"on"}@}
If @code{visible} is @qcode{"off"}, the text is not rendered on screen.

@end table