Axlsx: Office Open XML Spreadsheet Generation

If you are using axlsx for comercial purposes, or just want to show your appreciation for the gem, please don't hesitate to make a donation.

IRC:irc.freenode.net / #axlsx

Git:http://github.com/randym/axlsx

Twitter: https://twitter.com/#!/morgan_randy

Google Group: https://groups.google.com/forum/?fromgroups#!forum/axlsx

Author: Randy Morgan

Copyright: 2011 - 2012

License: MIT License

Latest Version: 1.3.4

Ruby Version: 1.8.7, 1.9.2, 1.9.3

JRuby Version: 1.6.7 1.8 and 1.9 modes

Rubinius Version: rubinius 2.0.0dev * lower versions may run, this gem always tests against head.

Release Date: November ??th 2012

If you are working in rails, or with active record see:

• http://github.com/randym/acts_as_xlsx acts_as_xlsx is a simple ActiveRecord mixin that lets you generate a workbook with:

  Posts.where(created_at > Time.now-30.days).to_xlsx

** and **

• http://github.com/straydogstudio/axlsx_rails Axlsx_Rails provides an Axlsx renderer so you can move all your spreadsheet code from your controller into view files. Partials are supported so you can organize any code into reusable chunks (e.g. cover sheets, common styling, etc.) You can use it with acts_as_xlsx, placing the to_xlsx call in a view and add ':package => xlsx_package' to the parameter list. Now you can keep your controllers thin!

There are guides for using axlsx and acts_as_xlsx here: http://axlsx.blog.randym.net

The examples directory contains a number of more specific examples as well.

Synopsis

Axlsx is an Office Open XML Spreadsheet generator for the Ruby programming language. With Axlsx you can create excel worksheets with charts, images (with links), automated and fixed column widths, customized styles, functions, tables, conditional formatting, print options, comments, merged cells, auto filters, file and stream serialization as well as full schema validation. Axlsx excels at helping you generate beautiful Office Open XML Spreadsheet documents without having to understand the entire ECMA specification.

Feature List

**1. Author xlsx documents: Axlsx is made to let you easily and quickly generate professional xlsx based reports that can be validated before serialization.

**2. Generate 3D Pie, Line, Scatter 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. Customize gridlines, label rotation and series colors as well.

**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, Date, Time and Boolean types are automatically identified and serialized to your spreadsheet.

**5. Automatic and fixed column widths: Axlsx will automatically determine the appropriate width for your columns based on the content in the worksheet, or use any value you specify for the really funky stuff.

**6. Support for automatically formatted 1904 and 1900 epochs configurable in the workbook.

**7. Add jpg, gif and png images to worksheets with hyperlinks

**8. Reference cells in your worksheet with "A1" and "A1:D4" style references or from the workbook using "Sheet1!A3:B4" style references

**9. Cell level style overrides for default and customized style objects

**10. Support for formulas, merging, row and column outlining as well as cell level input data validation.

**12. Auto filtering tables with worksheet.auto_filter as well as support for Tables

**13. Export using shared strings or inline strings so we can inter-op with iWork Numbers (sans charts for now).

**14. Output to file or StringIO

**15. Support for page margins and print options

**16. Support for password and non password based sheet protection.

**17. First stage interoperability support for GoogleDocs, LibreOffice, and Numbers

**18. Support for defined names, which gives you repeated header rows for printing.

**19. Data labels for charts as well as series color customization.

**20. Support for sheet headers and footers

Installing

To install Axlsx, use the following command:

$ gem install axlsx

#Examples

The example listing is getting overly large to maintain here. If you are using Yard, you will be able to see the examples in line below.

Here's a teaser that kicks about 2% of what the gem can do.

Axlsx::Package.new do |p|
  p.workbook.add_worksheet(:name => "Pie Chart") do |sheet|
    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
  p.serialize('simple.xlsx')
end

Please see the examples for more.

{include:file:examples/example.rb}

There is much, much more you can do with this gem. If you get stuck, grab me on IRC or submit an issue to GitHub. Chances are that it has already been implemented. If it hasn't - let's take a look at adding it in.

#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:

 gem install yard

 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.

#Change log

• November.25.12:1.3.4
  • Support for headers and footers for worksheets
  • bug fix: Properly escape hyperlink urls
  • Improvements in color_scale generation for conditional formatting
  • Improvements in autowidth calculation.
• November.8.12:1.3.3
  • Patched cell run styles for u and validation for family
• November.5.12:1.3.2
  • MASSIVE REFACTORING
  • Patch for apostrophes in worksheet names
  • added sheet_by_name for workbook so you can now find your worksheets by name
  • added insert_worksheet so you can now add a worksheet to an arbitrary position in the worksheets list.
  • reduced memory consumption for package parts post serialization

Please see the {file:CHANGELOG.md} document for past release information.

Known interoperability issues.

As axslx implements the Office Open XML (ECMA-376 spec) much of the functionality is interoperable with other spreadsheet software. Below is a listing of some known issues.

1. Libre Office

   • You must specify colors for your series. see examples/chart_colors.rb for an example.
   • You must use data in your sheet for charts. You cannot use hard coded values.
   • Chart axis and gridlines do not render. I have a feeling this is related to themes, which axlsx does not implement at this time.

2. Google Docs

   • Images are known to not work with google docs
   • border colors do not work

3. Numbers

   • you must set 'use_shared_strings' to true. This is most conveniently done just before rendering by calling Package.use_shared_strings = true prior to serialization.

p = Axlsx::Package.new
p.workbook.add_worksheet(:name => "Basic Worksheet") do |sheet|
  sheet.add_row ["First Column", "Second", "Third"]
  sheet.add_row [1, 2, 3]
end
p.use_shared_strings = true
p.serialize('simple.xlsx')

• charts do not render

#Thanks!

Open source software is a community effort. None of this could have been done without the help of the people below.

---

ochko - for performance fixes, kicking the crap out of axlsx and helping to maintain my general sanity.

kleine2 - for generously donating in return for the image hyperlink feature.

ffmike - for knocking down an over restrictive i18n dependency, massive patience and great communication skills.

JonathanTron - for giving the gem some style, and making sure it applies.

JosephHalter - for making sure we arrive at the right time on the right date.

noniq - for keeping true to the gem's style, and making sure what we put on paper does not get marginalized.

jurriaan - for showing there is more than one way to skin a cat, and work with rows while you are at it.

joekain - for keeping our references working even in the double digits!

moskrin - for keeping border creation on the edge.

scpike - for keeping numbers fixed even when they are rational and a super clean implementation of conditional formatting.

janhuehne - for working out the decoder ring and adding in cell level validation, and providing a support for window panes.

rfc2616 - for FINALLY working out the interop issues with google docs.

straydogstudio - For making an AWESOME axlsx templating gem for rails.

MitchellAJ - For catching a bug in font_size calculations, finding some old code in an example and above all for reporting all of that brilliantly

ebenoist - For taking control of control characters and keeping what is between the lines, between the lines.

adammathys - Fgr getting our head in the air and our feet on the ground.

#Copyright and License

Axlsx © 2011-2012 by Randy Morgan. Axlsx is licensed under the MIT license. Please see the LICENSE document for more information.