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

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

header improvements + xxx doc

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