File: Managing-Default-Properties.html

package info (click to toggle)
octave 3.8.2-4
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 84,396 kB
  • ctags: 45,547
  • sloc: cpp: 293,356; ansic: 42,041; fortran: 23,669; sh: 13,629; objc: 7,890; yacc: 7,093; lex: 3,442; java: 2,125; makefile: 1,589; perl: 1,009; awk: 974; xml: 34
file content (164 lines) | stat: -rw-r--r-- 7,383 bytes parent folder | download | duplicates (3)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<head>
<title>GNU Octave: Managing Default Properties</title>

<meta name="description" content="GNU Octave: Managing Default Properties">
<meta name="keywords" content="GNU Octave: Managing Default Properties">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Graphics-Data-Structures.html#Graphics-Data-Structures" rel="up" title="Graphics Data Structures">
<link href="Advanced-Plotting.html#Advanced-Plotting" rel="next" title="Advanced Plotting">
<link href="Searching-Properties.html#Searching-Properties" rel="prev" title="Searching Properties">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {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}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="Managing-Default-Properties"></a>
<div class="header">
<p>
Previous: <a href="Searching-Properties.html#Searching-Properties" accesskey="p" rel="prev">Searching Properties</a>, Up: <a href="Graphics-Data-Structures.html#Graphics-Data-Structures" accesskey="u" rel="up">Graphics Data Structures</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Managing-Default-Properties-1"></a>
<h4 class="subsection">15.3.5 Managing Default Properties</h4>
<a name="index-default-graphics-properties"></a>
<a name="index-graphics-properties_002c-default"></a>

<p>Object properties have two classes of default values, <em>factory
defaults</em> (the initial values) and <em>user-defined defaults</em>, which
may override the factory defaults.
</p>
<p>Although default values may be set for any object, they are set in
parent objects and apply to child objects, of the specified object type.
For example, setting the default <code>color</code> property of <code>line</code>
objects to <code>&quot;green&quot;</code>, for the <code>root</code> object, will result in all
<code>line</code> objects inheriting the <code>color</code> <code>&quot;green&quot;</code> as the default
value.
</p>
<div class="example">
<pre class="example">set (0, &quot;defaultlinecolor&quot;, &quot;green&quot;);
</pre></div>

<p>sets the default line color for all objects.  The rule for constructing
the property name to set a default value is
</p>
<div class="example">
<pre class="example">default + <var>object-type</var> + <var>property-name</var>
</pre></div>

<p>This rule can lead to some strange looking names, for example
<code>defaultlinelinewidth&quot;</code> specifies the default <code>linewidth</code>
property for <code>line</code> objects.
</p>
<p>The example above used the root figure object, 0, so the default
property value will apply to all line objects.  However, default values
are hierarchical, so defaults set in a figure objects override those
set in the root figure object.  Likewise, defaults set in axes objects
override those set in figure or root figure objects.  For example,
</p>
<div class="example">
<pre class="example">subplot (2, 1, 1);
set (0, &quot;defaultlinecolor&quot;, &quot;red&quot;);
set (1, &quot;defaultlinecolor&quot;, &quot;green&quot;);
set (gca (), &quot;defaultlinecolor&quot;, &quot;blue&quot;);
line (1:10, rand (1, 10));
subplot (2, 1, 2);
line (1:10, rand (1, 10));
figure (2)
line (1:10, rand (1, 10));
</pre></div>

<p>produces two figures.  The line in first subplot window of the first
figure is blue because it inherits its color from its parent axes
object.  The line in the second subplot window of the first figure is
green because it inherits its color from its parent figure object.  The
line in the second figure window is red because it inherits its color
from the global root figure parent object.
</p>
<p>To remove a user-defined default setting, set the default property to
the value <code>&quot;remove&quot;</code>.  For example,
</p>
<div class="example">
<pre class="example">set (gca (), &quot;defaultlinecolor&quot;, &quot;remove&quot;);
</pre></div>

<p>removes the user-defined default line color setting from the current axes
object.  To quickly remove all user-defined defaults use the <code>reset</code>
function.
</p>
<a name="XREFreset"></a><dl>
<dt><a name="index-reset"></a>Built-in Function: <em></em> <strong>reset</strong> <em>(<var>h</var>, <var>property</var>)</em></dt>
<dd><p>Remove any defaults set for the handle <var>h</var>.  The default figure
properties of <code>&quot;position&quot;</code>, <code>&quot;units&quot;</code>,
<code>&quot;windowstyle&quot;</code> and <code>&quot;paperunits&quot;</code> and the default axes
properties of <code>&quot;position&quot;</code> and <code>&quot;units&quot;</code> are not reset.
</p>
<p><strong>See also:</strong> <a href="Manipulation-of-Plot-Windows.html#XREFcla">cla</a>, <a href="Manipulation-of-Plot-Windows.html#XREFclf">clf</a>.
</p></dd></dl>


<p>Getting the <code>&quot;default&quot;</code> property of an object returns a list of
user-defined defaults set for the object.  For example,
</p>
<div class="example">
<pre class="example">get (gca (), &quot;default&quot;);
</pre></div>

<p>returns a list of user-defined default values for the current axes
object.
</p>
<p>Factory default values are stored in the root figure object.  The
command
</p>
<div class="example">
<pre class="example">get (0, &quot;factory&quot;);
</pre></div>

<p>returns a list of factory defaults.
</p>
<hr>
<div class="header">
<p>
Previous: <a href="Searching-Properties.html#Searching-Properties" accesskey="p" rel="prev">Searching Properties</a>, Up: <a href="Graphics-Data-Structures.html#Graphics-Data-Structures" accesskey="u" rel="up">Graphics Data Structures</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>