source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DESSINE/bar_plot.html @ 142

Last change on this file since 142 was 142, checked in by navarro, 18 years ago

english and nicer header (2a)

File size: 22.1 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>bar_plot.pro (SAXO Documentation)</title>
10
11   
12    <style type="text/css" media="all">
13     
14/* CSS for all files which appear in the "main" viewing area: overview,
15   directory overviews, warnings, index, search, pro files, source
16   code, help, and etc files. */
17
18/* Link styles --------------------------------------------------------------- */
19
20a { text-decoration: none; }
21
22a:link, a:visited { 
23  color: #660000; 
24  border-bottom: 1px dotted #C0C0F0;   
25}
26
27a:hover, a:focus { 
28  color: #993333; 
29  background: #FFFFCC; 
30  border-bottom: 1px dotted #303099; 
31}
32
33
34/* Main styles --------------------------------------------------------------- */
35
36body {
37  margin: 0;
38  padding: 0;
39  font-size: 10pt;
40  font-family: Verdana, Helvetica, Arial, sans-serif;
41  background-color: #FFFFFF;
42}
43
44p {
45  margin-top: 0.5em;
46  margin-bottom: 0;
47}
48
49#container { margin: 1em; }
50
51code.section { white-space: pre; }
52
53pre.snippet {
54  margin-left: 5%;
55  background: #F0F0F0;
56  border: 1px dashed #999999;
57  width: 43em;
58  padding: 0.5em 0.5em 0.5em 0.5em;
59  white-space: pre;
60}
61
62/* Navbar styles ------------------------------------------------------------- */
63
64#navbar_title {
65  color: #000033;
66  background-color: #F0F0FF;
67  font-family: Arial, Helvetica, sans-serif;
68  padding: 20px 30px;
69  border-bottom: 1px solid #000033;
70}
71
72#navbar_title * {
73  margin: 0;
74  padding: 0;
75}
76
77#navbar_title h1 {
78  letter-spacing: 0.1em;
79  font-variant: small-caps;
80  font-size: 250%;
81  text-indent: -1em;
82  padding-left: 1em; 
83}
84
85#navbar_title h2 {
86  font-size: 110%;
87  font-weight: normal;
88  color: #333399;
89}
90
91#main_navbar table {
92  width: 100%;
93  border-bottom: 1px solid #666699;
94}
95
96#main_navbar td {
97  background: #CCCCFF;
98  font-size: 80%;
99  font-weight: bold;
100  font-family: Arial, Helvetica, sans-serif;
101  border-top: 3px solid #CCCCFF;
102  border-bottom: 3px solid #CCCCFF;
103  padding-left: 6px;
104  padding-right: 6px;
105  margin: 0;
106}
107
108#main_navbar td#selected {
109  background: #CCCCFF;
110  font-size: 80%;
111  font-weight: bold;
112  font-family: Arial, Helvetica, sans-serif;
113  border-top: 3px solid #333399;
114  border-bottom: 3px solid #CCCCFF;
115  padding-left: 6px;
116  padding-right: 6px;
117  margin: 0;
118}
119
120#main_navbar td#flexible {
121  width: 100%;
122  text-align: right;
123  padding-right: 1em;
124  background: #CCCCFF;
125  font-size: 70%;
126  font-weight: normal;
127  font-family: Arial, Helvetica, sans-serif;
128  text-transform: uppercase;
129  border-top: 3px solid #CCCCFF;
130  border-bottom: 3px solid #CCCCFF;
131}
132
133#main_navbar a:link, #main_navbar a:visited { color: #660000; border: 0; }
134
135#main_navbar a:hover, #main_navbar a:focus {
136  color: #FFFF66;
137  background: #CCCCFF;
138  border-bottom: 1px none #606099; 
139  border: 0;
140}
141
142#secondary_navbar {
143  font-size: 80%;
144  font-weight: normal;
145  font-family: Arial, Helvetica, sans-serif;
146  margin-top: 4px;
147  margin-left: 20px;
148  white-space: nowrap;
149}
150
151
152/* Tagline and footer styles ------------------------------------------------- */
153
154div#tagline {
155  margin-top: 6px;
156  border-top: 1px dotted lightsteelblue;
157  padding-top: 6px;
158  font-size: 66%;
159  font-style: italic;
160}
161
162div#footer {
163  margin-top: 6px;
164  border-top: 1px dotted lightsteelblue;
165  padding-top: 6px;
166  font-size: 66%;
167  font-style: italic;
168}
169
170/* Basic data presenation styles -------------------------------------------- */
171
172.index_letter { 
173  font-size: 300%;
174  font-weight: bold;
175  color: #000066; 
176  margin: 0.5em 0 0 -0.1em;
177}
178
179h1, h2, h3, h4 {
180  font-weight: normal;
181  color: #3333CC;
182}
183
184h1 {
185  padding-top: 0.75em;
186  font-size: 160%;
187}
188
189h2 {
190  padding-top: 1em;
191  font-size: 120%;
192  }
193
194h3 {
195  padding-top: 0.75em;
196  margin-bottom: 0.25em;
197  font-size: 100%;
198}
199
200h4 {
201  padding: 0;
202  margin: 0.5em 0 0 0;
203  font-size: 80%;
204}
205
206table.basic {
207  empty-cells: show;
208  margin: 1.5em 1em 0 1em;
209  border: 1px dotted #CFCFFF;
210  font-size: 80%;
211}
212
213table.basic th {
214  background-color: #F0F0FF;
215  font-weight: bold;
216  text-align: left;
217  padding: 4px 1em 4px 4px;
218  border-bottom: 1px dotted #666699;
219}
220
221table.basic td {
222  vertical-align: top;
223  padding: 4px 1em 4px 4px;
224}
225
226dd {
227  margin-bottom: 0.25em;
228  font-size: 80%;
229}
230
231
232/* Warnings styles ----------------------------------------------------------- */
233
234
235#todo dl, #bugs dl { 
236  margin: 0 0 0 1.5em;
237  font-size: 80%;
238}
239
240#todo dd, #bugs dd { 
241  margin-left: 3em; 
242  font-size: 100%;
243}
244
245#undoc table, #obsolete table, #statistics table {
246  width: 80%;
247  margin-left: 2em;
248}
249
250#undoc td, #obsolete td, #statistics td { 
251  padding: 0 0 0 0;
252  font-size: 80%;
253  white-space: nowrap;
254}
255
256#undoc td.docroutine, #obsolete td.obsroutine, #statistics td.statroutine { width: 50%; }
257
258#undoc td.docstat, #statistics td.stat { 
259  width: 50%;
260  text-align: right;
261}
262
263#undoc td.partialdoc, #statistics td.caution { color: #CC6600; }
264
265#undoc td.notdoc, #statistics td.warning { color: #993333; }
266
267/* File + routine styles ----------------------------------------------------- */
268
269h1.directory { 
270  padding: 1em 0 0 0;
271  margin: 0;
272  font-size: 66%;
273}
274
275h1.directory a { border-bottom: 0; }
276
277h2.pro_file { 
278  padding: 0;
279  margin: 0;
280  font-size: 140%;
281}
282
283div#file_attr {
284  padding: 0 1em 0 1em;
285  margin: 1em;
286  background: #F6F6F6;
287  border: 1px dotted #999999;
288}
289
290div#file_attr dt {
291  font-size: 80%;
292  font-weight: bold;
293}
294
295div#file_attr dd {
296  font-size: 80%;
297}
298
299div#class_diagram { 
300  padding: 1em 0 1em 0; 
301  white-space: pre;
302  font-family: 'Courier New';
303}
304
305table#sav_attr { 
306  font-size: 90%; 
307  margin: 1em; 
308  padding: 1em 1em 1em 1em;
309  background: #F6F6F6;
310  border: 1px dotted #999999;
311}
312
313table#sav_attr th { text-align: left; }
314
315table#sav_attr td { vertical-align: top; padding-right: 2em; }
316
317table#sav_attr td.value { width: 20em; padding-right: 0em; font-style: italic; }
318
319p.sav_warning { margin-left: 4em; font-family: 80%; }
320
321table.variables { 
322  font-family: 'Courier New', monospace; 
323  font-size: 80%; 
324  text-indent: -2em; 
325  padding-left: 2em; 
326}
327
328table.variables td.image { width: 64px; }
329
330div#file_comments { white-space: pre; 
331  margin: 2em;
332  font-size: 80%;
333}
334
335
336div.field_summary {
337  padding: 0 1em 0 1em;
338  margin: 1em;
339  background: #FFFFF0;
340  border: 1px dotted #C0C000;
341}
342
343div#routine_summary { 
344  padding: 0 1em 0 1em;
345  margin: 1em;
346  background: #F0F0FF;
347  border: 1px dotted #9999FF;
348}
349
350div.field_summary h2, div#routine_summary h2 { 
351  padding: 0.5em 0 0 0;
352  margin: 0;
353}
354
355div.field_summary table, div.field_summary p { 
356  margin: 1em 1em;
357}
358
359div.field_summary td.name { 
360  vertical-align: top;
361  padding-bottom: 0.25em;
362  color: #3333CC;
363}
364
365div.field_summary span.field_type { 
366  font-weight: normal;
367  font-size: 80%;
368  color: black;
369}
370
371div.field_summary td.comments { 
372  vertical-align: top;
373  padding-left: 2em;
374  font-size: 80%;
375}
376
377p.commaList { 
378  margin: 1em 1em 1em 1em;
379}
380
381span.warning { 
382  color: #CC6633;
383  font-weight: bold;
384  font-size: 66%;
385  text-transform: uppercase;
386}
387
388span.categories { 
389  color: #006633;
390  font-weight: bold;
391  font-size: 66%;
392  text-transform: uppercase;
393}
394
395span.undoc { 
396  color: #FF6633;
397  font-weight: bold;
398  font-size: 80%;
399  text-transform: uppercase;
400}
401
402span.attr { 
403  color: #006633;
404  font-weight: bold;
405  font-size: 80%;
406  text-transform: uppercase;
407}
408
409span.value { 
410  color: #006633;
411  font-weight: normal;
412  text-transform: none;
413}
414
415a.top { 
416  font-weight: bold;
417  font-size: 66%;
418  text-transform: uppercase;
419  float: right;
420}
421
422span.result { 
423  font-family: Verdana, Arial, Helvetica, sans-serif;
424  font-style: italic;
425  font-size: 80%;
426}
427
428div#routine_summary p, div.routine_details p.header { 
429  padding-top: 0.5em;
430  margin-left: 1.5em;
431  text-indent: -1.5em;
432  font-family: 'Courier New', monospace;
433}
434
435div.routine_details { 
436  padding: 0.5em 1em 0.5em 1em;
437  margin: 1em;
438  border: 1px dotted #CCCCCC;
439}
440
441div.routine_details h2 { 
442  padding-top: 0;
443  margin-top: 0;
444}
445
446div.routine_details div.value { 
447  margin: 0 1em 0 1em;
448  font-size: 80%;
449}
450
451div.routine_details div.comments { 
452  font-size: 80%;
453  margin: 0.75em 1em 1em 1em;
454}
455
456div.routine_details div.preformat { 
457  white-space: pre;
458}
459
460table.statistics { 
461  font-size: 80%;
462  margin-left: 1em;
463}
464
465table.statistics td { 
466  padding: 0 2em 0 0;
467}
468
469/* Overview styles ----------------------------------------------------------- */
470
471div.overview { 
472  width: 100%;
473  margin-top: 1em;
474  clear: both;
475}
476
477div.overview table {
478  empty-cells: show;
479  font-size: 90%;
480  margin: 1em 1em 1em 1em;
481  padding: 1em 0.5em 1em 0.5em;
482  background: #F6F6F6;
483  border: 1px dotted #999999;
484}
485
486div.overview td {
487  padding: 3px 1em 3px 1em;
488}
489
490div.overview td.dir {
491  width: 1%;
492  vertical-align: top;
493  text-align: right;
494  padding-right: 1em;
495}
496
497
498/* Navigation list styles for tree structures -------------------------------- */
499
500#tree {
501  text-align: left;
502  font-size: 90%;
503  margin: 0.75em 0 0.75em 0;
504  padding: 0;
505}
506
507#tree ul {
508  text-align: left;
509  margin: 0;
510  padding: 0;
511}
512
513#tree li {
514  margin: 0 0 0 15px;
515  padding: 0;
516  list-style-type: none;
517}
518
519#tree .symbols {
520  float: left;
521  width: 12px;
522  height: 1em;
523  padding-left: 4px;
524  background-position: 0 100%;
525  background-repeat: no-repeat;
526}
527
528/* Search styles ------------------------------------------------------------- */
529
530input.writein { 
531  padding-left: 0.5em;
532  border: 1px solid #CCCCCC;
533  font-family: 'Courier New';
534  background: #FFFFF3;
535}
536
537#search form { 
538  margin-left: 2em;
539}
540
541#search table { 
542  margin: 1em 1em 0 2em;
543  padding: 1em 2em 1em 2em;
544  background: #F6F6F6;
545  border: 1px dotted #999999;
546}
547
548#search tr { 
549  text-align: center;
550}
551
552#search td { 
553  font-size: 80%; 
554  text-align: left;
555}
556
557#search td * { 
558  vertical-align: middle;
559}
560
561#search p { 
562  font-size: 66%;
563  margin: 0 3em 2em 3em;
564}
565
566/* Help styles --------------------------------------------------------------- */
567
568div.toc { 
569  padding: 0 1em 0 1em;
570  margin: 1em;
571  background: #F0F0FF;
572  border: 1px dotted #9999FF; 
573  width: 19em;
574}
575
576div.right { 
577  float: right;
578  width: 22em;
579}
580
581ol.toc { 
582  list-style-type: upper-roman;
583}
584
585ol.toc ol { 
586  padding-left: 3em;
587  margin-left: 0;
588  list-style-type: lower-alpha;
589}
590
591dl.variables dt { font-size: 80%; }
592dl.variables dd { margin-bottom: 0.5em; }
593
594    </style>
595    <style type="text/css" media="print">
596      #navbar_title { 
597  background-color: #FFFFFF; 
598}
599
600#main_navbar td {
601  background: #FFFFFF;
602  border-top: 0.25em solid #FFFFFF;
603  border-bottom: 0.25em solid #FFFFFF;
604}
605
606#main_navbar td#selected {
607  background: #FFFFFF;
608  border-top: 0.25em solid #333399;
609  border-bottom: 0.25em solid #FFFFFF;
610}
611
612#main_navbar td#flexible {
613  background: #FFFFFF;
614  border-top: 0.25em solid #FFFFFF;
615  border-bottom: 0.25em solid #FFFFFF;
616}
617
618#secondary_navbar {
619  display: none;
620}
621
622    </style>
623   
624
625    <script type="text/javascript">
626      function setTitle() {
627        parent.document.title="bar_plot.pro (SAXO Documentation)";
628      }
629    </script>
630  </head>
631
632  <body onload="setTitle();">
633
634    <div id="navbar_title">
635  <h1>SAXO Documentation</h1>
636</div>
637
638
639<div id="main_navbar">
640
641  <table cellspacing="0">
642    <tr>
643     
644      <td><a href="./../../../overview.html?format=raw" title="Overview of library">Overview</a></td>
645     
646
647     
648      <td >Directory</td>
649     
650
651     
652      <td><a href="./../../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
653     
654
655     
656      <td><a href="./../../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
657     
658
659     
660      <td><a href="./../../../search-page.html?format=raw" title="Search library">Search</a></td>
661     
662
663      <td id="selected">File</td>
664
665     
666      <td >Source</td>
667     
668
669     
670      <td><a href="./../../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
671     
672
673      <td >Etc</td>
674
675      <td id="flexible">Developer&nbsp;documentation</td>
676    </tr>
677  </table>
678
679</div>
680
681<div id="secondary_navbar">
682
683&lt;&lt; prev file | <a href="plt.html?format=raw">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="bar_plot.html?format=raw" target="_TOP">view single page</a> | <a href="./../../../index.html?format=raw" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
684
685</div>
686
687
688    <div id="container">
689
690      <h1 class="directory"><a href="directory-overview.html?format=raw">ToBeReviewed/PLOTS/DESSINE/</a></h1>
691      <h2 class="pro_file">bar_plot.pro</h2>
692
693      <div id="file_attr">
694        <dl>
695        </dl>
696      </div>
697
698      <div id="file_comments"> 
699 Create a bar graph, or overplot on an existing one.
700</div>
701
702     
703
704     
705
706     
707
708     
709
710      <div id="routine_details">
711       
712
713        <div class="routine_details" id="_bar_plot">
714
715          <h2><a class="top" href="#container">top</a>bar_plot <span class="categories"> 
716 Graphics
717</span></h2>
718       
719          <p class="header">
720            bar_plot<span class="result">, <a href="#_bar_plot_param_values">values</a></span>, <a href="#_bar_plot_keyword_baselines">baselines</a>=<span class="result">baselines</span>, <a href="#_bar_plot_keyword_colors">colors</a>=<span class="result">colors</span>, <a href="#_bar_plot_keyword_barnames">barnames</a>=<span class="result">barnames</span>, <a href="#_bar_plot_keyword_title">title</a>=<span class="result">title</span>, <a href="#_bar_plot_keyword_xtitle">xtitle</a>=<span class="result">xtitle</span>, <a href="#_bar_plot_keyword_ytitle">ytitle</a>=<span class="result">ytitle</span>, <a href="#_bar_plot_keyword_baserange">baserange</a>=<span class="result">baserange</span>, <a href="#_bar_plot_keyword_barwidth">barwidth</a>=<span class="result">barwidth</span>, <a href="#_bar_plot_keyword_barspace">barspace</a>=<span class="result">barspace</span>, <a href="#_bar_plot_keyword_baroffset">baroffset</a>=<span class="result">baroffset</span>, <a href="#_bar_plot_keyword_outline">outline</a>=<span class="result">outline</span>, <a href="#_bar_plot_keyword_overplot">overplot</a>=<span class="result">overplot</span>, <a href="#_bar_plot_keyword_background">background</a>=<span class="result">background</span>, <a href="#_bar_plot_keyword_rotate">rotate</a>=<span class="result">rotate</span>, <a href="#_bar_plot_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
721       
722          <div class="comments">
723 </div>
724
725         
726
727         
728            <h3>Parameters</h3>
729       
730           
731            <h4 id="_bar_plot_param_values">values&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
732              <span class="attr">in</span>
733             
734             
735              <span class="attr">required</span>
736             
737             
738             
739             
740            </h4>
741       
742          <div class="comments"> 
743 A vector containing the values to be represented by the bars.
744 Each element in VALUES corresponds to a single bar in the
745 output.
746</div>
747           
748
749         
750
751         
752
753            <h3>Keywords</h3>
754           
755            <h4 id="_bar_plot_keyword_baselines">baselines&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
756             
757             
758             
759             
760             
761             
762             
763             
764            </h4>
765       
766            <div class="comments"> 
767 A vector, the same size as VALUES, that contains the
768 base value associated with each bar.  If not specified,
769 a base value of zero is used for all bars.
770</div>
771           
772            <h4 id="_bar_plot_keyword_colors">colors&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
773             
774             
775             
776             
777             
778             
779             
780             
781            </h4>
782       
783            <div class="comments"> 
784 A vector, the same size as VALUES, containing the color index
785 to be used for each bar.  If not specified, the colors are
786 selected based on spacing the color indices as widely as
787 possible within the available colors (specified by D.N_COLORS).
788</div>
789           
790            <h4 id="_bar_plot_keyword_barnames">barnames&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
791             
792             
793             
794             
795             
796             
797             
798             
799            </h4>
800       
801            <div class="comments"> 
802 A string array, containing one string label per bar.
803 If the bars are vertical, the labels are placed beneath
804 them.  If horizontal (rotated) bars are specified, the labels
805 are placed to the left of the bars.
806</div>
807           
808            <h4 id="_bar_plot_keyword_title">title&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
809             
810             
811             
812             
813             
814             
815             
816             
817            </h4>
818       
819            <div class="comments"> 
820 A string containing the main title to for the bar plot.
821</div>
822           
823            <h4 id="_bar_plot_keyword_xtitle">xtitle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
824             
825             
826             
827             
828             
829             
830             
831             
832            </h4>
833       
834            <div class="comments"> 
835 A string containing the title for the X axis.
836</div>
837           
838            <h4 id="_bar_plot_keyword_ytitle">ytitle&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
839             
840             
841             
842             
843             
844             
845             
846             
847            </h4>
848       
849            <div class="comments"> 
850 A string containing the title for the Y axis.
851</div>
852           
853            <h4 id="_bar_plot_keyword_baserange">baserange&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
854             
855             
856             
857             
858             
859             
860             
861             
862            </h4>
863       
864            <div class="comments"> 
865 A floating-point scalar in the range 0.0 to 1.0, that
866 determines the fraction of the total available plotting area
867 (in the direction perpendicular to the bars) to be used.
868 If not specified, the full available area is used.
869</div>
870           
871            <h4 id="_bar_plot_keyword_barwidth">barwidth&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
872             
873             
874             
875             
876             
877             
878             
879             
880            </h4>
881       
882            <div class="comments"> 
883 A floating-point value that specifies the width of the bars
884 in units of "nominal bar width".  The nominal bar width is
885 computed so that all the bars (and the space between them,
886 set by default to 20% of the width of the bars) will fill the
887 available space (optionally controlled with the BASERANGE
888 keyword).
889</div>
890           
891            <h4 id="_bar_plot_keyword_barspace">barspace&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
892             
893             
894             
895             
896             
897             
898             
899             
900            </h4>
901       
902            <div class="comments"> 
903 A scalar that specifies, in units of "nominal bar width",
904 the spacing between bars.  For example, if BARSPACE is 1.0,
905 then all bars will have one bar-width of space between them.
906 If not specified, the bars are spaced apart by 20% of the bar
907 width.
908</div>
909           
910            <h4 id="_bar_plot_keyword_baroffset">baroffset&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
911             
912             
913             
914             
915             
916             
917             
918             
919            </h4>
920       
921            <div class="comments"> 
922 A scalar that specifies the offset to be applied to the
923 first bar, in units of "nominal bar width".  This keyword
924 allows, for example, different groups of bars to be overplotted
925 on the same graph.  If not specified, the default offset is
926 equal to BARSPACE.
927</div>
928           
929            <h4 id="_bar_plot_keyword_outline">outline&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
930             
931             
932             
933             
934             
935             
936             
937             
938            </h4>
939       
940            <div class="comments"> 
941 If set, this keyword specifies that an outline should be
942 drawn around each bar.
943</div>
944           
945            <h4 id="_bar_plot_keyword_overplot">overplot&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
946             
947             
948             
949             
950             
951             
952             
953             
954            </h4>
955       
956            <div class="comments"> 
957 If set, this keyword specifies that the bar plot should be
958 overplotted on an existing graph.
959</div>
960           
961            <h4 id="_bar_plot_keyword_background">background&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
962             
963             
964             
965             
966             
967             
968             
969             
970            </h4>
971       
972            <div class="comments"> 
973 A scalar that specifies the color index to be used for
974 the background color.  By default, the normal IDL background
975 color is used.
976</div>
977           
978            <h4 id="_bar_plot_keyword_rotate">rotate&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
979             
980             
981             
982             
983             
984             
985             
986             
987            </h4>
988       
989            <div class="comments"> 
990 If set, this keyword indicates that horizontal rather than
991 vertical bars should be drawn.  The bases of horizontal bars
992 are on the left, "Y" axis and the bars extend to the right.
993</div>
994           
995            <h4 id="_bar_plot_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
996             
997             
998             
999             
1000             
1001             
1002             
1003             
1004            </h4>
1005       
1006            <div class="comments"></div>
1007           
1008         
1009
1010          <h3>Examples</h3><div class="preformat"> By using the overplotting capability, it is relatively easy to create
1011        stacked bar charts, or different groups of bars on the same graph.
1012
1013        For example, if ARRAY is a two-dimensional array of 5 columns and 8
1014        rows, it is natural to make a plot with 5 bars, each of which is a
1015        "stacked" composite of 8 sections.  First, create a 2D COLORS array,
1016        equal in size to ARRAY, that has identical color index values across
1017        each row to ensure that the same item is represented by the same color
1018        in all bars.
1019
1020        With ARRAYS and COLORS defined, the following code fragment
1021        illustrates the creation of stacked bars (note that the number of rows
1022        and columns is arbitrary):
1023
1024        !Y.RANGE = [0,ymax] ; Scale range to accommodate the total bar lengths.
1025        BASE = INTARR(NROWS)
1026        FOR I = 0, NROWS-1 DO BEGIN
1027           BAR_PLOT, ARRAY(*,I), COLORS=COLORS(*,I), BASELINES=BASE, $
1028                     BARWIDTH=0.75, BARSPACE=0.25, OVER=(I GT 0)
1029           BASE = BASE + ARRAY(*,I)
1030        ENDFOR
1031
1032        To plot each row of ARRAY as a clustered group of bars within the same
1033        graph, use the BASERANGE keyword to restrict the available plotting
1034        region for each set of bars.  The sample code fragment below
1035        illustrates this method:
1036
1037        FOR I = 0, NROWS-1 DO $
1038           BAR_PLOT, ARRAY(*,I), COLORS=COLORVECT, BARWIDTH=0.8,BARSPACE=0.2, $
1039             BAROFFSET=I*((1.0+BARSPACE)*NCOLS), OVER=(I GT 0), BASERANGE=0.19
1040
1041        where NCOLS is the number of columns in ARRAY, and COLORVECT is a
1042        vector containing the color indices to be used for each group of
1043        bars.  (In this example, each group uses the same set of colors, but
1044        this could easily be changed.)
1045</div>
1046          <h3>Version history</h3>
1047         
1048         
1049          <h4>History</h4><div class="preformat"> August 1990, T.J. Armitage, RSI, initial programming.  Replacement
1050        for PLOTBAR and OPLOTBAR routines written by William Thompson.
1051
1052        September 1990, Steve Richards, RSI, changed defaults to improve the
1053        appearance of the bar plots in the default mode. Included
1054        spacing the bars slightly.
1055
1056 $Id: bar_plot.pro 134 2006-07-07 10:19:08Z navarro $
1057</div>
1058         
1059         
1060         
1061         
1062         
1063         
1064         
1065       
1066         
1067         
1068         
1069         
1070         
1071         
1072         
1073       
1074         
1075       
1076        </div>
1077       
1078      </div>
1079
1080     
1081
1082      <div id="tagline">Produced by IDLdoc 2.0.</div>
1083
1084    </div>
1085
1086  </body>
1087</html>
Note: See TracBrowser for help on using the repository browser.