From 0a8c8cde8bf55d2f0f3b5ae26e38d7d4bda8a625 Mon Sep 17 00:00:00 2001 From: Randy Morgan Date: Mon, 21 Nov 2011 19:46:07 +0900 Subject: Readme update with better examples --- doc/file.README.html | 128 ++++++++++++++++++++++++--------------------------- 1 file changed, 60 insertions(+), 68 deletions(-) (limited to 'doc/file.README.html') diff --git a/doc/file.README.html b/doc/file.README.html index 2024bfa2..10377a44 100644 --- a/doc/file.README.html +++ b/doc/file.README.html @@ -92,93 +92,85 @@ It enables the you to generate 100% valid xlsx files that include customised sty

Usage

-

Simple Workbook

- -
 p = Axlsx::Package.new do |package|
-   package.workbook.add_worksheet do |sheet|
-     sheet.add_row ["First", "Second", "Third"]
-     sheet.add_row [1, 2, 3]
-   end
-   package.serialize("example1.xlsx")
- end  
+
 require 'rubygems'
+ require 'axlsx'
 

 
-
Generating A Bar Chart

+
A Simple Workbook

 
-
 p = Axlsx::Package.new do |package|
-   package.workbook.add_worksheet do |sheet|
-     sheet.add_row ["First", "Second", "Third"]
-     sheet.add_row [1, 2, 3]
-     sheet.add_chart(Axlsx::Bar3DChart, :start_at => [0,2], :end_at => [5, 15], :title=>"example 1: Chart") do |chart|
-       chart.add_series :data=>sheet.rows.last.cells, :labels=> sheet.rows.first.cells
-     end
-   end
-   package.serialize("example1.xlsx")
- end  
+
  p = Axlsx::Package.new
+  p.workbook.add_worksheet do |sheet|
+    sheet.add_row ["First", "Second", "Third"]
+    sheet.add_row [1, 2, 3]
+  end
+  p.serialize("example1.xlsx")
 

 
-
Generating A Pie Chart

+
Generating A Bar Chart

 
-
 p = Axlsx::Package.new do |package|
-   package.workbook.add_worksheet do |sheet|
-     sheet.add_row ["First", "Second", "Third"]
-     sheet.add_row [1, 2, 3]
-     sheet.add_chart(Axlsx::Pie3DChart, :start_at => [0,2], :end_at => [5, 15], :title=>"example 2: Pie Chart") do |chart|
-       chart.add_series :data=>sheet.rows.last.cells, :labels=> sheet.rows.first.cells
-     end
+
 p = Axlsx::Package.new
+ p.workbook.add_worksheet do |sheet|
+   sheet.add_row ["First", "Second", "Third"]
+   sheet.add_row [1, 2, 3]
+   sheet.add_chart(Axlsx::Bar3DChart, :start_at => [0,2], :end_at => [5, 15], :title=>"example 1: Chart") do |chart|
+     chart.add_series :data=>sheet.rows.last.cells, :labels=> sheet.rows.first.cells
    end
-   package.serialize("example3.xlsx")
  end  
+ p.serialize("example2.xlsx")
 

 
-
Using Custom Styles

+
Generating A Pie Chart

 
-
 p = Axlsx::Package.new do |package|
-   style_options = { :bg_color => "FF000000", :fg_color => "FFFFFFFF", :sz=>14, :alignment => { :horizontal=> :center } }
-   header_style = package.workbook.styles.add_style style_options
-   package.workbook.add_worksheet do |sheet|
-     sheet.add_row ["Text Autowidth", "Second", "Third"], :style => header_style
-     sheet.add_row [1, 2, 3], :style => Axlsx::STYLE_THIN_BORDER
+
 p = Axlsx::Package.new
+ p.workbook.add_worksheet do |sheet|
+   sheet.add_row ["First", "Second", "Third"]
+   sheet.add_row [1, 2, 3]
+   sheet.add_chart(Axlsx::Pie3DChart, :start_at => [0,2], :end_at => [5, 15], :title=>"example 2: Pie Chart") do |chart|
+     chart.add_series :data=>sheet.rows.last.cells, :labels=> sheet.rows.first.cells
    end
-   package.serialize("example3.xlsx")
  end  
+ p.serialize("example3.xlsx")
 

 
-
Cell Specifc Styles

-
-
 p = Axlsx::Package.new do |package|
-
-   black_cell_spec = { :bg_color => "FF000000", :fg_color => "FFFFFFFF", :sz=>14, :alignment => { :horizontal=> :center } }
-   blue_cell_spec = { :bg_color => "FF0000FF", :fg_color => "FFFFFFFF", :sz=>14, :alignment => { :horizontal=> :center } }
-
-   black_cell = package.workbook.styles.add_style black_cell_spec
-   blue_cell = package.workbook.styles.add_style blue_cell_spec
-
-   # date1904 support. uncomment the line below if you are working on a mac.
-   # package.workbook.date1904 = true 
+
Using Custom Styles

+
+
 p = Axlsx::Package.new
+ wb = p.workbook
+ black_cell = wb.styles.add_style :bg_color => "FF000000", :fg_color => "FFFFFFFF", :sz=>14, :alignment => { :horizontal=> :center }
+ blue_cell = wb.styles.add_style  :bg_color => "FF0000FF", :fg_color => "FFFFFFFF", :sz=>14, :alignment => { :horizontal=> :center }
+ wb.add_worksheet 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
+ p.serialize("example4.xlsx")
+

 
-   package.workbook.add_worksheet 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
-   package.serialize("example3.xlsx")
- end  
+
Using Custom Formatting and date1904

+
+
 p = Axlsx::Package.new
+ wb = p.workbook
+ date = wb.styles.add_style :format_code=>"yyyy-mm-dd", :border => Axlsx::STYLE_THIN_BORDER
+ padded = wb.styles.add_style :format_code=>"00#", :border => Axlsx::STYLE_THIN_BORDER
+ percent = wb.styles.add_style :format_code=>"0%", :border => Axlsx::STYLE_THIN_BORDER
+ wb.date1904 = true # required for generation on mac
+ wb.add_worksheet do |sheet|
+   sheet.add_row ["Custom Formatted Date", "Percent Formatted Float", "Padded Numbers"], :style => Axlsx::STYLE_THIN_BORDER
+   sheet.add_row [Time.now, 0.2, 32], :style => [date, percent, padded]
+ end
+ p.serialize("example5.xlsx")
 

 
-
Number and Date formatting

+
Validation

 
-
 p = Axlsx::Package.new do |package|
-   date = package.workbook.styles.add_style :format_code=>"yyyy-mm-dd", :border => Axlsx::STYLE_THIN_BORDER
-   padded = package.workbook.styles.add_style :format_code=>"00#", :border => Axlsx::STYLE_THIN_BORDER
-   percent = package.workbook.styles.add_style :format_code=>"0%", :border => Axlsx::STYLE_THIN_BORDER
+
 p = Axlsx::Package.new
+ p.workbook.add_worksheet do |sheet|
+   sheet.add_row ["First", "Second", "Third"]
+   sheet.add_row [1, 2, 3]
+ end
 
-   package.workbook.add_worksheet do |sheet|
-     sheet.add_row
-     sheet.add_row ["Custom Formatted Date", "Percent Formatted Float", "Padded Numbers"], :style => Axlsx::STYLE_THIN_BORDER
-     sheet.add_row [Time.now, 0.2, 32], :style => [date, percent, padded]
-   end
-   package.serialize("example5.xlsx")
- end  
+ p.validate.each do |error|
+   puts error.inspect
+ end
 

 
 
Documentation

@@ -213,7 +205,7 @@ licensed under the MIT license. Please see the 
     
     
-- 
cgit v1.2.3