axlsx 1.1.0 → 1.2.0

data/examples/example.rb

@@ -1,71 +1,141 @@
 #!/usr/bin/env ruby -w -s
 # -*- coding: utf-8 -*-
-$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+# $LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+
+#```ruby
 require 'axlsx'
 
 p = Axlsx::Package.new
 wb = p.workbook
+#```
 
 #A Simple Workbook
 
+#```ruby
 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
 
+#```ruby
+# Each cell allows a single, predified style.
+# When using add_row, the value in the :style array at the same index as the cell's column will be applied to that cell.
+# Alternatively, you can apply a style to an entire row by using an integer value for :style.
+
 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|
+
+    # Applies the black_cell style to the first and third cell, and the blue_cell style to the second.
     sheet.add_row ["Text Autowidth", "Second", "Third"], :style => [black_cell, blue_cell, black_cell]
+
+    # Applies the thin border to all three cells
     sheet.add_row [1, 2, 3], :style => Axlsx::STYLE_THIN_BORDER
   end
 end
+#```
+
+##Styling Cell Overrides
+
+#```ruby
+#Some of the style attributes can also be set at the cell level. Cell level styles take precedence over Custom Styles shown in the previous example.
+
+wb.add_worksheet(:name => "Cell Level Style Overrides") do |sheet|
+
+  # this will set the font size for each cell.
+  sheet.add_row ['col 1', 'col 2', 'col 3', 'col 4'], :sz => 16
+
+  sheet.add_row [1, 2, 3, "=SUM(A2:C2)"]
+
+  # You can also apply cell style overrides to a range of cells
+  sheet["A1:D1"].each { |c| c.color = "FF0000" }
+  sheet['A1:D2'].each { |c| c.style = Axlsx::STYLE_THIN_BORDER }
+end
+#```
 
-#Using Custom Border Styles
+##Using Custom Border Styles
 
+#```ruby
+#Axlsx defines a thin border style, but you can easily create and use your own.
 wb.styles do |s|
-  red_border =  s.add_style :border => {:style=>:thin, :color =>"FFFF0000"}
-  blue_border =  s.add_style :border => {:style=>:thin, :color =>"FF0000FF"}
+  red_border =  s.add_style :border => { :style => :thick, :color =>"FFFF0000" }
+  blue_border =  s.add_style :border => { :style => :thick, :color =>"FF0000FF" }
 
   wb.add_worksheet(:name => "Custom Borders") do |sheet|
     sheet.add_row ["wrap", "me", "Up in Red"], :style => red_border
     sheet.add_row [1, 2, 3], :style => blue_border
   end
 end
+#```
 
 
-##Using Custom Formatting and date1904
-require 'date'
+##Styling Rows and Columns
+
+#```ruby
 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]
+  head = s.add_style :bg_color => "00", :fg_color => "FF"
+  percent = s.add_style :num_fmt => 9
+  wb.add_worksheet(:name => "Columns and Rows") do |sheet|
+    sheet.add_row ['col 1', 'col 2', 'col 3', 'col 4', 'col5']
+    sheet.add_row [1, 2, 0.3, 4, 5.0]
+    sheet.add_row [1, 2, 0.2, 4, 5.0]
+    sheet.add_row [1, 2, 0.1, 4, 5.0]
+
+    #apply the percent style to the column at index 2 skipping the first row.
+    sheet.col_style 2, percent, :row_offset => 1
+
+    # apply the head style to the first row.
+    sheet.row_style 0, head
+
+    #Hide the 5th column
+    sheet.column_info[4].hidden = true
+
+    #Set the second column outline level
+    sheet.column_info[1].outlineLevel = 2
+
+    sheet.rows[3].hidden = true
+    sheet.rows[1].outlineLevel = 2
   end
 end
+#```
 
 
-##Add an Image
+##Specifying Column Widths
 
-wb.add_worksheet(:name => "Images") do |sheet|
-  img = File.expand_path('../image1.jpeg', __FILE__)
-  sheet.add_image(:image_src => img, :noSelect => true, :noMove => true) do |image|
-    image.width=720
-    image.height=666
-    image.start_at 2, 2
-  end
+#```ruby
+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.add_row ['abcdefg', 'This is a very long text and should flow into the right cell', nil, 'xxx' ]
+  sheet.column_widths nil, 3, 5, nil
 end
+#```
+
+##Merging Cells.
+
+#```ruby
+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
+#```
 
 ##Add an Image with a hyperlink
 
+#```ruby
 wb.add_worksheet(:name => "Image with Hyperlink") do |sheet|
   img = File.expand_path('../image1.jpeg', __FILE__)
+  # specifying the :hyperlink option will add a hyper link to your image.
+  # @note - Numbers does not support this part of the specification.
   sheet.add_image(:image_src => img, :noSelect => true, :noMove => true, :hyperlink=>"http://axlsx.blogspot.com") do |image|
     image.width=720
     image.height=666
@@ -73,159 +143,129 @@ wb.add_worksheet(:name => "Image with Hyperlink") do |sheet|
     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
-
-##Hiding Columns
-
-wb.styles do |s|
-  percent = s.add_style :num_fmt => 9
-  wb.add_worksheet(:name => "Hidden Column") 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.column_info[1].hidden = true
-  end
-end
-
-##Styling Rows
+##Using Custom Formatting and date1904
 
+#```ruby
+require 'date'
 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
+  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
+#```
 
-##Styling Cell Overrides
+##Asian Language Support
 
-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 }
+#```ruby
+wb.add_worksheet(:name => "日本語でのシート名") do |sheet|
+  sheet.add_row ["日本語"]
+  sheet.add_row ["华语/華語"]
+  sheet.add_row ["한국어/조선말"]
 end
+#```
 
 ##Using formula
 
+#```ruby
 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
+#```
+
+##Auto Filter
+
+#```ruby
+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
+#```
 
 ##Automatic cell types
 
+#```ruby
 wb.add_worksheet(:name => "Automatic cell types") do |sheet|
+  date_format = wb.styles.add_style :format_code => 'YYYY-MM-DD'
+  time_format = wb.styles.add_style :format_code => 'hh:mm:ss'
   sheet.add_row ["Date", "Time", "String", "Boolean", "Float", "Integer"]
-  sheet.add_row [Date.today, Time.now, "value", true, 0.1, 1]
+  sheet.add_row [Date.today, Time.now, "value", true, 0.1, 1], :style => [date_format, time_format]
 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
 
+#```ruby
 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"]
+  %w(first second third).each { |label| sheet.add_row [label, rand(24)+1] }
+  sheet.add_chart(Axlsx::Bar3DChart, :start_at => "A6", :end_at => "F20") do |chart|
+    chart.add_series :data => sheet["B2:B4"], :labels => sheet["A2:A4"], :title => sheet["A1"]
   end
 end
+#```
 
 ##Hide Gridlines in chart
+
+#```ruby
 wb.add_worksheet(:name => "Chart With No Gridlines") 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"]
+  sheet.add_row ["Bar Chart without gridlines"]
+  %w(first second third).each { |label| sheet.add_row [label, rand(24)+1] }
+  sheet.add_chart(Axlsx::Bar3DChart, :start_at => "A6", :end_at => "F20") do |chart|
+    chart.add_series :data => sheet["B2:B4"], :labels => sheet["A2:A4"]
     chart.valAxis.gridlines = false
     chart.catAxis.gridlines = false
   end
 end
+#```
 
 ##Generating A Pie Chart
 
+#```ruby
 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"])
+  sheet.add_row ["Simple Pie Chart"]
+  %w(first second third).each { |label| sheet.add_row [label, rand(24)+1] }
+  sheet.add_chart(Axlsx::Pie3DChart, :start_at => [0,5], :end_at => [10, 20], :title => "example 3: Pie Chart") do |chart|
+    chart.add_series :data => sheet["B2:B4"], :labels => sheet["A2:A4"],  :colors => ['FF0000', '00FF00', '0000FF']
   end
 end
+#```
 
 ##Generating A Line Chart
 
+#```ruby
 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"]
+  sheet.add_row ["Simple Line Chart"]
+  sheet.add_row %w(first second)
+  4.times do
+    sheet.add_row [ rand(24)+1, rand(24)+1]
+  end
+  sheet.add_chart(Axlsx::Line3DChart, :title => "Simple Line Chart", :rotX => 30, :rotY => 20) do |chart|
+    chart.start_at 0, 5
+    chart.end_at 10, 20
+    chart.add_series :data => sheet["A3:A6"], :title => sheet["A2"]
+    chart.add_series :data => sheet["B3:B6"], :title => sheet["B2"]
+    chart.catAxis.title = 'X Axis'
+    chart.valAxis.title = 'Y Axis'
   end
 end
+#```
 
 ##Generating A Scatter Chart
 
+#```ruby
 wb.add_worksheet(:name => "Scatter Chart") do |sheet|
   sheet.add_row ["First",  1,  5,  7,  9]
   sheet.add_row ["",       1, 25, 49, 81]
@@ -238,81 +278,189 @@ wb.add_worksheet(:name => "Scatter Chart") do |sheet|
     chart.add_series :xData => sheet["B3:E3"], :yData => sheet["B4:E4"], :title => sheet["A3"]
   end
 end
+#```
 
-##Auto Filter
 
-wb.add_worksheet(:name => "Auto Filter") do |sheet|
+##Tables
+
+#```ruby
+wb.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.add_table "A2:D5", :name => 'Build Matrix'
 end
+#```
 
-##Tables
-
- wb.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.add_table "A2:D5", :name => 'Build Matrix'
- 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.add_row ['abcdefg', 'This is a very long text and should flow into the right cell', nil, 'xxx' ]
-  sheet.column_widths nil, 3, 5, nil
-end
 
 ##Fit to page printing
 
+#```ruby
 wb.add_worksheet(:name => "fit to page") do |sheet|
   sheet.add_row ['this all goes on one page']
   sheet.fit_to_page = true
 end
+##```
 
 
 ##Hide Gridlines in worksheet
+
+#```ruby
 wb.add_worksheet(:name => "No Gridlines") do |sheet|
   sheet.add_row ["This", "Sheet", "Hides", "Gridlines"]
   sheet.show_gridlines = false
 end
+##```
+
+#```ruby
+wb.add_worksheet(:name => "repeated header") do |sheet|
+  sheet.add_row %w(These Column Header Will Render On Every Printed Sheet)
+  200.times { sheet.add_row %w(1 2 3 4 5 6 7 8) }
+  wb.add_defined_name("'repeated header'!$1:$1", :local_sheet_id => sheet.index, :name => '_xlnm.Print_Titles') 
+end
+
+# Sheet Protection and excluding cells from locking.
+unlocked = wb.styles.add_style :locked => false
+wb.add_worksheet(:name => 'Sheet Protection') do |sheet|
+  sheet.sheet_protection.password = 'fish'
+  sheet.add_row [1, 2 ,3] # These cells will be locked
+  sheet.add_row [4, 5, 6], :style => unlocked # these cells will not!
+end
+
 
-##Specify Page Margins for printing
+##Specify page margins and other options for printing
+
+#```ruby
 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"]
+setup = {:fit_to_width => 1, :orientation => :landscape, :paper_width => "297mm", :paper_height => "210mm"}
+options = {:grid_lines => true, :headings => true, :horizontal_centered => true}
+wb.add_worksheet(:name => "print margins", :page_margins => margins, :page_setup => setup, :print_options => options) do |sheet|
+  sheet.add_row ["this sheet uses customized print settings"]
+end
+#```
+
+## Add Comments to your spreadsheet 
+#``` ruby
+wb.add_worksheet(:name => 'comments') do |sheet|
+  sheet.add_row ['Can we build it?']
+  sheet.add_comment :ref => 'A1', :author => 'Bob', :text => 'Yes We Can!'
+end
+
+## Frozen/Split panes
+## ``` ruby
+wb.add_worksheet(:name => 'fixed headers') do |sheet|
+ sheet.add_row(['',  (0..99).map { |i| "column header #{i}" }].flatten )
+  100.times.with_index { |index| sheet << ["row header", (0..index).to_a].flatten }
+  sheet.sheet_view.pane do |pane|
+    pane.top_left_cell = "B2"
+    pane.state = :frozen_split
+    pane.y_split = 1
+    pane.x_split = 1
+    pane.active_pane = :bottom_right
+  end
+end
+
+# conditional formatting
+#
+percent = wb.styles.add_style(:format_code => "0.00%", :border => Axlsx::STYLE_THIN_BORDER)
+money = wb.styles.add_style(:format_code => '0,000', :border => Axlsx::STYLE_THIN_BORDER)
+
+# define the style for conditional formatting
+profitable = wb.styles.add_style( :fg_color=>"FF428751",
+                                    :type => :dxf)
+
+wb.add_worksheet(:name => "Conditional 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 })
+end
+
+wb.add_worksheet(:name => "Conditional 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
+
+
+wb.add_worksheet(:name => "Conditional 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
+
+wb.add_worksheet(:name => "Conditional Format 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
 
 ##Validate and Serialize
 
-#p.validate.each { |e| puts e.message }
+#```ruby
+# Serialize directly to file
 p.serialize("example.xlsx")
 
+# or
+
+#Serialize to a stream
 s = p.to_stream()
 File.open('example_streamed.xlsx', 'w') { |f| f.write(s.read) }
-
+#```
 
 ##Using Shared Strings
+
+#```ruby
+# This is required by Numbers
 p.use_shared_strings = true
 p.serialize("shared_strings_example.xlsx")
+#```
 
 
 ##Disabling Autowidth
+
+#```ruby
 p = Axlsx::Package.new
 p.use_autowidth = false
 wb = p.workbook
-wb.add_worksheet(:name => "No Magick") do | sheet |
-  sheet.add_row ['oh look! no autowidth - and no magick loaded in your process']
+wb.add_worksheet(:name => "Manual Widths") do | sheet |
+  sheet.add_row ['oh look! no autowidth']
 end
 p.validate.each { |e| puts e.message }
 p.serialize("no-use_autowidth.xlsx")
+#```
+
 
 
 

data/examples/extractive.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby -w -s
+# -*- coding: utf-8 -*-
+
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
+require 'axlsx'
+
+data = [ ['oil-bbl',9591.411671,8860.714604,8237.936509,7700.523067,7231.831842,6819.307902,6453.297235,6126.251755,5832.182748,5566.276532,5324.618706,5103.992757,4901.730597,4715.600022,4543.718862,4384.488699,4236.543136,4098.707009,3969.963937,3849.430276,3736.33405,3629.997786,3529.824424,3435.28568,3345.912388,3261.286414,3181.033882,3104.819438,3032.341401,2963.327615,2897.531915,2834.731083,2774.722219,2717.320479,2662.357097,2609.677666,2559.140642,2510.616021,2463.984182,2419.134871,2375.966292,2334.384311,2294.301748,2255.637735,2218.317165,2182.270173,2147.431696,2113.741056,2081.141602,2049.580377,2019.007821,1989.377502,1960.645871,1932.772042,1905.71759,1879.446367,1853.924338,1829.119424,1805.001366,1781.541597,1758.713122,1736.490414,1714.849315,1693.766943,1673.22161,1653.192744,1633.660817,1614.607284,1596.014514,1577.865741,1560.145009,1542.837121,1525.927597,1509.402632,1493.249056,1477.454298,1462.006352,1446.893746,1432.105512,1417.631159,1403.460647,1389.584361,1375.993094,1362.678018,1349.630672,1336.842938,1324.307026,1312.015455,1299.961043,1288.136885,1276.536347,1265.153047,1253.980847,1243.013838,1232.246332,1221.672852,1211.288119,1201.087047,1191.064732,1181.216443,1171.537618,1162.023853,1152.670896,1143.474642,1134.431125,1125.536513,1116.787101,1108.179309,1099.709672,1091.37484,1083.171571,1075.096725,1067.147265,1059.320247,1051.612821,1044.022223,1036.545778,1029.180889,1021.92504,1014.775789],
+
+['gas-mcf', 940970.153,836556.732,748476.939,673307.64,608520.158,552204.935,502892.3,459432.263,420911.806,386596.658,355889.491,328299.357,303418.988,280907.679,260478.232,241886.857,224925.287,209414.552,195200.029,182147.455,170139.707,159074.174,148860.596,139419.282,130679.626,122578.864,115061.035,108076.1,101579.19,95529.972,89892.104,84632.762,79722.24,75133.597,70842.349,66826.213,63064.865,59539.742,56233.86,53131.662,50218.869,47482.365,44910.082,42490.907,40214.588,38071.662,36053.382,34151.656,32358.989,30668.434,29073.545,27568.334,26147.237,24805.079,23537.041,22338.633,21205.67,20134.246,19120.717,18161.677,17253.941,16394.533,15580.663,14809.724,14079.269,13387.006,12730.786,12108.59,11518.524,10958.809,10427.774,9923.847,9445.55,8991.492,8560.364,8150.934,7762.041,7392.59,7041.551,6707.951,6390.874,6089.452,5802.871,5530.358,5271.185,5024.664,4790.145,4567.013,4354.687,4152.618,3960.286,3777.198,3602.889,3436.919,3278.87,3128.347,2984.976,2848.401,2718.287,2594.316,2476.184,2363.606,2256.309,2154.037,2056.545,1963.599,1874.982,1790.482,1709.903,1633.054,1559.758,1489.844,1423.151,1359.525,1298.821,1240.899,1185.628,1132.883,1082.544,1034.499],
+
+['water-bbl',940.97,836.557,748.477,673.308,608.52,552.205,502.892,459.432,420.912,386.597,355.889,328.299,303.419,280.908,260.478,241.887,224.925,209.415,195.2,182.147,170.14,159.074,148.861,139.419,130.68,122.579,115.061,108.076,101.579,95.53,89.892,84.633,79.722,75.134,70.842,66.826,63.065,59.54,56.234,53.132,50.219,47.482,44.91,42.491,40.215,38.072,36.053,34.152,32.359,30.668,29.074,27.568,26.147,24.805,23.537,22.339,21.206,20.134,19.121,18.162,17.254,16.395,15.581,14.81,14.079,13.387,12.731,12.109,11.519,10.959,10.428,9.924,9.446,8.991,8.56,8.151,7.762,7.393,7.042,6.708,6.391,6.089,5.803,5.53,5.271,5.025,4.79,4.567,4.355,4.153,3.96,3.777,3.603,3.437,3.279,3.128,2.985,2.848,2.718,2.594,2.476,2.364,2.256,2.154,2.057,1.964,1.875,1.79,1.71,1.633,1.56,1.49,1.423,1.36,1.299,1.241,1.186,1.133,1.083,1.034] ]
+
+p = Axlsx::Package.new
+wb = p.workbook
+wb.add_worksheet(:name => 'volumes') do |ws|
+
+  # perspective, rotX and rotY flatten the 3D chart
+  # hPercent sets the chart height to 100%
+  chart = ws.add_chart(Axlsx::Line3DChart, :perspective => 0, :hPercent => 100, :rotX => 0, :rotY => 0, :start_at => "A4", :end_at => 'M44', :title => 'Monthly forcast for Type Curve Gas secondary - gross ngl')
+
+  # Set up log based scaling and appropriate min/max values for Y axis
+  chart.valAxis.scaling.logBase = 10
+  chart.valAxis.scaling.min = 0.1
+  chart.valAxis.scaling.max = 10000000.0
+
+  # No poing in showing the series axis labels as the chart is flattened!
+  chart.serAxis.delete = true
+
+  # Knock the catAxis labels down to the forced min.
+  chart.catAxis.crosses = :min
+
+  # set up cat labels / markes to show every 12th item
+  chart.catAxis.tickLblSkip = 12
+  chart.catAxis.tickMarkSkip = 12
+
+  #rgb colors for our data series
+  colors = ['00FF00', 'FF0000', '0000FF']
+
+  data.each_with_index do |value, index|
+    ws.add_row value
+    chart.add_series :data => ws.rows.last.cells[(1..value.size-1)], :labels => (0..value.size).map{ |i| i }, :title => ws.rows.last.cells.first, :color => colors[index]
+  end
+end
+
+p.serialize 'extractive.xlsx'