source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/PLOTS/legende.html @ 338

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

update documentation

File size: 6.0 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>legende.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="axe.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="plotsym.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/PLOTS/</font></h1>
58    <h2>legende.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Provide caption
65
66
67   
68
69     
70      <a name="#_legende"></a>
71
72      <h2>legende  <font size="-1" color="#006633">
73 Graphics
74</font></h2>
75
76      <p><font face="Courier">legende<i>, <a href="#_legende_keyword_mi">mi</a>, <a href="#_legende_keyword_ma">ma</a>, <a href="#_legende_keyword_coupe">coupe</a></i>, <a href="#_legende_keyword_CONTOUR">CONTOUR</a>=<i>CONTOUR</i>, <a href="#_legende_keyword_ENDPOINTS">ENDPOINTS</a>=<i>ENDPOINTS</i>, <a href="#_legende_keyword_DIREC">DIREC</a>=<i>DIREC</i>, <a href="#_legende_keyword_VECTLEGENDE">VECTLEGENDE</a>=<i>VECTLEGENDE</i>, <a href="#_legende_keyword_INTERVALLE">INTERVALLE</a>=<i>INTERVALLE</i>, <a href="#_legende_keyword_TYPE_YZ">TYPE_YZ</a>=<i>TYPE_YZ</i>, <a href="#_legende_keyword_VARNAME2">VARNAME2</a>=<i>VARNAME2</i>, <a href="#_legende_keyword_NPTS">NPTS</a>=<i>NPTS</i>, <a href="#_legende_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i></font></p>
77
78   
79
80
81   
82
83   
84    <h3>Parameters</h3>
85   
86
87    <a name="#_legende_keyword_mi"></a>
88    <h4>mi&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
89      <font size="-1" color="#006633">in</font>
90     
91     
92      <font size="-1" color="#006633">required</font>
93     
94     
95     
96     
97    </h4>
98
99   
100 The min of the drawing
101
102   
103
104    <a name="#_legende_keyword_ma"></a>
105    <h4>ma&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
106      <font size="-1" color="#006633">in</font>
107     
108     
109      <font size="-1" color="#006633">required</font>
110     
111     
112     
113     
114    </h4>
115
116   
117 The max of the plot
118
119   
120
121    <a name="#_legende_keyword_coupe"></a>
122    <h4>coupe&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123     
124     
125     
126     
127     
128      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string</i></font>
129     
130     
131    </h4>
132
133   
134 Character containing two letters giving the type of the cut  (for example: 'xz').
135
136   
137   
138
139   
140    <h3>Keywords</h3>
141
142   
143    <a name="#_legende_keyword_CONTOUR"></a>
144    <h4>CONTOUR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
145     
146     
147     
148     
149     
150     
151     
152     
153    </h4>
154
155   
156 If we want to trace contours of a different field than the one
157 whose we have the colored drawing (by example E-P in color and QSR in contours).
158 It must be a field respecting same characteristics than the argument number one of plt.
159
160   
161    <a name="#_legende_keyword_ENDPOINTS"></a>
162    <h4>ENDPOINTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163     
164     
165     
166     
167     
168     
169     
170     
171    </h4>
172
173   
174 Used when we do vertical cuts in diagonal.
175
176   
177    <a name="#_legende_keyword_DIREC"></a>
178    <h4>DIREC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
179     
180     
181     
182     
183     
184     
185     
186     
187    </h4>
188
189   
190   
191    <a name="#_legende_keyword_VECTLEGENDE"></a>
192    <h4>VECTLEGENDE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
193     
194     
195     
196     
197     
198     
199     
200     
201    </h4>
202
203   
204   
205    <a name="#_legende_keyword_INTERVALLE"></a>
206    <h4>INTERVALLE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
207     
208     
209     
210     
211     
212     
213     
214     
215    </h4>
216
217   
218   
219    <a name="#_legende_keyword_TYPE_YZ"></a>
220    <h4>TYPE_YZ&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
221     
222     
223     
224     
225     
226     
227     
228     
229    </h4>
230
231   
232   
233    <a name="#_legende_keyword_VARNAME2"></a>
234    <h4>VARNAME2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
235     
236     
237     
238     
239     
240     
241     
242     
243    </h4>
244
245   
246   
247    <a name="#_legende_keyword_NPTS"></a>
248    <h4>NPTS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
249     
250     
251     
252     
253     
254     
255     
256     
257    </h4>
258
259   
260   
261    <a name="#_legende_keyword__EXTRA"></a>
262    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
263     
264     
265     
266     
267     
268     
269     
270     
271    </h4>
272
273   
274 Used to pass keywords
275
276   
277   
278
279   
280    </pre><h3>Version history</h3>
281   
282    <h4>Version</h4>
283 $Id: legende.pro 327 2007-12-13 16:22:35Z pinsard $
284
285    <h4>History</h4>
286  Sebastien Masson (smasson@lodyc.jussieu.fr)
287                        14/8/98
288                       Eric Guilyardi (ericg@lodyc.jussieu.fr) GB version
289                        11/6/99
290
291   
292
293    <h3>Known issues</h3>
294   
295   
296   
297    <h4>Restrictions</h4>
298 The use of the global variable language allows to change the language and the caption easily.
299
300
301    <h3>Other attributes</h3>
302   
303   
304    <h4>Uses routines</h4>
305 common.pro
306
307   
308   
309   
310
311    <font size="-3"><p>&nbsp;</p></font>
312    <hr size="1" color="#CCCCCC"/>
313     
314
315   
316
317    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
318
319  </body>
320</html>
Note: See TracBrowser for help on using the repository browser.