Changeset 142 for trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DESSINE/bar_plot.html
- Timestamp:
- 07/21/06 14:47:49 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/PLOTS/DESSINE/bar_plot.html
r138 r142 696 696 </div> 697 697 698 <div id="file_comments"></div> 698 <div id="file_comments"> 699 Create a bar graph, or overplot on an existing one. 700 </div> 699 701 700 702 … … 711 713 <div class="routine_details" id="_bar_plot"> 712 714 713 <h2><a class="top" href="#container">top</a>bar_plot </h2> 715 <h2><a class="top" href="#container">top</a>bar_plot <span class="categories"> 716 Graphics 717 </span></h2> 714 718 715 719 <p class="header"> … … 717 721 718 722 <div class="comments"> 719 PURPOSE: 720 Create a bar graph, or overplot on an existing one. 721 722 CATEGORY: 723 Graphics. 724 725 CALLING SEQUENCE: 726 BAR_PLOT, Values 727 728 INPUTS: 729 Values: A vector containing the values to be represented by the bars. 730 Each element in VALUES corresponds to a single bar in the 731 output. 732 733 KEYWORD PARAMETERS: 734 BASELINES: A vector, the same size as VALUES, that contains the 735 base value associated with each bar. If not specified, 736 a base value of zero is used for all bars. 737 738 COLORS: A vector, the same size as VALUES, containing the color index 739 to be used for each bar. If not specified, the colors are 740 selected based on spacing the color indices as widely as 741 possible within the available colors (specified by D.N_COLORS). 742 743 BARNAMES: A string array, containing one string label per bar. 744 If the bars are vertical, the labels are placed beneath 745 them. If horizontal (rotated) bars are specified, the labels 746 are placed to the left of the bars. 747 748 TITLE: A string containing the main title to for the bar plot. 749 750 XTITLE: A string containing the title for the X axis. 751 752 YTITLE: A string containing the title for the Y axis. 753 754 BASERANGE: A floating-point scalar in the range 0.0 to 1.0, that 755 determines the fraction of the total available plotting area 756 (in the direction perpendicular to the bars) to be used. 757 If not specified, the full available area is used. 758 759 BARWIDTH: A floating-point value that specifies the width of the bars 760 in units of "nominal bar width". The nominal bar width is 761 computed so that all the bars (and the space between them, 762 set by default to 20% of the width of the bars) will fill the 763 available space (optionally controlled with the BASERANGE 764 keyword). 765 766 BARSPACE: A scalar that specifies, in units of "nominal bar width", 767 the spacing between bars. For example, if BARSPACE is 1.0, 768 then all bars will have one bar-width of space between them. 769 If not specified, the bars are spaced apart by 20% of the bar 770 width. 771 772 BAROFFSET: A scalar that specifies the offset to be applied to the 773 first bar, in units of "nominal bar width". This keyword 774 allows, for example, different groups of bars to be overplotted 775 on the same graph. If not specified, the default offset is 776 equal to BARSPACE. 777 778 OUTLINE: If set, this keyword specifies that an outline should be 779 drawn around each bar. 780 781 OVERPLOT: If set, this keyword specifies that the bar plot should be 782 overplotted on an existing graph. 783 784 BACKGROUND: A scalar that specifies the color index to be used for 785 the background color. By default, the normal IDL background 786 color is used. 787 788 ROTATE: If set, this keyword indicates that horizontal rather than 789 vertical bars should be drawn. The bases of horizontal bars 790 are on the left, "Y" axis and the bars extend to the right. 791 792 OUTPUTS: 793 A bar plot is created, or an existing one is overplotted. 794 795 EXAMPLE: 796 By using the overplotting capability, it is relatively easy to create 723 </div> 724 725 726 727 728 <h3>Parameters</h3> 729 730 731 <h4 id="_bar_plot_param_values">values 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 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 797 1011 stacked bar charts, or different groups of bars on the same graph. 798 1012 … … 829 1043 bars. (In this example, each group uses the same set of colors, but 830 1044 this could easily be changed.) 831 832 MODIFICATION HISTORY: 833 August 1990, T.J. Armitage, RSI, initial programming. Replacement 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 834 1050 for PLOTBAR and OPLOTBAR routines written by William Thompson. 835 1051 836 1052 September 1990, Steve Richards, RSI, changed defaults to improve the 837 1053 appearance of the bar plots in the default mode. Included 838 spacing the bars slightly.</div> 839 840 841 842 843 <h3>Parameters</h3> 844 845 846 <h4 id="_bar_plot_param_values">values 847 848 849 850 851 852 853 854 855 </h4> 856 857 <div class="comments"></div> 858 859 860 861 862 863 864 <h3>Keywords</h3> 865 866 <h4 id="_bar_plot_keyword_baselines">baselines 867 868 869 870 871 872 873 874 875 </h4> 876 877 <div class="comments"></div> 878 879 <h4 id="_bar_plot_keyword_colors">colors 880 881 882 883 884 885 886 887 888 </h4> 889 890 <div class="comments"></div> 891 892 <h4 id="_bar_plot_keyword_barnames">barnames 893 894 895 896 897 898 899 900 901 </h4> 902 903 <div class="comments"></div> 904 905 <h4 id="_bar_plot_keyword_title">title 906 907 908 909 910 911 912 913 914 </h4> 915 916 <div class="comments"></div> 917 918 <h4 id="_bar_plot_keyword_xtitle">xtitle 919 920 921 922 923 924 925 926 927 </h4> 928 929 <div class="comments"></div> 930 931 <h4 id="_bar_plot_keyword_ytitle">ytitle 932 933 934 935 936 937 938 939 940 </h4> 941 942 <div class="comments"></div> 943 944 <h4 id="_bar_plot_keyword_baserange">baserange 945 946 947 948 949 950 951 952 953 </h4> 954 955 <div class="comments"></div> 956 957 <h4 id="_bar_plot_keyword_barwidth">barwidth 958 959 960 961 962 963 964 965 966 </h4> 967 968 <div class="comments"></div> 969 970 <h4 id="_bar_plot_keyword_barspace">barspace 971 972 973 974 975 976 977 978 979 </h4> 980 981 <div class="comments"></div> 982 983 <h4 id="_bar_plot_keyword_baroffset">baroffset 984 985 986 987 988 989 990 991 992 </h4> 993 994 <div class="comments"></div> 995 996 <h4 id="_bar_plot_keyword_outline">outline 997 998 999 1000 1001 1002 1003 1004 1005 </h4> 1006 1007 <div class="comments"></div> 1008 1009 <h4 id="_bar_plot_keyword_overplot">overplot 1010 1011 1012 1013 1014 1015 1016 1017 1018 </h4> 1019 1020 <div class="comments"></div> 1021 1022 <h4 id="_bar_plot_keyword_background">background 1023 1024 1025 1026 1027 1028 1029 1030 1031 </h4> 1032 1033 <div class="comments"></div> 1034 1035 <h4 id="_bar_plot_keyword_rotate">rotate 1036 1037 1038 1039 1040 1041 1042 1043 1044 </h4> 1045 1046 <div class="comments"></div> 1047 1048 <h4 id="_bar_plot_keyword__EXTRA">_EXTRA 1049 1050 1051 1052 1053 1054 1055 1056 1057 </h4> 1058 1059 <div class="comments"></div> 1060 1061 1062 1063 1064 1065 1066 1067 1054 spacing the bars slightly. 1055 1056 $Id: bar_plot.pro 134 2006-07-07 10:19:08Z navarro $ 1057 </div> 1068 1058 1069 1059
Note: See TracChangeset
for help on using the changeset viewer.
