diff options
| author | Randy Morgan <[email protected]> | 2011-11-21 19:46:07 +0900 |
|---|---|---|
| committer | Randy Morgan <[email protected]> | 2011-11-21 19:46:07 +0900 |
| commit | 0a8c8cde8bf55d2f0f3b5ae26e38d7d4bda8a625 (patch) | |
| tree | e0daa611bff8ef079f36d9fab7108ec8d63b9ee7 /README.md | |
| parent | bfdd6993737f4a7294da00e25d03651cf03add5d (diff) | |
| download | caxlsx-0a8c8cde8bf55d2f0f3b5ae26e38d7d4bda8a625.tar.gz caxlsx-0a8c8cde8bf55d2f0f3b5ae26e38d7d4bda8a625.zip | |
Readme update with better examples
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 143 |
1 files changed, 66 insertions, 77 deletions
@@ -40,88 +40,77 @@ To install Axlsx, use the following command: 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] + require 'rubygems' + require 'axlsx' + +##A Simple Workbook + 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 Bar Chart + 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("example1.xlsx") end - -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::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 - -Generating A Pie 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 - end - package.serialize("example3.xlsx") - end - -Using Custom Styles - - 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 - end - package.serialize("example3.xlsx") - end - -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 - - 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 - -Number and Date formatting - - 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 - - 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] + p.serialize("example2.xlsx") + +##Generating A Pie Chart + 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("example5.xlsx") end + p.serialize("example3.xlsx") + +##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") + +##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") + +##Validation + + p = Axlsx::Package.new + p.workbook.add_worksheet do |sheet| + sheet.add_row ["First", "Second", "Third"] + sheet.add_row [1, 2, 3] + end + + p.validate.each do |error| + puts error.inspect + end ### Documentation This gem is 100% documented with YARD, an exceptional documentation library. To see documentation for this, and all the gems installed on your system use: |
