File: Application_002ddefined-Data.html

package info (click to toggle)
octave 6.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 124,192 kB
  • sloc: cpp: 322,665; ansic: 68,088; fortran: 20,980; objc: 8,121; sh: 7,719; yacc: 4,266; lex: 4,123; perl: 1,530; java: 1,366; awk: 1,257; makefile: 424; xml: 147
file content (124 lines) | stat: -rw-r--r-- 7,279 bytes parent folder | download
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.7, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Application-defined Data (GNU Octave (version 6.2.0))</title>

<meta name="description" content="Application-defined Data (GNU Octave (version 6.2.0))">
<meta name="keywords" content="Application-defined Data (GNU Octave (version 6.2.0))">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<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="Advanced-Plotting.html" rel="up" title="Advanced Plotting">
<link href="Object-Groups.html" rel="next" title="Object Groups">
<link href="Callbacks.html" rel="prev" title="Callbacks">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {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}
ul.no-bullet {list-style: none}
-->
</style>
<link rel="stylesheet" type="text/css" href="octave.css">


</head>

<body lang="en">
<span id="Application_002ddefined-Data"></span><div class="header">
<p>
Next: <a href="Object-Groups.html" accesskey="n" rel="next">Object Groups</a>, Previous: <a href="Callbacks.html" accesskey="p" rel="prev">Callbacks</a>, Up: <a href="Advanced-Plotting.html" accesskey="u" rel="up">Advanced Plotting</a> &nbsp; [<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="Application_002ddefined-Data-1"></span><h4 class="subsection">15.4.5 Application-defined Data</h4>
<span id="index-application_002ddefined-data"></span>

<p>Octave has a provision for attaching application-defined data to a graphics
handle.  The data can be anything which is meaningful to the application, and
will be completely ignored by Octave.
</p>
<span id="XREFsetappdata"></span><dl>
<dt id="index-setappdata">: <em></em> <strong>setappdata</strong> <em>(<var>h</var>, <var>name</var>, <var>value</var>)</em></dt>
<dt id="index-setappdata-1">: <em></em> <strong>setappdata</strong> <em>(<var>h</var>, <var>name1</var>, <var>value1</var>, <var>name2</var>, <var>value3</var>, &hellip;)</em></dt>
<dt id="index-setappdata-2">: <em></em> <strong>setappdata</strong> <em>(<var>h</var>, {<var>name1</var>, <var>name2</var>, &hellip;}, {<var>value1</var>, <var>value2</var>, &hellip;})</em></dt>
<dd><p>Set the application data <var>name</var> to <var>value</var> for the graphics object
with handle <var>h</var>.
</p>
<p><var>h</var> may also be a vector of graphics handles.  If the application data
with the specified <var>name</var> does not exist, it is created.
</p>
<p>Multiple <var>name</var>/<var>value</var> pairs can be specified.  Alternatively, a
cell array of <var>names</var> and a corresponding cell array of <var>values</var> can
be specified.  Details on obtaining a list of valid application data
properties can be found in <a href="#XREFgetappdata">getappdata</a>.
</p>

<p><strong>See also:</strong> <a href="#XREFgetappdata">getappdata</a>, <a href="#XREFisappdata">isappdata</a>, <a href="#XREFrmappdata">rmappdata</a>, <a href="GUI-Utility-Functions.html#XREFguidata">guidata</a>, <a href="Graphics-Objects.html#XREFget">get</a>, <a href="Graphics-Objects.html#XREFset">set</a>, <a href="User_002dDefined-Preferences.html#XREFgetpref">getpref</a>, <a href="User_002dDefined-Preferences.html#XREFsetpref">setpref</a>.
</p></dd></dl>


<span id="XREFgetappdata"></span><dl>
<dt id="index-getappdata">: <em><var>value</var> =</em> <strong>getappdata</strong> <em>(<var>h</var>, <var>name</var>)</em></dt>
<dt id="index-getappdata-1">: <em><var>appdata</var> =</em> <strong>getappdata</strong> <em>(<var>h</var>)</em></dt>
<dd><p>Return the <var>value</var> of the application data <var>name</var> for the graphics
object with handle <var>h</var>.
</p>
<p><var>h</var> may also be a vector of graphics handles.  If no second argument
<var>name</var> is given then <code>getappdata</code> returns a structure,
<var>appdata</var>, whose fields correspond to the appdata properties.
</p>

<p><strong>See also:</strong> <a href="#XREFsetappdata">setappdata</a>, <a href="#XREFisappdata">isappdata</a>, <a href="#XREFrmappdata">rmappdata</a>, <a href="GUI-Utility-Functions.html#XREFguidata">guidata</a>, <a href="Graphics-Objects.html#XREFget">get</a>, <a href="Graphics-Objects.html#XREFset">set</a>, <a href="User_002dDefined-Preferences.html#XREFgetpref">getpref</a>, <a href="User_002dDefined-Preferences.html#XREFsetpref">setpref</a>.
</p></dd></dl>


<span id="XREFrmappdata"></span><dl>
<dt id="index-rmappdata">: <em></em> <strong>rmappdata</strong> <em>(<var>h</var>, <var>name</var>)</em></dt>
<dt id="index-rmappdata-1">: <em></em> <strong>rmappdata</strong> <em>(<var>h</var>, <var>name1</var>, <var>name2</var>, &hellip;)</em></dt>
<dd><p>Delete the application data <var>name</var> from the graphics object with handle
<var>h</var>.
</p>
<p><var>h</var> may also be a vector of graphics handles.  Multiple application data
names may be supplied to delete several properties at once.
</p>

<p><strong>See also:</strong> <a href="#XREFsetappdata">setappdata</a>, <a href="#XREFgetappdata">getappdata</a>, <a href="#XREFisappdata">isappdata</a>.
</p></dd></dl>


<span id="XREFisappdata"></span><dl>
<dt id="index-isappdata">: <em><var>valid</var> =</em> <strong>isappdata</strong> <em>(<var>h</var>, <var>name</var>)</em></dt>
<dd><p>Return true if the named application data, <var>name</var>, exists for the
graphics object with handle <var>h</var>.
</p>
<p><var>h</var> may also be a vector of graphics handles.
</p>
<p><strong>See also:</strong> <a href="#XREFgetappdata">getappdata</a>, <a href="#XREFsetappdata">setappdata</a>, <a href="#XREFrmappdata">rmappdata</a>, <a href="GUI-Utility-Functions.html#XREFguidata">guidata</a>, <a href="Graphics-Objects.html#XREFget">get</a>, <a href="Graphics-Objects.html#XREFset">set</a>, <a href="User_002dDefined-Preferences.html#XREFgetpref">getpref</a>, <a href="User_002dDefined-Preferences.html#XREFsetpref">setpref</a>.
</p></dd></dl>


<hr>
<div class="header">
<p>
Next: <a href="Object-Groups.html" accesskey="n" rel="next">Object Groups</a>, Previous: <a href="Callbacks.html" accesskey="p" rel="prev">Callbacks</a>, Up: <a href="Advanced-Plotting.html" accesskey="u" rel="up">Advanced Plotting</a> &nbsp; [<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>