summaryrefslogtreecommitdiffhomepage
path: root/examples/example.rb
blob: 8058b50b311ad663a4d7e19e2e0e94b824920147 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
#!/usr/bin/env ruby -w -s
# -*- coding: utf-8 -*-
require 'axlsx.rb'

p = Axlsx::Package.new
wb = p.workbook

#A Simple Workbook

wb.add_worksheet(:name => "Basic Worksheet") do |sheet|
  sheet.add_row ["First Column", "Second", "Third"]
  sheet.add_row [1, 2, 3]
end

#Using Custom Styles

wb.styles do |s|
  black_cell = s.add_style :bg_color => "00", :fg_color => "FF", :sz => 14, :alignment => { :horizontal=> :center }
  blue_cell =  s.add_style  :bg_color => "0000FF", :fg_color => "FF", :sz => 20, :alignment => { :horizontal=> :center }
  wb.add_worksheet(:name => "Custom Styles") do |sheet|
    sheet.add_row ["Text Autowidth", "Second", "Third"], :style => [black_cell, blue_cell, black_cell]
    sheet.add_row [1, 2, 3], :style => Axlsx::STYLE_THIN_BORDER
  end
end

##Using Custom Formatting and date1904
require 'date'
wb.styles do |s|
  date = s.add_style(:format_code => "yyyy-mm-dd", :border => Axlsx::STYLE_THIN_BORDER)
  padded = s.add_style(:format_code => "00#", :border => Axlsx::STYLE_THIN_BORDER)
  percent = s.add_style(:format_code => "0000%", :border => Axlsx::STYLE_THIN_BORDER)
  # wb.date1904 = true # Use the 1904 date system (Used by Excel for Mac < 2011)
  wb.add_worksheet(:name => "Formatting Data") do |sheet|
    sheet.add_row ["Custom Formatted Date", "Percent Formatted Float", "Padded Numbers"], :style => Axlsx::STYLE_THIN_BORDER
    sheet.add_row [Date::strptime('2012-01-19','%Y-%m-%d'), 0.2, 32], :style => [date, percent, padded]
  end
end

##Add an Image

wb.add_worksheet(:name => "Images") do |sheet|
  img = File.expand_path('examples/image1.jpeg')
  sheet.add_image(:image_src => img, :noSelect => true, :noMove => true) do |image|
    image.width=720
    image.height=666
    image.start_at 2, 2
  end
end

##Add an Image with a hyperlink

wb.add_worksheet(:name => "Image with Hyperlink") do |sheet|
  img = File.expand_path('examples/image1.jpeg')
  sheet.add_image(:image_src => img, :noSelect => true, :noMove => true, :hyperlink=>"http://axlsx.blogspot.com") do |image|
    image.width=720
    image.height=666
    image.hyperlink.tooltip = "Labeled Link"
    image.start_at 2, 2
  end
end

##Asian Language Support

wb.add_worksheet(:name => "日本語でのシート名") do |sheet|
  sheet.add_row ["日本語"]
  sheet.add_row ["华语/華語"]
  sheet.add_row ["한국어/조선말"]
end

##Styling Columns

wb.styles do |s|
  percent = s.add_style :num_fmt => 9
  wb.add_worksheet(:name => "Styling Columns") do |sheet|
    sheet.add_row ['col 1', 'col 2', 'col 3', 'col 4']
    sheet.add_row [1, 2, 0.3, 4]
    sheet.add_row [1, 2, 0.2, 4]
    sheet.add_row [1, 2, 0.1, 4]
    sheet.col_style 2, percent, :row_offset => 1
  end
end

##Styling Rows

wb.styles do |s|
  head = s.add_style :bg_color => "00", :fg_color => "FF"
  percent = s.add_style :num_fmt => 9
  wb.add_worksheet(:name => "Styling Rows") do |sheet|
    sheet.add_row ['col 1', 'col 2', 'col 3', 'col 4']
    sheet.add_row [1, 2, 0.3, 4]
    sheet.add_row [1, 2, 0.2, 4]
    sheet.add_row [1, 2, 0.1, 4]
    sheet.col_style 2, percent, :row_offset => 1
    sheet.row_style 0, head
  end
end

##Styling Cell Overrides

wb.add_worksheet(:name => "Cell Level Style Overrides") do |sheet|
  # cell level style overides when adding cells
  sheet.add_row ['col 1', 'col 2', 'col 3', 'col 4'], :sz => 16
  sheet.add_row [1, 2, 3, "=SUM(A2:C2)"]
  # cell level style overrides via sheet range
  sheet["A1:D1"].each { |c| c.color = "FF0000"}
  sheet['A1:D2'].each { |c| c.style = Axlsx::STYLE_THIN_BORDER }
end

##Using formula

wb.add_worksheet(:name => "Using Formulas") do |sheet|
  sheet.add_row ['col 1', 'col 2', 'col 3', 'col 4']
  sheet.add_row [1, 2, 3, "=SUM(A2:C2)"]
end

##Automatic cell types

wb.add_worksheet(:name => "Automatic cell types") do |sheet|
  sheet.add_row ["Date", "Time", "String", "Boolean", "Float", "Integer"]
  sheet.add_row [Date.today, Time.now, "value", true, 0.1, 1]
end

##Merging Cells.

wb.add_worksheet(:name => 'Merging Cells') do |sheet|
  # cell level style overides when adding cells
  sheet.add_row ["col 1", "col 2", "col 3", "col 4"], :sz => 16
  sheet.add_row [1, 2, 3, "=SUM(A2:C2)"]
  sheet.add_row [2, 3, 4, "=SUM(A3:C3)"]
  sheet.add_row ["total", "", "", "=SUM(D2:D3)"]
  sheet.merge_cells("A4:C4")
  sheet["A1:D1"].each { |c| c.color = "FF0000"}
  sheet["A1:D4"].each { |c| c.style = Axlsx::STYLE_THIN_BORDER }
end

##Generating A Bar Chart

wb.add_worksheet(:name => "Bar Chart") do |sheet|
  sheet.add_row ["A Simple Bar Chart"]
  sheet.add_row ["First", "Second", "Third"]
  sheet.add_row [1, 2, 3]
  sheet.add_chart(Axlsx::Bar3DChart, :start_at => "A4", :end_at => "F17") do |chart|
    chart.add_series :data => sheet["A3:C3"], :labels => sheet["A2:C2"], :title => sheet["A1"]
  end
end

##Generating A Pie Chart

wb.add_worksheet(:name => "Pie Chart") do |sheet|
  sheet.add_row ["First", "Second", "Third", "Fourth"]
  sheet.add_row [1, 2, 3, "=PRODUCT(A2:C2)"]
  sheet.add_chart(Axlsx::Pie3DChart, :start_at => [0,2], :end_at => [5, 15], :title => "example 3: Pie Chart") do |chart|
    chart.add_series :data => sheet["A2:D2"], :labels => sheet["A1:D1"]
  end
end

##Data over time

wb.add_worksheet(:name=>'Charting Dates') do |sheet|
   # cell level style overides when adding cells
  sheet.add_row ['Date', 'Value'], :sz => 16
  sheet.add_row [Time.now - (7*60*60*24), 3]
  sheet.add_row [Time.now - (6*60*60*24), 7]
  sheet.add_row [Time.now - (5*60*60*24), 18]
  sheet.add_row [Time.now - (4*60*60*24), 1]
  sheet.add_chart(Axlsx::Bar3DChart) do |chart|
    chart.start_at "B7"
    chart.end_at "H27"
    chart.add_series(:data => sheet["B2:B5"], :labels => sheet["A2:A5"], :title => sheet["B1"])
  end
end

##Generating A Line Chart

wb.add_worksheet(:name => "Line Chart") do |sheet|
  sheet.add_row ["First", 1, 5, 7, 9]
  sheet.add_row ["Second", 5, 2, 14, 9]
  sheet.add_chart(Axlsx::Line3DChart, :title => "example 6: Line Chart", :rotX => 30, :rotY => 20) do |chart|
    chart.start_at 0, 2
    chart.end_at 10, 15
    chart.add_series :data => sheet["B1:E1"], :title => sheet["A1"]
    chart.add_series :data => sheet["B2:E2"], :title => sheet["A2"]
  end
end

##Auto Filter

wb.add_worksheet(:name => "Auto Filter") do |sheet|
  sheet.add_row ["Build Matrix"]
  sheet.add_row ["Build", "Duration", "Finished", "Rvm"]
  sheet.add_row ["19.1", "1 min 32 sec", "about 10 hours ago", "1.8.7"]
  sheet.add_row ["19.2", "1 min 28 sec", "about 10 hours ago", "1.9.2"]
  sheet.add_row ["19.3", "1 min 35 sec", "about 10 hours ago", "1.9.3"]
  sheet.auto_filter = "A2:D5"
end

##Specifying Column Widths

wb.add_worksheet(:name => "custom column widths") do |sheet|
  sheet.add_row ["I use autowidth and am very wide", "I use a custom width and am narrow"]
  sheet.column_widths nil, 3
end

##Specify Page Margins for printing
margins = {:left => 3, :right => 3, :top => 1.2, :bottom => 1.2, :header => 0.7, :footer => 0.7}
wb.add_worksheet(:name => "print margins", :page_margins => margins) do |sheet|
  sheet.add_row ["this sheet uses customized page margins for printing"]
end

##Validate and Serialize

p.validate.each { |e| puts e.message }
p.serialize("example.xlsx")

s = p.to_stream()
File.open('example_streamed.xlsx', 'w') { |f| f.write(s.read) }


##Using Shared Strings
p.use_shared_strings = true
p.serialize("shared_strings_example.xlsx")