File: plot-rootproperties.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 (256 lines) | stat: -rw-r--r-- 7,420 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
@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{XREFroot__modified__}
@cindex root __modified__
@item @code{__modified__}: @qcode{"off"} | @{@qcode{"on"}@}



@anchor{XREFrootbeingdeleted}
@cindex root beingdeleted
@item @code{beingdeleted}: @{@qcode{"off"}@} | @qcode{"on"}
@code{beingdeleted} is unused.


@anchor{XREFrootbusyaction}
@cindex root busyaction
@item @code{busyaction}: @qcode{"cancel"} | @{@qcode{"queue"}@}
@code{busyaction} is unused.


@anchor{XREFrootbuttondownfcn}
@cindex root buttondownfcn
@item @code{buttondownfcn}: string | function handle, def. @code{[](0x0)}
@code{buttondownfcn} is unused.


@anchor{XREFrootcallbackobject}
@cindex root callbackobject
@item @code{callbackobject} (read-only): graphics handle, def. @code{[](0x0)}



@anchor{XREFrootchildren}
@cindex root children
@item @code{children} (read-only): vector of graphics handles, def. @code{[](0x1)}
Graphics handles of the root's children.


@anchor{XREFrootclipping}
@cindex root clipping
@item @code{clipping}: @qcode{"off"} | @{@qcode{"on"}@}
@code{clipping} is unused.


@anchor{XREFrootcommandwindowsize}
@cindex root commandwindowsize
@item @code{commandwindowsize} (read-only): def. @code{[0   0]}



@anchor{XREFrootcreatefcn}
@cindex root createfcn
@item @code{createfcn}: string | function handle, def. @code{[](0x0)}
@code{createfcn} is unused.


@anchor{XREFrootcurrentfigure}
@cindex root currentfigure
@item @code{currentfigure}: graphics handle, def. @code{[](0x0)}
Graphics handle of the current figure.


@anchor{XREFrootdeletefcn}
@cindex root deletefcn
@item @code{deletefcn}: string | function handle, def. @code{[](0x0)}
@code{deletefcn} is unused.


@anchor{XREFrootdiary}
@cindex root diary
@item @code{diary}: @{@qcode{"off"}@} | @qcode{"on"}
If @code{diary} is @qcode{"on"}, the Octave command window session is saved to file.  @xref{XREFrootdiaryfile, , @w{diaryfile property}}.


@anchor{XREFrootdiaryfile}
@cindex root diaryfile
@item @code{diaryfile}: string, def. @qcode{"diary"}
The name of the diary file.  @xref{XREFdiary, , @w{diary function}}.


@anchor{XREFrootecho}
@cindex root echo
@item @code{echo}: @{@qcode{"off"}@} | @qcode{"on"}
Control whether Octave displays commands executed from scripts.  @xref{XREFecho, , @w{echo function}}.


@anchor{XREFrooterrormessage}
@cindex root errormessage
@item @code{errormessage} (read-only): string, def. @qcode{""}
The last error message raised.  @xref{XREFlasterr, , @w{lasterr function}}.


@anchor{XREFrootfixedwidthfontname}
@cindex root fixedwidthfontname
@item @code{fixedwidthfontname}: string, def. @qcode{"Courier"}



@anchor{XREFrootformat}
@cindex root format
@item @code{format}: @qcode{"+"} | @qcode{"bank"} | @qcode{"bit"} | @qcode{"hex"} | @qcode{"long"} | @qcode{"longe"} | @qcode{"longeng"} | @qcode{"longg"} | @qcode{"native-bit"} | @qcode{"native-hex"} | @qcode{"none"} | @qcode{"rat"} | @{@qcode{"short"}@} | @qcode{"shorte"} | @qcode{"shorteng"} | @qcode{"shortg"}
This property is a wrapper around the @code{format} function.  @xref{XREFformat, , @w{format function}}.


@anchor{XREFrootformatspacing}
@cindex root formatspacing
@item @code{formatspacing}: @qcode{"compact"} | @{@qcode{"loose"}@}
This property is a wrapper around the @code{format} function.  @xref{XREFformat, , @w{format function}}.


@anchor{XREFroothandlevisibility}
@cindex root handlevisibility
@item @code{handlevisibility}: @qcode{"callback"} | @qcode{"off"} | @{@qcode{"on"}@}
@code{handlevisibility} is unused.


@anchor{XREFroothittest}
@cindex root hittest
@item @code{hittest}: @qcode{"off"} | @{@qcode{"on"}@}
@code{hittest} is unused.


@anchor{XREFrootinterruptible}
@cindex root interruptible
@item @code{interruptible}: @qcode{"off"} | @{@qcode{"on"}@}
@code{interruptible} is unused.


@anchor{XREFrootlanguage}
@cindex root language
@item @code{language}: string, def. @qcode{"ascii"}



@anchor{XREFrootmonitorpositions}
@cindex root monitorpositions
@item @code{monitorpositions}:
@code{monitorpositions} is unused.


@anchor{XREFrootparent}
@cindex root parent
@item @code{parent}: graphics handle, def. @code{[](0x0)}
Root figure has no parent graphics object.  @code{parent} is always empty.


@anchor{XREFrootpointerlocation}
@cindex root pointerlocation
@item @code{pointerlocation}: two-element vector, def. @code{[0   0]}
@code{pointerlocation} is unused.


@anchor{XREFrootpointerwindow}
@cindex root pointerwindow
@item @code{pointerwindow} (read-only): graphics handle, def. @code{0}
@code{pointerwindow} is unused.


@anchor{XREFrootrecursionlimit}
@cindex root recursionlimit
@item @code{recursionlimit}: double, def. @code{256}
The maximum number of times a function can be called recursively.  @xref{XREFmax_recursion_depth, , @w{max_recursion_depth function}}.


@anchor{XREFrootscreendepth}
@cindex root screendepth
@item @code{screendepth} (read-only): double



@anchor{XREFrootscreenpixelsperinch}
@cindex root screenpixelsperinch
@item @code{screenpixelsperinch} (read-only): double



@anchor{XREFrootscreensize}
@cindex root screensize
@item @code{screensize} (read-only): four-element vector



@anchor{XREFrootselected}
@cindex root selected
@item @code{selected}: @{@qcode{"off"}@} | @qcode{"on"}
@code{selected} is unused.


@anchor{XREFrootselectionhighlight}
@cindex root selectionhighlight
@item @code{selectionhighlight}: @qcode{"off"} | @{@qcode{"on"}@}
@code{selectionhighlight} is unused.


@anchor{XREFrootshowhiddenhandles}
@cindex root showhiddenhandles
@item @code{showhiddenhandles}: @{@qcode{"off"}@} | @qcode{"on"}
If @code{showhiddenhandles} is @qcode{"on"}, all graphics objects handles are visible in their parents' children list, regardless of the value of their @code{handlevisibility} property.


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


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


@anchor{XREFrootuicontextmenu}
@cindex root uicontextmenu
@item @code{uicontextmenu}: graphics handle, def. @code{[](0x0)}
@code{uicontextmenu} is unused.


@anchor{XREFrootunits}
@cindex root units
@item @code{units}: @qcode{"centimeters"} | @qcode{"inches"} | @qcode{"normalized"} | @{@qcode{"pixels"}@} | @qcode{"points"}



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


@anchor{XREFrootvisible}
@cindex root visible
@item @code{visible}: @qcode{"off"} | @{@qcode{"on"}@}
@code{visible} is unused.

@end table