bonio-axlsx 2.2.1

data/Rakefile

@@ -0,0 +1,30 @@
+require File.expand_path(File.dirname(__FILE__) + '/lib/axlsx/version.rb')
+
+task :build => :gendoc do
+  system "gem build axlsx.gemspec"
+end
+
+task :benchmark do
+  require File.expand_path(File.dirname(__FILE__) + '/test/benchmark.rb')
+end
+
+task :gendoc do
+  #puts 'yard doc generation disabled until JRuby build native extensions for redcarpet or yard removes the dependency.'
+  system "yardoc"
+  system "yard stats --list-undoc"
+end
+
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/tc_*.rb']
+  t.verbose = false
+  t.warning = true
+end
+
+task :release => :build do
+  system "gem push axlsx-#{Axlsx::VERSION}.gem"
+end
+
+task :default => :test

data/examples/2010_comments.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+
+#```ruby
+require 'axlsx'
+p = Axlsx::Package.new
+p.workbook.add_worksheet(:name => 'Excel 2010 comments') do |sheet|
+  sheet.add_row ['Cell with visible comment']
+  sheet.add_row
+  sheet.add_row
+  sheet.add_row ['Cell with hidden comment']
+
+  sheet.add_comment :ref => 'A1', :author => 'XXX', :text => 'Visibile'
+  sheet.add_comment :ref => 'A4', :author => 'XXX', :text => 'Hidden', :visible => false
+end
+p.serialize('excel_2010_comment_test.xlsx')

data/examples/anchor_swapping.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+xls = Axlsx::Package.new
+wb = xls.workbook
+wb.add_worksheet do |ws|
+  img = File.expand_path('../image1.jpeg', __FILE__)
+  ws.add_image(:image_src => img) do |image|
+    image.start_at 2, 2
+    image.end_at 5, 5
+  end
+end
+wb.add_worksheet do |ws|
+  img = File.expand_path('../image1.jpeg', __FILE__)
+  ws.add_image(:image_src => img, :start_at => "B2") do |image|
+    image.width = 70
+    image.height = 50
+  end
+end
+wb.add_worksheet do |ws|
+  img = File.expand_path('../image1.jpeg', __FILE__)
+  ws.add_image(:image_src => img, :start_at => [1,1]) do |image|
+    image.end_at "E7"
+  end
+end
+
+
+
+xls.serialize 'anchor.xlsx'

data/examples/auto_filter.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+Axlsx::Package.new do |p|
+  p.workbook.add_worksheet(:name => "Table") 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'
+    sheet.auto_filter.add_column 3, :filters, :filter_items => ['1.9.2']
+  end
+  p.workbook.add_worksheet(:name => "Table 2") 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'
+    sheet.auto_filter.add_column 3, :filters, :filter_items => ['1.9.2']
+  end
+end.serialize('auto_filter.xlsx')

data/examples/basic_charts.rb

@@ -0,0 +1,58 @@
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+p = Axlsx::Package.new
+wb = p.workbook
+
+# Pie Chart
+wb.add_worksheet(:name => "Pie Chart") do |sheet|
+  sheet.add_row ["First", "Second", "Third", "Fourth"]
+  sheet.add_row [1, 2, 3, 4]
+  sheet.add_chart(Axlsx::Pie3DChart, :start_at => [0,2], :end_at => [5, 15], :title=> 'dark corner here') do |chart|
+    chart.add_series :data => sheet["A2:D2"], :labels => sheet["A1:D1"]
+    chart.d_lbls.show_val = true
+    chart.d_lbls.show_percent = true
+    chart.d_lbls.d_lbl_pos = :outEnd
+    chart.d_lbls.show_leader_lines = true
+  end
+end
+
+# line chart
+ wb.add_worksheet(:name => "Line Chart") do |sheet|
+  sheet.add_row ['1', '2', '3', '4']
+  sheet.add_row [1, 2, 3, '=sum(A2:C2)']
+  sheet.add_chart(Axlsx::Line3DChart, :start_at => [0,2], :end_at => [5, 15], :title => "Chart") do |chart|
+    chart.add_series :data => sheet["A2:D2"], :labels => sheet["A1:D1"], :title => 'bob'
+    chart.d_lbls.show_val = true
+    chart.d_lbls.show_cat_name = true
+    chart.catAxis.tick_lbl_pos = :none
+
+  end
+ end
+
+# 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"]
+    chart.valAxis.label_rotation = -45
+    chart.catAxis.label_rotation = 45
+    chart.d_lbls.d_lbl_pos = :outEnd
+    chart.d_lbls.show_val = true
+
+    chart.catAxis.tick_lbl_pos = :none
+  end
+ end
+
+# specifying colors and title
+wb.add_worksheet(:name => "Colored 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 => ["A1:D1"], :colors => ['FF0000', '00FF00', '0000FF']
+  end
+end
+
+p.serialize('basic_charts.xlsx')
+

data/examples/chart_colors.rb

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+
+p = Axlsx::Package.new
+wb = p.workbook
+
+##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.5]
+  sheet.add_chart(Axlsx::Bar3DChart, :start_at => "A4", :end_at => "F17", :title => sheet["A1"]) do |chart|
+    chart.add_series :data => sheet["A3:C3"], :labels => sheet["A2:C2"], :colors => ['FF0000', '00FF00', '0000FF'], :color => "000000"
+    chart.valAxis.label_rotation = -45
+    chart.catAxis.label_rotation = 45
+  end
+end
+
+##Generating A Bar Chart without data in the sheet
+
+wb.add_worksheet(:name => "Hard Bar Chart") do |sheet|
+  sheet.add_chart(Axlsx::Bar3DChart, :start_at => "A4", :end_at => "F17", :title => "hard code chart") do |chart|
+    chart.add_series :data => [1,3,5], :labels => ['a', 'b', 'c'], :colors => ['FF0000', '00FF00', '0000FF']
+    chart.valAxis.label_rotation = -45
+    chart.catAxis.label_rotation = 45
+  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"], :colors => ['FF0000', '00FF00', '0000FF', '000000']
+   end
+ end
+
+# 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 => 30) do |chart|
+    chart.start_at 0, 2
+    chart.end_at 10, 15
+    chart.add_series :data => sheet["B1:E1"], :title => sheet["A1"], :color => "FF0000"
+    chart.add_series :data => sheet["B2:E2"], :title => sheet["A2"], :color => "00FF00"
+  end
+end
+
+wb.add_worksheet(:name => 'Line Chart with Axis colors') 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 7: Flat Line Chart", :rot_x => 0, :perspective => 0) do |chart|
+    chart.valAxis.color = "FFFF00"
+    chart.catAxis.color = "00FFFF"
+    chart.serAxis.delete = true
+    chart.start_at 0, 2
+    chart.end_at 10, 15
+    chart.add_series :data => sheet["B1:E1"], :title => sheet["A1"], :color => "FF0000"
+    chart.add_series :data => sheet["B2:E2"], :title => sheet["A2"], :color => "00FF00"
+  end
+
+end
+
+##Generating A Scatter Chart
+
+ wb.add_worksheet(:name => "Scatter Chart") do |sheet|
+   sheet.add_row ["First",  1,  5,  7,  9]
+   sheet.add_row ["",       1, 25, 49, 81]
+   sheet.add_row ["Second", 5,  2, 14,  9]
+   sheet.add_row ["",       5, 10, 15, 20]
+   sheet.add_chart(Axlsx::ScatterChart, :title => "example 7: Scatter Chart") do |chart|
+     chart.start_at 0, 4
+     chart.end_at 10, 19
+     chart.add_series :xData => sheet["B1:E1"], :yData => sheet["B2:E2"], :title => sheet["A1"], :color => '00FF00'
+     chart.add_series :xData => sheet["B3:E3"], :yData => sheet["B4:E4"], :title => sheet["A3"], :color => 'FF0000'
+   end
+ end
+
+
+p.validate.each { |e| puts e.message }
+p.serialize 'chart_colors.xlsx'

data/examples/colored_links.rb

@@ -0,0 +1,59 @@
+require 'axlsx' 
+
+############################### 
+# Function to output results data row to summary spreadsheet 
+def outputRow (sid, type) 
+
+  $sumSheet.add_row [ sid, type, "1", "2", "3", "4", "5" ], :style => $black_cell 
+
+  if sid.odd?
+    link = "A#{$curRow}" 
+    puts "outputRow: sid: #{sid}, link: #{link}" 
+    # Setting the style for the link will apply the xf that we created in the Main Program block
+    $sumSheet[link].style = $blue_link
+    $sumSheet.add_hyperlink :location => "'Log'!A#{$curRow}", :target => :sheet, :ref => link 
+  end
+  $curRow += 1 
+end 
+
+############################## 
+#   Main Program 
+
+$package = Axlsx::Package.new 
+$workbook = $package.workbook 
+##  We want to create our sytles outside of the outputRow method
+#   Each style only needs to be declared once in the workbook.
+$workbook.styles do |s|
+  $black_cell = s.add_style :sz => 10, :alignment => { :horizontal=> :center } 
+  $blue_link = s.add_style :fg_color => '0000FF'
+end 
+
+
+# Create summary sheet 
+$sumSheet = $workbook.add_worksheet(:name => 'Summary') 
+$sumSheet.add_row ["Test Results"], :sz => 16 
+$sumSheet.add_row 
+$sumSheet.add_row 
+$sumSheet.add_row ["Note: Blue cells below are links to the Log sheet"], :sz => 10 
+$sumSheet.add_row 
+$workbook.styles do |s| 
+  black_cell = s.add_style :sz => 14, :alignment => { :horizontal=> :center } 
+  $sumSheet.add_row ["ID","Type","Match","Mismatch","Diffs","Errors","Result"], :style => black_cell 
+end 
+$sumSheet.column_widths 10, 10, 10, 11, 10, 10, 10 
+
+# Starting data row in summary spreadsheet (after header info) 
+$curRow = 7 
+
+# Create Log Sheet 
+$logSheet = $workbook.add_worksheet(:name => 'Log') 
+$logSheet.column_widths 10 
+$logSheet.add_row ['Log Detail'], :sz => 16 
+$logSheet.add_row 
+
+# Add rows to summary sheet 
+for i in 1..10 do 
+  outputRow(i, 'test') 
+end 
+
+$package.serialize 'where_is_my_color.xlsx'

data/examples/conditional_formatting/example_conditional_formatting.rb

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+
+p = Axlsx::Package.new
+book = p.workbook
+
+# define your regular styles
+percent = book.styles.add_style(:format_code => "0.00%", :border => Axlsx::STYLE_THIN_BORDER)
+money = book.styles.add_style(:format_code => '0,000', :border => Axlsx::STYLE_THIN_BORDER)
+status = book.styles.add_style(:border => Axlsx::STYLE_THIN_BORDER)
+
+# define the style for conditional formatting
+profitable = book.styles.add_style( :fg_color => "428751", :type => :dxf )
+unprofitable = book.styles.add_style( :fg_color => "FF0000", :type => :dxf )
+
+book.add_worksheet(:name => "Cell Is") do |ws|
+
+  # Generate 20 rows of data
+  ws.add_row ["Previous Year Quarterly Profits (JPY)"]
+  ws.add_row ["Quarter", "Profit", "% of Total"]
+  offset = 3
+  rows = 20
+  offset.upto(rows + offset) do |i|
+    ws.add_row ["Q#{i}", 10000*((rows/2-i) * (rows/2-i)), "=100*B#{i}/SUM(B3:B#{rows+offset})"], :style=>[nil, money, percent]
+  end
+
+# Apply conditional formatting to range B3:B100 in the worksheet
+  ws.add_conditional_formatting("B3:B100", { :type => :cellIs, :operator => :greaterThan, :formula => "100000", :dxfId => profitable, :priority => 1 })
+# Apply conditional using the between operator; NOTE: supply an array to :formula for between/notBetween
+  ws.add_conditional_formatting("C3:C100", { :type => :cellIs, :operator => :between, :formula => ["0.00%","100.00%"], :dxfId => unprofitable, :priority => 1 })
+end
+
+book.add_worksheet(:name => "Color Scale") do |ws|
+  ws.add_row ["Previous Year Quarterly Profits (JPY)"]
+  ws.add_row ["Quarter", "Profit", "% of Total"]
+  offset = 3
+  rows = 20
+  offset.upto(rows + offset) do |i|
+    ws.add_row ["Q#{i}", 10000*((rows/2-i) * (rows/2-i)), "=100*B#{i}/SUM(B3:B#{rows+offset})"], :style=>[nil, money, percent]
+  end
+# Apply conditional formatting to range B3:B100 in the worksheet
+  color_scale = Axlsx::ColorScale.new
+  ws.add_conditional_formatting("B3:B100", { :type => :colorScale, :operator => :greaterThan, :formula => "100000", :dxfId => profitable, :priority => 1, :color_scale => color_scale })
+end
+
+
+book.add_worksheet(:name => "Data Bar") do |ws|
+  ws.add_row ["Previous Year Quarterly Profits (JPY)"]
+  ws.add_row ["Quarter", "Profit", "% of Total"]
+  offset = 3
+  rows = 20
+  offset.upto(rows + offset) do |i|
+    ws.add_row ["Q#{i}", 10000*((rows/2-i) * (rows/2-i)), "=100*B#{i}/SUM(B3:B#{rows+offset})"], :style=>[nil, money, percent]
+  end
+# Apply conditional formatting to range B3:B100 in the worksheet
+  data_bar = Axlsx::DataBar.new
+  ws.add_conditional_formatting("B3:B100", { :type => :dataBar, :dxfId => profitable, :priority => 1, :data_bar => data_bar })
+end
+
+book.add_worksheet(:name => "Icon Set") do |ws|
+  ws.add_row ["Previous Year Quarterly Profits (JPY)"]
+  ws.add_row ["Quarter", "Profit", "% of Total"]
+  offset = 3
+  rows = 20
+  offset.upto(rows + offset) do |i|
+    ws.add_row ["Q#{i}", 10000*((rows/2-i) * (rows/2-i)), "=100*B#{i}/SUM(B3:B#{rows+offset})"], :style=>[nil, money, percent]
+  end
+# Apply conditional formatting to range B3:B100 in the worksheet
+  icon_set = Axlsx::IconSet.new
+  ws.add_conditional_formatting("B3:B100", { :type => :iconSet, :dxfId => profitable, :priority => 1, :icon_set => icon_set })
+end
+
+book.add_worksheet(:name => "Contains Text") do |ws|
+  ws.add_row ["Previous Year Quarterly Profits (JPY)"]
+  ws.add_row ["Quarter", "Profit", "% of Total", "Status"]
+  offset = 3
+  rows = 20
+  offset.upto(rows + offset) do |i|
+    ws.add_row ["Q#{i}", 10000*((rows/2-i) * (rows/2-i)), "=100*B#{i}/SUM(B3:B#{rows+offset})", (10000*((rows/2-i) * (rows/2-i))) > 100000 ? "PROFIT" : "LOSS"], :style=>[nil, money, percent, status]
+  end
+
+# Apply conditional formatting to range D3:D100 in the worksheet
+  ws.add_conditional_formatting("D3:D100", { :type => :containsText, :operator => :equal, :text => "PROFIT", :dxfId => profitable, :priority => 1 })
+  ws.add_conditional_formatting("D3:D100", { :type => :containsText, :operator => :equal, :text => "LOSS", :dxfId => unprofitable, :priority => 1 })
+end
+
+p.serialize('example_conditional_formatting.xlsx')

data/examples/conditional_formatting/getting_barred.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+p = Axlsx::Package.new
+p.workbook do |wb|
+  # define your regular styles
+  styles = wb.styles
+  title = styles.add_style :sz => 15, :b => true, :u => true
+  default = styles.add_style :border => Axlsx::STYLE_THIN_BORDER
+  header = styles.add_style :bg_color => '00', :fg_color => 'FF', :b => true
+  money = styles.add_style :format_code => '#,###,##0', :border => Axlsx::STYLE_THIN_BORDER
+  percent = styles.add_style :num_fmt => Axlsx::NUM_FMT_PERCENT, :border => Axlsx::STYLE_THIN_BORDER
+
+  # define the style for conditional formatting - its the :dxf bit that counts!
+  profitable =  styles.add_style :fg_color => 'FF428751', :sz => 12, :type => :dxf, :b => true
+
+  wb.add_worksheet(:name => 'Data Bar Conditional Formatting') do  |ws|
+    ws.add_row ['A$$le Q1 Revenue Historical Analysis (USD)'], :style => title
+    ws.add_row
+    ws.add_row ['Quarter', 'Profit', '% of Total'], :style => header
+    ws.add_row ['Q1-2010', '15680000000', '=B4/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2011', '26740000000', '=B5/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2012', '46330000000', '=B6/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2013(est)', '72230000000', '=B7/SUM(B4:B7)'], :style => [default, money, percent]
+
+    ws.merge_cells 'A1:C1'
+
+    # Apply conditional formatting to range B4:B7 in the worksheet
+    data_bar = Axlsx::DataBar.new
+    ws.add_conditional_formatting 'B4:B7', { :type => :dataBar,
+                                             :dxfId => profitable,
+                                             :priority => 1,
+                                             :data_bar => data_bar }
+  end
+end
+p.serialize 'getting_barred.xlsx'

data/examples/conditional_formatting/hitting_the_high_notes.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+p = Axlsx::Package.new
+p.workbook do |wb|
+  # define your regular styles
+  styles = wb.styles
+  title = styles.add_style :sz => 15, :b => true, :u => true
+  default = styles.add_style :border => Axlsx::STYLE_THIN_BORDER
+  header = styles.add_style :bg_color => '00', :fg_color => 'FF', :b => true
+  money = styles.add_style :format_code => '###,###,###,##0', :border => Axlsx::STYLE_THIN_BORDER
+  percent = styles.add_style :num_fmt => Axlsx::NUM_FMT_PERCENT, :border => Axlsx::STYLE_THIN_BORDER
+
+  # define the style for conditional formatting - its the :dxf bit that counts!
+  profitable = styles.add_style :fg_color => 'FF428751', :sz => 12, :type => :dxf, :b => true
+
+  wb.add_worksheet(:name => 'The High Notes') do  |ws|
+    ws.add_row ['A$$le Q1 Revenue Historical Analysis (USD)'], :style => title
+    ws.add_row
+    ws.add_row ['Quarter', 'Profit', '% of Total'], :style => header
+    ws.add_row ['Q1-2010', '15680000000', '=B4/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2011', '26740000000', '=B5/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2012', '46330000000', '=B6/SUM(B4:B7)'], :style => [default, money, percent]
+    ws.add_row ['Q1-2013(est)', '72230000000', '=B7/SUM(B4:B7)'], :style => [default, money, percent]
+
+    ws.merge_cells 'A1:C1'
+
+    # Apply conditional formatting to range B4:B7 in the worksheet
+    ws.add_conditional_formatting 'B4:B7', { :type => :cellIs,
+                                             :operator => :greaterThan,
+                                             :formula => '27000000000',
+                                             :dxfId => profitable,
+                                             :priority => 1 }
+  end
+end
+p.serialize 'the_high_notes.xlsx'