source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/style.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 5.9 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>style.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="style.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../../ToBeReviewed/PLOTS//style.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="reinitplt.html">&lt;&lt;prev file</a> | <a href="symbols.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="style.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/PLOTS/</a></h1>
82      <h2 class="pro_file">style.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Choose the linestyle to trace iso-contour
91 (Will define the keywords c_linestyle and c_thick)
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_style">
106
107          <h2><a class="top" href="#container">top</a>style <span class="categories">
108 Graphics
109</span></h2>
110       
111          <p class="header">
112            style<span class="result">, <a href="#_style_param_labstyle">labstyle</a>, <a href="#_style_param_level_z2d">level_z2d</a>, <a href="#_style_param_linestyle">linestyle</a>, <a href="#_style_param_thick">thick</a></span></p>
113       
114          <div class="comments">
115</div>
116
117         
118
119         
120            <h3>Parameters</h3>
121       
122           
123            <h4 id="_style_param_labstyle">labstyle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
124              <span class="attr">in</span>
125             
126             
127              <span class="attr">required</span>
128             
129             
130             
131             
132            </h4>
133       
134          <div class="comments">
135
136 Two kind of labelstyle are accepted:
137
138 1) A number referring to the existing choices:
139    0 : Two thin continuous lines, one bold continuous line...
140    1 : before the middle of levels: thin dash. Then thin continuous
141        line. and bold for the middle
142    2 : Same as case 1 but threshold value is defined by the user
143        by answering a question
144    3 : Solid-Bold, solid-thin, dash Dot-thin, solid-thin, Solid-Bold...
145    4 : Solid-very-thin, except for contour O, that is solid-bold
146 2) for the labelstyle based on a threshold value (with a style
147before and after the threshold value and a bold solid line for the
148value itself, a more general definition can be given with a scalar
149string with the following structure: 'xxNN...NNyy' with 
150 xx and yy correspondind to one the following choices (with the corresponding meaning)
151                so -> Solid     
152                do -> Dotted   
153                da -> Dashed   
154                dd -> Dash Dot 
155                ld -> Long Dashes
156 and NN...NN any kind of number that will define the threshold value.
157 for example 'do-6.6so' will do dotted line until -6.6 and solid line after.
158        </div>
159           
160            <h4 id="_style_param_level_z2d">level_z2d&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
161              <span class="attr">in</span>
162             
163             
164              <span class="attr">required</span>
165             
166             
167             
168             
169            </h4>
170       
171          <div class="comments">
172 Vector containing values of isolignes to be traced.
173</div>
174           
175            <h4 id="_style_param_linestyle">linestyle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
176             
177              <span class="attr">out</span>
178             
179             
180             
181             
182             
183             
184            </h4>
185       
186          <div class="comments">
187 Used interbally by plt(z)(t) to define c_linestyle when calling pltbase.
188 Vector used to define the isocontour's style.
189</div>
190           
191            <h4 id="_style_param_thick">thick&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
192             
193              <span class="attr">out</span>
194             
195             
196             
197             
198             
199             
200            </h4>
201       
202          <div class="comments">
203 Used interbally by plt(z)(t) to define c_thick when calling pltbase.
204 Vector used to define the isocontour's thickness.
205</div>
206           
207
208         
209
210         
211
212         
213          <h3>Version history</h3>
214         
215          <h4>Version</h4><div class="preformat">
216 $Id: style.pro 325 2007-12-06 10:04:53Z pinsard $
217</div>
218          <h4>History</h4><div class="preformat">
219 Sebastien Masson (smasson@lodyc.jussieu.fr)
220 Oct 2007 revisiting...
221</div>
222         
223         
224         
225         
226         
227         
228         
229       
230         
231         
232         
233         
234         
235         
236         
237       
238          <h3>Statistics</h3>
239          <table class="statistics">
240            <tr><td>McCabe cyclic</td><td>          20</td></tr>
241            <tr><td>McCabe essential</td><td>           1</td></tr>
242            <tr><td>McCabe modular design</td><td>           1</td></tr>
243          </table>
244         
245       
246        </div>
247       
248      </div>
249
250     
251
252      <div id="tagline">Produced by IDLdoc 2.0.</div>
253
254    </div>
255
256  </body>
257</html>
Note: See TracBrowser for help on using the repository browser.