Context Navigation

source: trunk/SRC/Documentation/idldoc_html_output/Colors/colorbar.html @ 157

Last change on this file since 157 was 157, checked in by navarro, 18 years ago
header improvements + xxx doc
File size: 23.0 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>colorbar.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
20	a { text-decoration: none; }
21
22	a:link, a:visited {
23	color: #660000;
24	border-bottom: 1px dotted #C0C0F0;
25	}
26
27	a:hover, a:focus {
28	color: #993333;
29	background: #FFFFCC;
30	border-bottom: 1px dotted #303099;
31	}
32
33
34	/* Main styles --------------------------------------------------------------- */
35	p.preformat {
36	font-family: Courier;
37	}
38
39	body {
40	margin: 0;
41	padding: 0;
42	font-size: 10pt;
43	font-family: Verdana, Helvetica, Arial, sans-serif;
44	background-color: #FFFFFF;
45	}
46
47	p {
48	margin-top: 0.5em;
49	margin-bottom: 0;
50	}
51
52	#container { margin: 1em; }
53
54	code.section { white-space: pre; }
55
56	pre.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
157	div#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
165	div#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
182	h1, h2, h3, h4 {
183	font-weight: normal;
184	color: #3333CC;
185	}
186
187	h1 {
188	padding-top: 0.75em;
189	font-size: 160%;
190	}
191
192	h2 {
193	padding-top: 1em;
194	font-size: 120%;
195	}
196
197	h3 {
198	padding-top: 0.75em;
199	margin-bottom: 0.25em;
200	font-size: 100%;
201	}
202
203	h4 {
204	padding: 0;
205	margin: 0.5em 0 0 0;
206	font-size: 80%;
207	}
208
209	table.basic {
210	empty-cells: show;
211	margin: 1.5em 1em 0 1em;
212	border: 1px dotted #CFCFFF;
213	font-size: 80%;
214	}
215
216	table.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
224	table.basic td {
225	vertical-align: top;
226	padding: 4px 1em 4px 4px;
227	}
228
229	dd {
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
272	h1.directory {
273	padding: 1em 0 0 0;
274	margin: 0;
275	font-size: 66%;
276	}
277
278	h1.directory a { border-bottom: 0; }
279
280	h2.pro_file {
281	padding: 0;
282	margin: 0;
283	font-size: 140%;
284	}
285
286	div#file_attr {
287	padding: 0 1em 0 1em;
288	margin: 1em;
289	background: #F6F6F6;
290	border: 1px dotted #999999;
291	}
292
293	div#file_attr dt {
294	font-size: 80%;
295	font-weight: bold;
296	}
297
298	div#file_attr dd {
299	font-size: 80%;
300	}
301
302	div#class_diagram {
303	padding: 1em 0 1em 0;
304	white-space: pre;
305	font-family: 'Courier New';
306	}
307
308	table#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
316	table#sav_attr th { text-align: left; }
317
318	table#sav_attr td { vertical-align: top; padding-right: 2em; }
319
320	table#sav_attr td.value { width: 20em; padding-right: 0em; font-style: italic; }
321
322	p.sav_warning { margin-left: 4em; font-family: 80%; }
323
324	table.variables {
325	font-family: 'Courier New', monospace;
326	font-size: 80%;
327	text-indent: -2em;
328	padding-left: 2em;
329	}
330
331	table.variables td.image { width: 64px; }
332
333	div#file_comments { white-space: pre;
334	margin: 2em;
335	font-size: 80%;
336	}
337
338
339	div.field_summary {
340	padding: 0 1em 0 1em;
341	margin: 1em;
342	background: #FFFFF0;
343	border: 1px dotted #C0C000;
344	}
345
346	div#routine_summary {
347	padding: 0 1em 0 1em;
348	margin: 1em;
349	background: #F0F0FF;
350	border: 1px dotted #9999FF;
351	}
352
353	div.field_summary h2, div#routine_summary h2 {
354	padding: 0.5em 0 0 0;
355	margin: 0;
356	}
357
358	div.field_summary table, div.field_summary p {
359	margin: 1em 1em;
360	}
361
362	div.field_summary td.name {
363	vertical-align: top;
364	padding-bottom: 0.25em;
365	color: #3333CC;
366	}
367
368	div.field_summary span.field_type {
369	font-weight: normal;
370	font-size: 80%;
371	color: black;
372	}
373
374	div.field_summary td.comments {
375	vertical-align: top;
376	padding-left: 2em;
377	font-size: 80%;
378	}
379
380	p.commaList {
381	margin: 1em 1em 1em 1em;
382	}
383
384	span.warning {
385	color: #CC6633;
386	font-weight: bold;
387	font-size: 66%;
388	text-transform: uppercase;
389	}
390
391	span.categories {
392	color: #006633;
393	font-weight: bold;
394	font-size: 66%;
395	text-transform: uppercase;
396	}
397
398	span.undoc {
399	color: #FF6633;
400	font-weight: bold;
401	font-size: 80%;
402	text-transform: uppercase;
403	}
404
405	span.attr {
406	color: #006633;
407	font-weight: bold;
408	font-size: 80%;
409	text-transform: uppercase;
410	}
411
412	span.value {
413	color: #006633;
414	font-weight: normal;
415	text-transform: none;
416	}
417
418	a.top {
419	font-weight: bold;
420	font-size: 66%;
421	text-transform: uppercase;
422	float: right;
423	}
424
425	span.result {
426	font-family: Verdana, Arial, Helvetica, sans-serif;
427	font-style: italic;
428	font-size: 80%;
429	}
430
431	div#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
438	div.routine_details {
439	padding: 0.5em 1em 0.5em 1em;
440	margin: 1em;
441	border: 1px dotted #CCCCCC;
442	}
443
444	div.routine_details h2 {
445	padding-top: 0;
446	margin-top: 0;
447	}
448
449	div.routine_details div.value {
450	margin: 0 1em 0 1em;
451	font-size: 80%;
452	}
453
454	div.routine_details div.comments {
455	font-size: 80%;
456	margin: 0.75em 1em 1em 1em;
457	}
458
459	div.routine_details div.preformat {
460	white-space: pre;
461	}
462
463	table.statistics {
464	font-size: 80%;
465	margin-left: 1em;
466	}
467
468	table.statistics td {
469	padding: 0 2em 0 0;
470	}
471
472	/* Overview styles ----------------------------------------------------------- */
473
474	div.overview {
475	width: 100%;
476	margin-top: 1em;
477	clear: both;
478	}
479
480	div.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
489	div.overview td {
490	padding: 3px 1em 3px 1em;
491	}
492
493	div.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
533	input.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
571	div.toc {
572	padding: 0 1em 0 1em;
573	margin: 1em;
574	background: #F0F0FF;
575	border: 1px dotted #9999FF;
576	width: 19em;
577	}
578
579	div.right {
580	float: right;
581	width: 22em;
582	}
583
584	ol.toc {
585	list-style-type: upper-roman;
586	}
587
588	ol.toc ol {
589	padding-left: 3em;
590	margin-left: 0;
591	list-style-type: lower-alpha;
592	}
593
594	dl.variables dt { font-size: 80%; }
595	dl.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="colorbar.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 documentation</td>
679	</tr>
680	</table>
681
682	</div>
683
684	<div id="secondary_navbar">
685
686	<a href="color24.html?format=raw"><<prev file</a> \| <a href="getcolor.html?format=raw">next file >></a>    <a href="colorbar.html?format=raw" target="_TOP">view single page</a> \| <a href="./../index.html?format=raw" target="_TOP">view frames</a>    summary: fields \| routine    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">Colors/</a></h1>
694	<h2 class="pro_file">colorbar.pro</h2>
695
696	<div id="file_attr">
697	<dl>
698	</dl>
699	</div>
700
701	<div id="file_comments">
702	The purpose of this routine is to add a color bar to the current
703	graphics window.
704	</div>
705
706
707
708
709
710
711
712
713
714	<div id="routine_details">
715
716
717	<div class="routine_details" id="_COLORBAR">
718
719	<h2><a class="top" href="#container">top</a>COLORBAR <span class="categories"> Graphics, Widget
720	</span></h2>
721
722	<p class="header">
723	COLORBAR, <a href="#_COLORBAR_keyword_BOTTOM">BOTTOM</a>=<span class="result">BOTTOM</span>, <a href="#_COLORBAR_keyword_CB_CHARSIZE">CB_CHARSIZE</a>=<span class="result">CB_CHARSIZE</span>, <a href="#_COLORBAR_keyword_CB_CHARTHICK">CB_CHARTHICK</a>=<span class="result">CB_CHARTHICK</span>, <a href="#_COLORBAR_keyword_CB_COLOR">CB_COLOR</a>=<span class="result">CB_COLOR</span>, <a href="#_COLORBAR_keyword_DIVISIONS">DIVISIONS</a>=<span class="result">DIVISIONS</span>, <a href="#_COLORBAR_keyword_DISCRETE">DISCRETE</a>=<span class="result">DISCRETE</span>, <a href="#_COLORBAR_keyword_CB_LABEL">CB_LABEL</a>=<span class="result">CB_LABEL</span>, <a href="#_COLORBAR_keyword_FORMAT">FORMAT</a>=<span class="result">FORMAT</span>, <a href="#_COLORBAR_keyword_POSITION">POSITION</a>=<span class="result">POSITION</span>, <a href="#_COLORBAR_keyword_MAX">MAX</a>=<span class="result">MAX</span>, <a href="#_COLORBAR_keyword_MIN">MIN</a>=<span class="result">MIN</span>, <a href="#_COLORBAR_keyword_NCOLORS">NCOLORS</a>=<span class="result">NCOLORS</span>, <a href="#_COLORBAR_keyword_PSCOLOR">PSCOLOR</a>=<span class="result">PSCOLOR</span>, <a href="#_COLORBAR_keyword_CB_TITLE">CB_TITLE</a>=<span class="result">CB_TITLE</span>, <a href="#_COLORBAR_keyword_VERTICAL">VERTICAL</a>=<span class="result">VERTICAL</span>, <a href="#_COLORBAR_keyword_TOP">TOP</a>=<span class="result">TOP</span>, <a href="#_COLORBAR_keyword_RIGHT">RIGHT</a>=<span class="result">RIGHT</span>, <a href="#_COLORBAR_keyword_CB_LOG">CB_LOG</a>=<span class="result">CB_LOG</span>, <a href="#_COLORBAR_keyword_NOTITLE">NOTITLE</a>=<span class="result">NOTITLE</span>, <a href="#_COLORBAR_keyword__EXTRA">_EXTRA</a>=<span class="result">_EXTRA</span></p>
724
725	<div class="comments">
726	</div>
727
728
729
730
731
732
733
734	<h3>Keywords</h3>
735
736	<h4 id="_COLORBAR_keyword_BOTTOM">BOTTOM
737
738
739
740
741
742
743	<span class="attr">default:</span> <span class="value">0B</span>
744
745	</h4>
746
747	<div class="comments">
748	The lowest color index of the colors to be loaded in the bar.
749	</div>
750
751	<h4 id="_COLORBAR_keyword_CB_CHARSIZE">CB_CHARSIZE
752
753
754
755
756
757
758	<span class="attr">default:</span> <span class="value">1.0</span>
759
760	</h4>
761
762	<div class="comments">
763	The character size of the color bar annotations.
764	</div>
765
766	<h4 id="_COLORBAR_keyword_CB_CHARTHICK">CB_CHARTHICK
767
768
769
770
771
772
773	<span class="attr">default:</span> <span class="value">1.0</span>
774
775	</h4>
776
777	<div class="comments">
778	The character thick of the color bar annotations.
779	</div>
780
781	<h4 id="_COLORBAR_keyword_CB_COLOR">CB_COLOR
782
783
784
785
786
787
788	<span class="attr">default:</span> <span class="value">ncolors - 1 + bottom</span>
789
790	</h4>
791
792	<div class="comments">
793	The color index of the bar outline and characters.
794	</div>
795
796	<h4 id="_COLORBAR_keyword_DIVISIONS">DIVISIONS
797
798
799
800
801
802
803	<span class="attr">default:</span> <span class="value">2</span>
804
805	</h4>
806
807	<div class="comments">
808	The number of divisions to divide the bar into.
809	There will be (divisions + 1) annotations.
810	</div>
811
812	<h4 id="_COLORBAR_keyword_DISCRETE">DISCRETE
813
814
815
816
817
818
819
820
821	</h4>
822
823	<div class="comments">
824	Vector which contain color's indexes to trace in a color bar. Therefore
825	we obtain a discrete colorbar which contains only the specified colors
826	in the order they appear in the vector
827	</div>
828
829	<h4 id="_COLORBAR_keyword_CB_LABEL">CB_LABEL
830
831
832
833
834
835
836
837
838	</h4>
839
840	<div class="comments">
841	A vector to specify sticks values of the color bar. It allowes,
842	when we use DISCRETE, to have colors that don't increase by
843	increments in a regular way.
844	</div>
845
846	<h4 id="_COLORBAR_keyword_FORMAT">FORMAT
847
848
849
850
851
852
853	<span class="attr">default:</span> <span class="value">'(F6.2)'</span>
854
855	</h4>
856
857	<div class="comments">
858	The format of the bar annotations.
859	</div>
860
861	<h4 id="_COLORBAR_keyword_POSITION">POSITION
862
863
864
865
866
867
868	<span class="attr">default:</span> <span class="value">see bellow</span>
869
870	</h4>
871
872	<div class="comments">
873	A four-element array of normalized coordinates in the same
874	form as the POSITION keyword on a plot. Default is
875	[0.88, 0.15, 0.95, 0.95] for a vertical bar and
876	[0.15, 0.88, 0.95, 0.95] for a horizontal bar.
877	</div>
878
879	<h4 id="_COLORBAR_keyword_MAX">MAX
880
881
882
883
884
885
886	<span class="attr">default:</span> <span class="value">NCOLORS - 1</span>
887
888	</h4>
889
890	<div class="comments">
891	The maximum data value for the bar annotation.
892	</div>
893
894	<h4 id="_COLORBAR_keyword_MIN">MIN
895
896
897
898
899
900
901	<span class="attr">default:</span> <span class="value">0</span>
902
903	</h4>
904
905	<div class="comments">
906	The minimum data value for the bar annotation.
907	</div>
908
909	<h4 id="_COLORBAR_keyword_NCOLORS">NCOLORS
910
911
912
913
914
915
916	<span class="attr">default:</span> <span class="value">!D.N_COLORS</span>
917
918	</h4>
919
920	<div class="comments">
921	This is the number of colors in the color bar.
922	</div>
923
924	<h4 id="_COLORBAR_keyword_PSCOLOR">PSCOLOR
925
926
927
928
929
930
931
932
933	</h4>
934
935	<div class="comments">
936	This keyword is only applied if the output is being sent to
937	a Postscript file. It indicates that the Postscript device
938	is configured for color output. If this keyword is set, then
939	the annotation is drawn in the color specified by the COLOR
940	keyword. If the keyword is not set, the annotation is drawn
941	in the color specified by the !P.COLOR system variable
942	(usually this will be the color black). In general, this
943	gives better looking output on non-color or gray-scale
944	printers. If you are not specifically setting the annotation
945	color (with the COLOR keyword), it will probably
946	be better NOT to set this keyword either, even if you
947	are outputting to a color Postscript printer.
948	</div>
949
950	<h4 id="_COLORBAR_keyword_CB_TITLE">CB_TITLE
951
952
953
954
955
956
957	<span class="attr">default:</span> <span class="value">''</span>
958
959	</h4>
960
961	<div class="comments">
962	This is title for the color bar.
963	</div>
964
965	<h4 id="_COLORBAR_keyword_VERTICAL">VERTICAL
966
967
968
969
970
971
972	<span class="attr">default:</span> <span class="value">0 -> horizontal color bar</span>
973
974	</h4>
975
976	<div class="comments">
977	Setting this keyword give a vertical color bar.
978	</div>
979
980	<h4 id="_COLORBAR_keyword_TOP">TOP
981
982
983
984
985
986
987
988
989	</h4>
990
991	<div class="comments">
992	This puts the labels on top of the bar rather than under it.
993	The keyword only applies if a horizontal color bar is rendered.
994	</div>
995
996	<h4 id="_COLORBAR_keyword_RIGHT">RIGHT
997
998
999
1000
1001
1002
1003
1004
1005	</h4>
1006
1007	<div class="comments">
1008	This puts the labels on the right-hand side of a vertical
1009	color bar. It applies only to vertical color bars.
1010	</div>
1011
1012	<h4 id="_COLORBAR_keyword_CB_LOG">CB_LOG
1013
1014
1015
1016
1017
1018
1019
1020
1021	</h4>
1022
1023	<div class="comments">
1024	to get logarithmic scale for the colorbar
1025	</div>
1026
1027	<h4 id="_COLORBAR_keyword_NOTITLE">NOTITLE
1028
1029
1030
1031
1032
1033
1034
1035
1036	</h4>
1037
1038	<div class="comments">
1039	Force to don't write title even if CB_TITLE is declared.
1040	</div>
1041
1042	<h4 id="_COLORBAR_keyword__EXTRA">_EXTRA
1043
1044
1045
1046
1047
1048
1049
1050
1051	</h4>
1052
1053	<div class="comments">
1054	pass any keyword to colorbar
1055	</div>
1056
1057
1058
1059	<h3>Examples</h3><div class="preformat">
1060	To display a horizontal color bar above a contour plot, type:
1061
1062	IDL> LOADCT, 5, NCOLORS=100
1063	IDL> CONTOUR, DIST(31,41), POSITION=[0.15, 0.15, 0.95, 0.75], $
1064	IDL> C_COLORS=INDGEN(25)*4, NLEVELS=25
1065	IDL> COLORBAR, NCOLORS=100
1066	</div>
1067	<h3>Version history</h3>
1068
1069	<h4>Version</h4><div class="preformat"> $Id: colorbar.pro 155 2006-08-11 14:32:05Z smasson $
1070	</div>
1071	<h4>History</h4><div class="preformat">
1072	Written by: David Fanning, 10 JUNE 96.
1073	10/27/96: Added the ability to send output to PostScript. DWF
1074	11/04/96: Substantially rewritten to go to screen or PostScript
1075	file without having to know much about the PostScript device
1076	or even what the current graphics device is. DWF
1077	01/27/97: Added the RIGHT and TOP keywords. Also modified the
1078	way the TITLE keyword works. DWF
1079	07/15/97: Fixed a problem some machines have with plots that have
1080	no valid data range in them. DWF
1081	03/03/98: Add DISCRETE keyword, sebastien masson (smasson@lodyc.jussieu.fr)
1082	</div>
1083
1084
1085	<h3>Known issues</h3>
1086
1087
1088
1089	<h4>Restrictions</h4><div class="preformat">
1090	The number of colors available on the display device (not the
1091	Postscript device) is used unless the NCOLORS keyword is used.
1092	</div>
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104	</div>
1105
1106	</div>
1107
1108
1109
1110	<div id="tagline">Produced by IDLdoc 2.0.</div>
1111
1112	</div>
1113
1114	</body>
1115	</html>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: