Axlsx: Office Open XML Spreadsheet Generation
IRC: irc.freenode.net / #axlsx
Git: http://github.com/randym/axlsx
Author: Randy Morgan
Copyright: 2011
License: MIT License
Latest Version: 1.0.5
Ruby Version: 1.8.7
Release Date: November 22nd 2011
Synopsis
Axlsx is an Office Open XML Spreadsheet generator for the Ruby programming language. It enables the you to generate 100% valid xlsx files that include customised styling 3D pie, bar and line charts. Below is a summary of salient features.
Feature List
**1. Author xlsx documents: Axlsx is made to let you easily and quickly generate profesional xlsx based reports that can be validated before serialiation.
**2. Generate 3D Pie and Bar Charts: With Axlsx chart generation and management is as easy as a few lines of code. You can build charts based off data in your worksheet or generate charts without any data in your sheet at all.
**3. Custom Styles: With guaranteed document validity, you can style borders, alignment, fills, fonts, and number formats in a single line of code. Those styles can be applied to an entire row, or a single cell anywhere in your workbook.
**4. Automatic type support: Axlsx will automatically determine the type of data you are generating. In this release Float, Integer, String and Time types are automatically identified and serialized to your spreadsheet.
**5. Automatic column widths: Axlsx will automatically determine the appropriate width for your columns based on the content in the worksheet.
**6. Support for both 1904 and 1900 epocs configurable in the workbook.
Installing
To install Axlsx, use the following command:
$ gem install axlsx
Usage
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 2: Chart") do |chart|
chart.add_series :data=>sheet.rows.last.cells, :labels=> sheet.rows.first.cells
end
end
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 3: Pie Chart") do |chart|
chart.add_series :data=>sheet.rows.last.cells, :labels=> sheet.rows.first.cells
end
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
Generating A Line Chart
p = Axlsx::Package.new
p.workbook.add_worksheet do |sheet|
sheet.add_row ["First", 1, 5, 7, 9]
sheet.add_row ["Second", 5, 2, 14, 9]
sheet.add_chart(Axlsx::Line3DChart, :start_at => [0,2], :end_at => [10, 15], :title=>"example 6: Line Chart") do |chart|
chart.add_series :data=>sheet.rows.first.cells[(1..-1)], :title=> sheet.rows.first.cells.first
chart.add_series :data=>sheet.rows.last.cells[(1..-1)], :title=> sheet.rows.last.cells.first
end
end
p.serialize("example6.xlsx")
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:
yard server -g
Specs
This gem has 100% test coverage using test/unit. To execute tests for this gem, simply run rake in the gem directory.
Changelog
- October.20.11: 0.1.0 release
- October.21.11: 1.0.3 release
- Updated documentation
- October.21.11: 1.0.4
- altered package to accept a filename string for serialization instead of a File object.
- Updated specs to conform
- More examples for readme
- October.22.11: 1.05
- Added support for line charts
- Updated examples and readme
- Updated series title to be a real title ** NOTE ** If you are accessing titles directly you will need to update text assignation to title.text = v
- BugFix: shape attribute for bar chart is now properly serialized
- BugFix: date1904 property now properly set for charts
- Added style property to charts
- Removed serialization write test as it most commonly fails when run from the gem's intalled directory
On Deck
- Verification with ruby 1.9.3
- Active Record support via package::serialize_ar so you can dump an AR result into a worksheet in one go.
Copyright
Axlsx © 2011 by Randy Morgan. Axlsx is licensed under the MIT license. Please see the LICENSE document for more information.