source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DESSINE/sbar_plot.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 5.8 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>sbar_plot.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="sbar_plot.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/DESSINE//sbar_plot.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="pltz.html">&lt;&lt;prev file</a> | <a href="scontour.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="sbar_plot.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/DESSINE/</a></h1>
82      <h2 class="pro_file">sbar_plot.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Same thing that bar_plot but compatible with the whole environment
91 (<a href="../../..//Obsolete/common.html">common</a> included)
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_sbar_plot">
106
107          <h2><a class="top" href="#container">top</a>sbar_plot <span class="categories"> Graphics
108</span></h2>
109       
110          <p class="header">
111            sbar_plot<span class="result">, <a href="#_sbar_plot_param_values">values</a></span>, <a href="#_sbar_plot_keyword_COLORS">COLORS</a>=<span class="result">integer</span>, <a href="#_sbar_plot_keyword_NOREINITPLT">NOREINITPLT</a>=<span class="result">NOREINITPLT</span>, <a href="#_sbar_plot_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
112       
113          <div class="comments">
114</div>
115
116         
117
118         
119            <h3>Parameters</h3>
120       
121           
122            <h4 id="_sbar_plot_param_values">values&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123             
124             
125             
126             
127             
128             
129             
130             
131            </h4>
132       
133          <div class="comments"></div>
134           
135
136         
137
138         
139
140            <h3>Keywords</h3>
141           
142            <h4 id="_sbar_plot_keyword_COLORS">COLORS&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
143             
144             
145             
146             
147             
148              <span class="attr">type:</span> <span class="value">integer</span>
149             
150             
151            </h4>
152       
153            <div class="comments">
154 A vector, the same size as VALUES, containing the color index
155 to be used for each bar.  If not specified, the colors are
156 selected based on spacing the color indices as widely as
157 possible within the available colors (specified by D.N_COLORS).
158
159
160 I gives color of all colorbars. (contrarily to colors
161 which is a vector giving the color of each colorbar).
162</div>
163           
164            <h4 id="_sbar_plot_keyword_NOREINITPLT">NOREINITPLT&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
165             
166             
167             
168             
169             
170             
171             
172             
173            </h4>
174       
175            <div class="comments">
176 We active it if we do not want environment variables !p, !x, !y, !z
177 to be reinitialized by the procedure <a href="../../..//ToBeReviewed/PLOTS/reinitplt.html">reinitplt</a>
178</div>
179           
180            <h4 id="_sbar_plot_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
181             
182             
183             
184             
185             
186             
187             
188             
189            </h4>
190       
191            <div class="comments">
192 Used to pass keyword
193</div>
194           
195         
196
197          <h3>Examples</h3><div class="preformat">
198
199   IDL> sbar_plot, indgen(10),small = [2,2,2],/rempli
200   IDL> sbar_plot, indgen(10),small = [2,2,3],/noerase
201   IDL> @ps
202</div>
203          <h3>Version history</h3>
204         
205          <h4>Version</h4><div class="preformat">
206 $Id: sbar_plot.pro 370 2008-08-07 07:59:15Z pinsard $
207</div>
208          <h4>History</h4><div class="preformat">
209 Sebastien Masson (smasson@lodyc.jussieu.fr)
210                      10/10/1999
211</div>
212         
213         
214          <h3>Known issues</h3>
215         
216         
217         
218          <h4>Restrictions</h4><div class="preformat">
219 If NOREINITPLT is not activated, all environment
220 variables !p, !x, !y, !z are reinitialized by the procedure <a href="../../..//ToBeReviewed/PLOTS/reinitplt.html">reinitplt</a>
221</div>
222       
223          <h3>Other attributes</h3>
224         
225         
226          <h4>Uses routines</h4><div class="preformat">
227 <a href="../../..//Obsolete/common.html">common</a>
228</div>
229         
230         
231         
232       
233          <h3>Statistics</h3>
234          <table class="statistics">
235            <tr><td>McCabe cyclic</td><td>           5</td></tr>
236            <tr><td>McCabe essential</td><td>           1</td></tr>
237            <tr><td>McCabe modular design</td><td>           1</td></tr>
238          </table>
239         
240       
241        </div>
242       
243      </div>
244
245     
246
247      <div id="tagline">Produced by IDLdoc 2.0.</div>
248
249    </div>
250
251  </body>
252</html>
Note: See TracBrowser for help on using the repository browser.