writeexcel 0.5.0 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (130) hide show
  1. data/.gitattributes +1 -1
  2. data/.gitignore +24 -24
  3. data/README.rdoc +34 -55
  4. data/VERSION +1 -1
  5. data/charts/chartex.rb +316 -316
  6. data/charts/demo1.rb +46 -46
  7. data/charts/demo2.rb +65 -65
  8. data/charts/demo3.rb +117 -117
  9. data/charts/demo4.rb +119 -119
  10. data/charts/demo5.rb +48 -48
  11. data/examples/a_simple.rb +43 -43
  12. data/examples/autofilter.rb +265 -265
  13. data/examples/bigfile.rb +30 -30
  14. data/examples/chart_area.rb +121 -121
  15. data/examples/chart_bar.rb +120 -120
  16. data/examples/chart_column.rb +120 -120
  17. data/examples/chart_line.rb +120 -120
  18. data/examples/chart_pie.rb +108 -108
  19. data/examples/chart_scatter.rb +121 -121
  20. data/examples/chart_stock.rb +148 -148
  21. data/examples/chess.rb +142 -142
  22. data/examples/colors.rb +129 -129
  23. data/examples/comments1.rb +27 -27
  24. data/examples/comments2.rb +352 -352
  25. data/examples/copyformat.rb +52 -52
  26. data/examples/data_validate.rb +279 -279
  27. data/examples/date_time.rb +87 -87
  28. data/examples/defined_name.rb +32 -32
  29. data/examples/demo.rb +124 -124
  30. data/examples/diag_border.rb +36 -36
  31. data/examples/formats.rb +490 -490
  32. data/examples/formula_result.rb +30 -30
  33. data/examples/header.rb +137 -137
  34. data/examples/hide_sheet.rb +29 -29
  35. data/examples/hyperlink.rb +43 -43
  36. data/examples/images.rb +63 -63
  37. data/examples/indent.rb +31 -31
  38. data/examples/merge1.rb +40 -40
  39. data/examples/merge2.rb +45 -45
  40. data/examples/merge3.rb +66 -66
  41. data/examples/merge4.rb +83 -83
  42. data/examples/merge5.rb +80 -80
  43. data/examples/merge6.rb +67 -67
  44. data/examples/outline.rb +255 -255
  45. data/examples/outline_collapsed.rb +209 -209
  46. data/examples/panes.rb +113 -113
  47. data/examples/properties.rb +34 -34
  48. data/examples/properties_jp.rb +33 -33
  49. data/examples/protection.rb +47 -47
  50. data/examples/regions.rb +53 -53
  51. data/examples/repeat.rb +43 -43
  52. data/examples/right_to_left.rb +27 -27
  53. data/examples/row_wrap.rb +53 -53
  54. data/examples/stats.rb +74 -74
  55. data/examples/stocks.rb +81 -81
  56. data/examples/tab_colors.rb +31 -31
  57. data/examples/utf8.rb +15 -15
  58. data/examples/write_arrays.rb +83 -83
  59. data/lib/writeexcel/biffwriter.rb +232 -232
  60. data/lib/writeexcel/caller_info.rb +12 -12
  61. data/lib/writeexcel/chart.rb +2190 -2177
  62. data/lib/writeexcel/charts/area.rb +154 -154
  63. data/lib/writeexcel/charts/bar.rb +177 -177
  64. data/lib/writeexcel/charts/column.rb +156 -156
  65. data/lib/writeexcel/charts/external.rb +66 -66
  66. data/lib/writeexcel/charts/line.rb +154 -154
  67. data/lib/writeexcel/charts/pie.rb +169 -169
  68. data/lib/writeexcel/charts/scatter.rb +192 -192
  69. data/lib/writeexcel/charts/stock.rb +213 -213
  70. data/lib/writeexcel/colors.rb +64 -64
  71. data/lib/writeexcel/compatibility.rb +0 -255
  72. data/lib/writeexcel/debug_info.rb +37 -33
  73. data/lib/writeexcel/excelformulaparser.rb +587 -587
  74. data/lib/writeexcel/format.rb +13 -4
  75. data/lib/writeexcel/formula.rb +26 -9
  76. data/lib/writeexcel/helper.rb +68 -64
  77. data/lib/writeexcel/olewriter.rb +311 -311
  78. data/lib/writeexcel/properties.rb +242 -240
  79. data/lib/writeexcel/storage_lite.rb +984 -978
  80. data/lib/writeexcel/workbook.rb +3210 -3192
  81. data/lib/writeexcel/worksheet.rb +143 -51
  82. data/lib/writeexcel/write_file.rb +44 -40
  83. data/lib/writeexcel.rb +1159 -1159
  84. data/test/helper.rb +31 -28
  85. data/test/perl_output/README +31 -31
  86. data/test/test_00_IEEE_double.rb +13 -13
  87. data/test/test_01_add_worksheet.rb +10 -10
  88. data/test/test_02_merge_formats.rb +53 -53
  89. data/test/test_04_dimensions.rb +392 -392
  90. data/test/test_05_rows.rb +179 -179
  91. data/test/test_06_extsst.rb +77 -77
  92. data/test/test_11_date_time.rb +479 -479
  93. data/test/test_12_date_only.rb +501 -501
  94. data/test/test_13_date_seconds.rb +481 -481
  95. data/test/test_21_escher.rb +637 -637
  96. data/test/test_22_mso_drawing_group.rb +745 -745
  97. data/test/test_23_note.rb +73 -73
  98. data/test/test_24_txo.rb +75 -75
  99. data/test/test_25_position_object.rb +84 -84
  100. data/test/test_26_autofilter.rb +314 -314
  101. data/test/test_27_autofilter.rb +131 -131
  102. data/test/test_28_autofilter.rb +161 -161
  103. data/test/test_29_process_jpg.rb +683 -683
  104. data/test/test_30_validation_dval.rb +77 -77
  105. data/test/test_31_validation_dv_strings.rb +126 -126
  106. data/test/test_32_validation_dv_formula.rb +206 -206
  107. data/test/test_40_property_types.rb +188 -188
  108. data/test/test_41_properties.rb +235 -235
  109. data/test/test_42_set_properties.rb +437 -437
  110. data/test/test_50_name_stored.rb +299 -299
  111. data/test/test_51_name_print_area.rb +357 -357
  112. data/test/test_52_name_print_titles.rb +454 -454
  113. data/test/test_53_autofilter.rb +203 -203
  114. data/test/test_60_chart_generic.rb +578 -578
  115. data/test/test_61_chart_subclasses.rb +95 -95
  116. data/test/test_62_chart_formats.rb +272 -272
  117. data/test/test_63_chart_area_formats.rb +649 -649
  118. data/test/test_biff.rb +75 -75
  119. data/test/test_compatibility.rb +12 -627
  120. data/test/test_example_match.rb +3144 -3144
  121. data/test/test_formula.rb +61 -61
  122. data/test/test_ole.rb +106 -106
  123. data/test/test_storage_lite.rb +125 -125
  124. data/test/test_workbook.rb +139 -139
  125. data/test/test_worksheet.rb +110 -110
  126. data/utils/add_magic_comment.rb +80 -80
  127. data/writeexcel.gemspec +4 -6
  128. data/writeexcel.rdoc +58 -15
  129. metadata +9 -6
  130. data/test/test_new_encoding.rb +0 -205
@@ -1,154 +1,154 @@
1
- # -*- coding: utf-8 -*-
2
- ###############################################################################
3
- #
4
- # Area - A writer class for Excel Area charts.
5
- #
6
- # Used in conjunction with Chart.
7
- #
8
- # See formatting note in Chart.
9
- #
10
- # Copyright 2000-2010, John McNamara, jmcnamara@cpan.org
11
- #
12
- # original written in Perl by John McNamara
13
- # converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
14
- #
15
-
16
- require 'writeexcel'
17
-
18
- module Writeexcel
19
-
20
- class Chart
21
-
22
- #
23
- # ==SYNOPSIS
24
- #
25
- # To create a simple Excel file with a Area chart using WriteExcel:
26
- #
27
- # #!/usr/bin/ruby -w
28
- #
29
- # require 'writeexcel'
30
- #
31
- # workbook = WriteExcel.new('chart.xls')
32
- # worksheet = workbook.add_worksheet
33
- #
34
- # chart = workbook.add_chart(:type => 'Chart::Area')
35
- #
36
- # # Configure the chart.
37
- # chart.add_series(
38
- # :categories => '=Sheet1!$A$2:$A$7',
39
- # :values => '=Sheet1!$B$2:$B$7',
40
- # )
41
- #
42
- # # Add the worksheet data the chart refers to.
43
- # data = [
44
- # [ 'Category', 2, 3, 4, 5, 6, 7 ],
45
- # [ 'Value', 1, 4, 5, 2, 1, 5 ]
46
- # ]
47
- #
48
- # worksheet.write('A1', data)
49
- #
50
- # workbook.close
51
- #
52
- # ==DESCRIPTION
53
- #
54
- # This module implements Area charts for WriteExcel. The chart object is
55
- # created via the Workbook add_chart method:
56
- #
57
- # chart = workbook.add_chart(:type => 'Chart::Area')
58
- #
59
- # Once the object is created it can be configured via the following methods
60
- # that are common to all chart classes:
61
- #
62
- # chart.add_series
63
- # chart.set_x_axis
64
- # chart.set_y_axis
65
- # chart.set_title
66
- #
67
- # These methods are explained in detail in Chart section of WriteExcel.
68
- # Class specific methods or settings, if any, are explained below.
69
- #
70
- # ==Area Chart Methods
71
- #
72
- # There aren't currently any area chart specific methods. See the TODO
73
- # section of Chart of Writeexcel.
74
- #
75
- # ==EXAMPLE
76
- #
77
- # Here is a complete example that demonstrates most of the available
78
- # features when creating a chart.
79
- #
80
- # #!/usr/bin/ruby -w
81
- #
82
- # require 'writeexcel'
83
- #
84
- # workbook = WriteExcel.new('chart_area.xls')
85
- # worksheet = workbook.add_worksheet
86
- # bold = workbook.add_format(:bold => 1)
87
- #
88
- # # Add the worksheet data that the charts will refer to.
89
- # headings = [ 'Number', 'Sample 1', 'Sample 2' ]
90
- # data = [
91
- # [ 2, 3, 4, 5, 6, 7 ],
92
- # [ 1, 4, 5, 2, 1, 5 ],
93
- # [ 3, 6, 7, 5, 4, 3 ]
94
- # ]
95
- #
96
- # worksheet.write('A1', headings, bold)
97
- # worksheet.write('A2', data)
98
- #
99
- # # Create a new chart object. In this case an embedded chart.
100
- # chart = workbook.add_chart(:type => 'Chart::Area', :embedded => 1)
101
- #
102
- # # Configure the first series. (Sample 1)
103
- # chart.add_series(
104
- # :name => 'Sample 1',
105
- # :categories => '=Sheet1!$A$2:$A$7',
106
- # :values => '=Sheet1!$B$2:$B$7',
107
- # )
108
- #
109
- # # Configure the second series. (Sample 2)
110
- # chart.add_series(
111
- # :name => 'Sample 2',
112
- # :categories => '=Sheet1!$A$2:$A$7',
113
- # :values => '=Sheet1!$C$2:$C$7',
114
- # )
115
- #
116
- # # Add a chart title and some axis labels.
117
- # chart.set_title (:name => 'Results of sample analysis')
118
- # chart.set_x_axis(:name => 'Test number')
119
- # chart.set_y_axis(:name => 'Sample length (cm)')
120
- #
121
- # # Insert the chart into the worksheet (with an offset).
122
- # worksheet.insert_chart('D2', chart, 25, 10)
123
- #
124
- # workbook.close
125
- #
126
- class Area < Chart
127
- ###############################################################################
128
- #
129
- # new()
130
- #
131
- #
132
- def initialize(*args) # :nodoc:
133
- super
134
- end
135
-
136
- ###############################################################################
137
- #
138
- # _store_chart_type()
139
- #
140
- # Implementation of the abstract method from the specific chart class.
141
- #
142
- # Write the AREA chart BIFF record. Defines a area chart type.
143
- #
144
- def store_chart_type # :nodoc:
145
- record = 0x101A # Record identifier.
146
- length = 0x0002 # Number of bytes to follow.
147
- grbit = 0x0001 # Option flags.
148
-
149
- store_simple(record, length, grbit)
150
- end
151
- end
152
- end # class Chart
153
-
154
- end # module Writeexcel
1
+ # -*- coding: utf-8 -*-
2
+ ###############################################################################
3
+ #
4
+ # Area - A writer class for Excel Area charts.
5
+ #
6
+ # Used in conjunction with Chart.
7
+ #
8
+ # See formatting note in Chart.
9
+ #
10
+ # Copyright 2000-2010, John McNamara, jmcnamara@cpan.org
11
+ #
12
+ # original written in Perl by John McNamara
13
+ # converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
14
+ #
15
+
16
+ require 'writeexcel'
17
+
18
+ module Writeexcel
19
+
20
+ class Chart
21
+
22
+ #
23
+ # ==SYNOPSIS
24
+ #
25
+ # To create a simple Excel file with a Area chart using WriteExcel:
26
+ #
27
+ # #!/usr/bin/ruby -w
28
+ #
29
+ # require 'writeexcel'
30
+ #
31
+ # workbook = WriteExcel.new('chart.xls')
32
+ # worksheet = workbook.add_worksheet
33
+ #
34
+ # chart = workbook.add_chart(:type => 'Chart::Area')
35
+ #
36
+ # # Configure the chart.
37
+ # chart.add_series(
38
+ # :categories => '=Sheet1!$A$2:$A$7',
39
+ # :values => '=Sheet1!$B$2:$B$7',
40
+ # )
41
+ #
42
+ # # Add the worksheet data the chart refers to.
43
+ # data = [
44
+ # [ 'Category', 2, 3, 4, 5, 6, 7 ],
45
+ # [ 'Value', 1, 4, 5, 2, 1, 5 ]
46
+ # ]
47
+ #
48
+ # worksheet.write('A1', data)
49
+ #
50
+ # workbook.close
51
+ #
52
+ # ==DESCRIPTION
53
+ #
54
+ # This module implements Area charts for WriteExcel. The chart object is
55
+ # created via the Workbook add_chart method:
56
+ #
57
+ # chart = workbook.add_chart(:type => 'Chart::Area')
58
+ #
59
+ # Once the object is created it can be configured via the following methods
60
+ # that are common to all chart classes:
61
+ #
62
+ # chart.add_series
63
+ # chart.set_x_axis
64
+ # chart.set_y_axis
65
+ # chart.set_title
66
+ #
67
+ # These methods are explained in detail in Chart section of WriteExcel.
68
+ # Class specific methods or settings, if any, are explained below.
69
+ #
70
+ # ==Area Chart Methods
71
+ #
72
+ # There aren't currently any area chart specific methods. See the TODO
73
+ # section of Chart of Writeexcel.
74
+ #
75
+ # ==EXAMPLE
76
+ #
77
+ # Here is a complete example that demonstrates most of the available
78
+ # features when creating a chart.
79
+ #
80
+ # #!/usr/bin/ruby -w
81
+ #
82
+ # require 'writeexcel'
83
+ #
84
+ # workbook = WriteExcel.new('chart_area.xls')
85
+ # worksheet = workbook.add_worksheet
86
+ # bold = workbook.add_format(:bold => 1)
87
+ #
88
+ # # Add the worksheet data that the charts will refer to.
89
+ # headings = [ 'Number', 'Sample 1', 'Sample 2' ]
90
+ # data = [
91
+ # [ 2, 3, 4, 5, 6, 7 ],
92
+ # [ 1, 4, 5, 2, 1, 5 ],
93
+ # [ 3, 6, 7, 5, 4, 3 ]
94
+ # ]
95
+ #
96
+ # worksheet.write('A1', headings, bold)
97
+ # worksheet.write('A2', data)
98
+ #
99
+ # # Create a new chart object. In this case an embedded chart.
100
+ # chart = workbook.add_chart(:type => 'Chart::Area', :embedded => 1)
101
+ #
102
+ # # Configure the first series. (Sample 1)
103
+ # chart.add_series(
104
+ # :name => 'Sample 1',
105
+ # :categories => '=Sheet1!$A$2:$A$7',
106
+ # :values => '=Sheet1!$B$2:$B$7',
107
+ # )
108
+ #
109
+ # # Configure the second series. (Sample 2)
110
+ # chart.add_series(
111
+ # :name => 'Sample 2',
112
+ # :categories => '=Sheet1!$A$2:$A$7',
113
+ # :values => '=Sheet1!$C$2:$C$7',
114
+ # )
115
+ #
116
+ # # Add a chart title and some axis labels.
117
+ # chart.set_title (:name => 'Results of sample analysis')
118
+ # chart.set_x_axis(:name => 'Test number')
119
+ # chart.set_y_axis(:name => 'Sample length (cm)')
120
+ #
121
+ # # Insert the chart into the worksheet (with an offset).
122
+ # worksheet.insert_chart('D2', chart, 25, 10)
123
+ #
124
+ # workbook.close
125
+ #
126
+ class Area < Chart
127
+ ###############################################################################
128
+ #
129
+ # new()
130
+ #
131
+ #
132
+ def initialize(*args) # :nodoc:
133
+ super
134
+ end
135
+
136
+ ###############################################################################
137
+ #
138
+ # _store_chart_type()
139
+ #
140
+ # Implementation of the abstract method from the specific chart class.
141
+ #
142
+ # Write the AREA chart BIFF record. Defines a area chart type.
143
+ #
144
+ def store_chart_type # :nodoc:
145
+ record = 0x101A # Record identifier.
146
+ length = 0x0002 # Number of bytes to follow.
147
+ grbit = 0x0001 # Option flags.
148
+
149
+ store_simple(record, length, grbit)
150
+ end
151
+ end
152
+ end # class Chart
153
+
154
+ end # module Writeexcel
@@ -1,177 +1,177 @@
1
- # -*- coding: utf-8 -*-
2
- ###############################################################################
3
- #
4
- # Bar - A writer class for Excel Bar charts.
5
- #
6
- # Used in conjunction with Chart.
7
- #
8
- # See formatting note in Chart.
9
- #
10
- # Copyright 2000-2010, John McNamara, jmcnamara@cpan.org
11
- #
12
- # original written in Perl by John McNamara
13
- # converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
14
- #
15
-
16
- require 'writeexcel/chart'
17
-
18
- module Writeexcel
19
-
20
- class Chart
21
-
22
- #
23
- # ==SYNOPSIS
24
- #
25
- # To create a simple Excel file with a Bar chart using WriteExcel:
26
- #
27
- # #!/usr/bin/ruby -w
28
- #
29
- # require 'writeexcel'
30
- #
31
- # workbook = WriteExcel.new('chart.xls')
32
- # worksheet = workbook.add_worksheet
33
- #
34
- # chart = workbook.add_chart(:type => 'Chart::Bar')
35
- #
36
- # # Configure the chart.
37
- # chart.add_series(
38
- # :categories => '=Sheet1!$A$2:$A$7',
39
- # :values => '=Sheet1!$B$2:$B$7',
40
- # )
41
- #
42
- # # Add the worksheet data the chart refers to.
43
- # data = [
44
- # [ 'Category', 2, 3, 4, 5, 6, 7 ],
45
- # [ 'Value', 1, 4, 5, 2, 1, 5 ]
46
- # ]
47
- #
48
- # worksheet.write('A1', data)
49
- #
50
- # workbook.close
51
- #
52
- # ==DESCRIPTION
53
- #
54
- # This module implements Bar charts for WriteExcel. The chart object is
55
- # created via the Workbook add_chart method:
56
- #
57
- # chart = workbook.add_chart(:type => 'Chart::Bar')
58
- #
59
- # Once the object is created it can be configured via the following methods
60
- # that are common to all chart classes:
61
- #
62
- # chart.add_series
63
- # chart.set_x_axis
64
- # chart.set_y_axis
65
- # chart.set_title
66
- #
67
- # These methods are explained in detail in Chart section of WriteExcel.
68
- # Class specific methods or settings, if any, are explained below.
69
- #
70
- # ==Bar Chart Methods
71
- #
72
- # There aren't currently any bar chart specific methods. See the TODO
73
- # section of Chart of Writeexcel.
74
- #
75
- # ==EXAMPLE
76
- #
77
- # Here is a complete example that demonstrates most of the available
78
- # features when creating a chart.
79
- #
80
- # #!/usr/bin/ruby -w
81
- #
82
- # require 'writeexcel'
83
- #
84
- # workbook = WriteExcel.new('chart_bar.xls')
85
- # worksheet = workbook.add_worksheet
86
- # bold = workbook.add_format(:bold => 1)
87
- #
88
- # # Add the worksheet data that the charts will refer to.
89
- # headings = [ 'Number', 'Sample 1', 'Sample 2' ]
90
- # data = [
91
- # [ 2, 3, 4, 5, 6, 7 ],
92
- # [ 1, 4, 5, 2, 1, 5 ],
93
- # [ 3, 6, 7, 5, 4, 3 ]
94
- # ]
95
- #
96
- # worksheet.write('A1', headings, bold)
97
- # worksheet.write('A2', data)
98
- #
99
- # # Create a new chart object. In this case an embedded chart.
100
- # chart = workbook.add_chart(:type => 'Chart::Bar', :embedded => 1)
101
- #
102
- # # Configure the first series. (Sample 1)
103
- # chart.add_series(
104
- # :name => 'Sample 1',
105
- # :categories => '=Sheet1!$A$2:$A$7',
106
- # :values => '=Sheet1!$B$2:$B$7',
107
- # )
108
- #
109
- # # Configure the second series. (Sample 2)
110
- # chart.add_series(
111
- # :name => 'Sample 2',
112
- # :categories => '=Sheet1!$A$2:$A$7',
113
- # :values => '=Sheet1!$C$2:$C$7',
114
- # )
115
- #
116
- # # Add a chart title and some axis labels.
117
- # chart.set_title (:name => 'Results of sample analysis')
118
- # chart.set_x_axis(:name => 'Test number')
119
- # chart.set_y_axis(:name => 'Sample length (cm)')
120
- #
121
- # # Insert the chart into the worksheet (with an offset).
122
- # worksheet.insert_chart('D2', chart, 25, 10)
123
- #
124
- # workbook.close
125
- #
126
- class Bar < Chart
127
- ###############################################################################
128
- #
129
- # new()
130
- #
131
- #
132
- def initialize(*args) # :nodoc:
133
- super
134
- @config[:x_axis_text] = [ 0x2D, 0x6D9, 0x5F, 0x1CC, 0x281, 0x0, 90 ]
135
- @config[:x_axis_text_pos] = [ 2, 2, 0, 0, 0x17, 0x2A ]
136
- @config[:y_axis_text] = [ 0x078A, 0x0DFC, 0x011D, 0x9C, 0x0081, 0x0000 ]
137
- @config[:y_axis_text_pos] = [ 2, 2, 0, 0, 0x45, 0x17 ]
138
- end
139
-
140
- ###############################################################################
141
- #
142
- # _store_chart_type()
143
- #
144
- # Implementation of the abstract method from the specific chart class.
145
- #
146
- # Write the BAR chart BIFF record. Defines a bar or column chart type.
147
- #
148
- def store_chart_type # :nodoc:
149
- record = 0x1017 # Record identifier.
150
- length = 0x0006 # Number of bytes to follow.
151
- pcOverlap = 0x0000 # Space between bars.
152
- pcGap = 0x0096 # Space between cats.
153
- grbit = 0x0001 # Option flags.
154
-
155
- store_simple(record, length, pcOverlap, pcGap, grbit)
156
- end
157
-
158
- ###############################################################################
159
- #
160
- # _set_embedded_config_data()
161
- #
162
- # Override some of the default configuration data for an embedded chart.
163
- #
164
- def set_embedded_config_data # :nodoc:
165
- # Set the parent configuration first.
166
- super
167
-
168
- # The axis positions are reversed for a bar chart so we change the config.
169
- @config[:x_axis_text] = [ 0x57, 0x5BC, 0xB5, 0x214, 0x281, 0x0, 90 ]
170
- @config[:x_axis_text_pos] = [ 2, 2, 0, 0, 0x17, 0x2A ]
171
- @config[:y_axis_text] = [ 0x074A, 0x0C8F, 0x021F, 0x123, 0x81, 0x0000 ]
172
- @config[:y_axis_text_pos] = [ 2, 2, 0, 0, 0x45, 0x17 ]
173
- end
174
- end
175
- end # class Chart
176
-
177
- end # module Writeexcel
1
+ # -*- coding: utf-8 -*-
2
+ ###############################################################################
3
+ #
4
+ # Bar - A writer class for Excel Bar charts.
5
+ #
6
+ # Used in conjunction with Chart.
7
+ #
8
+ # See formatting note in Chart.
9
+ #
10
+ # Copyright 2000-2010, John McNamara, jmcnamara@cpan.org
11
+ #
12
+ # original written in Perl by John McNamara
13
+ # converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
14
+ #
15
+
16
+ require 'writeexcel/chart'
17
+
18
+ module Writeexcel
19
+
20
+ class Chart
21
+
22
+ #
23
+ # ==SYNOPSIS
24
+ #
25
+ # To create a simple Excel file with a Bar chart using WriteExcel:
26
+ #
27
+ # #!/usr/bin/ruby -w
28
+ #
29
+ # require 'writeexcel'
30
+ #
31
+ # workbook = WriteExcel.new('chart.xls')
32
+ # worksheet = workbook.add_worksheet
33
+ #
34
+ # chart = workbook.add_chart(:type => 'Chart::Bar')
35
+ #
36
+ # # Configure the chart.
37
+ # chart.add_series(
38
+ # :categories => '=Sheet1!$A$2:$A$7',
39
+ # :values => '=Sheet1!$B$2:$B$7',
40
+ # )
41
+ #
42
+ # # Add the worksheet data the chart refers to.
43
+ # data = [
44
+ # [ 'Category', 2, 3, 4, 5, 6, 7 ],
45
+ # [ 'Value', 1, 4, 5, 2, 1, 5 ]
46
+ # ]
47
+ #
48
+ # worksheet.write('A1', data)
49
+ #
50
+ # workbook.close
51
+ #
52
+ # ==DESCRIPTION
53
+ #
54
+ # This module implements Bar charts for WriteExcel. The chart object is
55
+ # created via the Workbook add_chart method:
56
+ #
57
+ # chart = workbook.add_chart(:type => 'Chart::Bar')
58
+ #
59
+ # Once the object is created it can be configured via the following methods
60
+ # that are common to all chart classes:
61
+ #
62
+ # chart.add_series
63
+ # chart.set_x_axis
64
+ # chart.set_y_axis
65
+ # chart.set_title
66
+ #
67
+ # These methods are explained in detail in Chart section of WriteExcel.
68
+ # Class specific methods or settings, if any, are explained below.
69
+ #
70
+ # ==Bar Chart Methods
71
+ #
72
+ # There aren't currently any bar chart specific methods. See the TODO
73
+ # section of Chart of Writeexcel.
74
+ #
75
+ # ==EXAMPLE
76
+ #
77
+ # Here is a complete example that demonstrates most of the available
78
+ # features when creating a chart.
79
+ #
80
+ # #!/usr/bin/ruby -w
81
+ #
82
+ # require 'writeexcel'
83
+ #
84
+ # workbook = WriteExcel.new('chart_bar.xls')
85
+ # worksheet = workbook.add_worksheet
86
+ # bold = workbook.add_format(:bold => 1)
87
+ #
88
+ # # Add the worksheet data that the charts will refer to.
89
+ # headings = [ 'Number', 'Sample 1', 'Sample 2' ]
90
+ # data = [
91
+ # [ 2, 3, 4, 5, 6, 7 ],
92
+ # [ 1, 4, 5, 2, 1, 5 ],
93
+ # [ 3, 6, 7, 5, 4, 3 ]
94
+ # ]
95
+ #
96
+ # worksheet.write('A1', headings, bold)
97
+ # worksheet.write('A2', data)
98
+ #
99
+ # # Create a new chart object. In this case an embedded chart.
100
+ # chart = workbook.add_chart(:type => 'Chart::Bar', :embedded => 1)
101
+ #
102
+ # # Configure the first series. (Sample 1)
103
+ # chart.add_series(
104
+ # :name => 'Sample 1',
105
+ # :categories => '=Sheet1!$A$2:$A$7',
106
+ # :values => '=Sheet1!$B$2:$B$7',
107
+ # )
108
+ #
109
+ # # Configure the second series. (Sample 2)
110
+ # chart.add_series(
111
+ # :name => 'Sample 2',
112
+ # :categories => '=Sheet1!$A$2:$A$7',
113
+ # :values => '=Sheet1!$C$2:$C$7',
114
+ # )
115
+ #
116
+ # # Add a chart title and some axis labels.
117
+ # chart.set_title (:name => 'Results of sample analysis')
118
+ # chart.set_x_axis(:name => 'Test number')
119
+ # chart.set_y_axis(:name => 'Sample length (cm)')
120
+ #
121
+ # # Insert the chart into the worksheet (with an offset).
122
+ # worksheet.insert_chart('D2', chart, 25, 10)
123
+ #
124
+ # workbook.close
125
+ #
126
+ class Bar < Chart
127
+ ###############################################################################
128
+ #
129
+ # new()
130
+ #
131
+ #
132
+ def initialize(*args) # :nodoc:
133
+ super
134
+ @config[:x_axis_text] = [ 0x2D, 0x6D9, 0x5F, 0x1CC, 0x281, 0x0, 90 ]
135
+ @config[:x_axis_text_pos] = [ 2, 2, 0, 0, 0x17, 0x2A ]
136
+ @config[:y_axis_text] = [ 0x078A, 0x0DFC, 0x011D, 0x9C, 0x0081, 0x0000 ]
137
+ @config[:y_axis_text_pos] = [ 2, 2, 0, 0, 0x45, 0x17 ]
138
+ end
139
+
140
+ ###############################################################################
141
+ #
142
+ # _store_chart_type()
143
+ #
144
+ # Implementation of the abstract method from the specific chart class.
145
+ #
146
+ # Write the BAR chart BIFF record. Defines a bar or column chart type.
147
+ #
148
+ def store_chart_type # :nodoc:
149
+ record = 0x1017 # Record identifier.
150
+ length = 0x0006 # Number of bytes to follow.
151
+ pcOverlap = 0x0000 # Space between bars.
152
+ pcGap = 0x0096 # Space between cats.
153
+ grbit = 0x0001 # Option flags.
154
+
155
+ store_simple(record, length, pcOverlap, pcGap, grbit)
156
+ end
157
+
158
+ ###############################################################################
159
+ #
160
+ # _set_embedded_config_data()
161
+ #
162
+ # Override some of the default configuration data for an embedded chart.
163
+ #
164
+ def set_embedded_config_data # :nodoc:
165
+ # Set the parent configuration first.
166
+ super
167
+
168
+ # The axis positions are reversed for a bar chart so we change the config.
169
+ @config[:x_axis_text] = [ 0x57, 0x5BC, 0xB5, 0x214, 0x281, 0x0, 90 ]
170
+ @config[:x_axis_text_pos] = [ 2, 2, 0, 0, 0x17, 0x2A ]
171
+ @config[:y_axis_text] = [ 0x074A, 0x0C8F, 0x021F, 0x123, 0x81, 0x0000 ]
172
+ @config[:y_axis_text_pos] = [ 2, 2, 0, 0, 0x45, 0x17 ]
173
+ end
174
+ end
175
+ end # class Chart
176
+
177
+ end # module Writeexcel