File: plot-imageproperties.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 (188 lines) | stat: -rw-r--r-- 5,597 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
@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{XREFimage__modified__}
@cindex image __modified__
@item @code{__modified__}: @qcode{"off"} | @{@qcode{"on"}@}



@anchor{XREFimagealphadata}
@cindex image alphadata
@item @code{alphadata}: scalar | matrix, def. @code{1}
Transparency is not yet implemented for image objects.  @code{alphadata} is unused.


@anchor{XREFimagealphadatamapping}
@cindex image alphadatamapping
@item @code{alphadatamapping}: @qcode{"direct"} | @{@qcode{"none"}@} | @qcode{"scaled"}
Transparency is not yet implemented for image objects.  @code{alphadatamapping} is unused.


@anchor{XREFimagebeingdeleted}
@cindex image beingdeleted
@item @code{beingdeleted}: @{@qcode{"off"}@} | @qcode{"on"}



@anchor{XREFimagebusyaction}
@cindex image busyaction
@item @code{busyaction}: @qcode{"cancel"} | @{@qcode{"queue"}@}



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



@anchor{XREFimagecdata}
@cindex image cdata
@item @code{cdata}: matrix, def. 64-by-64 double



@anchor{XREFimagecdatamapping}
@cindex image cdatamapping
@item @code{cdatamapping}: @{@qcode{"direct"}@} | @qcode{"scaled"}



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


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


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


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


@anchor{XREFimagedisplayname}
@cindex image displayname
@item @code{displayname}: string | cell array of strings, def. @qcode{""}
Text for the legend entry corresponding to this image.


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


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


@anchor{XREFimagehittest}
@cindex image hittest
@item @code{hittest}: @qcode{"off"} | @{@qcode{"on"}@}



@anchor{XREFimageinterruptible}
@cindex image interruptible
@item @code{interruptible}: @qcode{"off"} | @{@qcode{"on"}@}



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


@anchor{XREFimageselected}
@cindex image selected
@item @code{selected}: @{@qcode{"off"}@} | @qcode{"on"}



@anchor{XREFimageselectionhighlight}
@cindex image selectionhighlight
@item @code{selectionhighlight}: @qcode{"off"} | @{@qcode{"on"}@}



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


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


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


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


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


@anchor{XREFimagexdata}
@cindex image xdata
@item @code{xdata}: two-element vector, def. @code{[1   64]}
Two-element vector @code{[xmin xmax]} specifying the x coordinates of the first and last columns of the image.

Setting @code{xdata} to the empty matrix ([]) will restore the default value of @code{[1 columns(image)]}.


@anchor{XREFimageydata}
@cindex image ydata
@item @code{ydata}: two-element vector, def. @code{[1   64]}
Two-element vector @code{[ymin ymax]} specifying the y coordinates of the first and last rows of the image.

Setting @code{ydata} to the empty matrix ([]) will restore the default value of @code{[1 rows(image)]}.

@end table