axlsx 1.0.6 → 1.0.7

data/doc/top-level-namespace.html

@@ -94,7 +94,7 @@
 </div>
     
     <div id="footer">
-  Generated on Tue Nov 22 00:27:58 2011 by 
+  Generated on Wed Nov 23 12:30:35 2011 by 
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   0.7.3 (ruby-1.8.7).
 </div>

data/examples/#example.rb#

@@ -0,0 +1,87 @@
+     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, :title=>"example 6: Line Chart") do |chart|
+         chart.start_at 0, 2
+         chart.end_at 10, 15
+         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")

data/examples/example.rb

@@ -59,6 +59,7 @@
      p.serialize("example5.xlsx")
 
 #Validation
+
      p = Axlsx::Package.new
      p.workbook.add_worksheet do |sheet|
        sheet.add_row ["First", "Second", "Third"]
@@ -75,7 +76,9 @@
      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|
+       sheet.add_chart(Axlsx::Line3DChart, :title=>"example 6: Line Chart") do |chart|
+         chart.start_at 0, 2
+         chart.end_at 10, 15
          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

data/lib/axlsx/drawing/#bar_series.rb#

@@ -0,0 +1,62 @@
+module Axlsx
+  # A BarSeries defines the title, data and labels for bar charts
+  # @note The recommended way to manage series is to use Chart#add_series
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  class BarSeries < Series
+
+  
+    # The data for this series. 
+    # @return [Array, SimpleTypedList]
+    attr_reader :data
+
+    # The labels for this series.
+    # @return [Array, SimpleTypedList]
+    attr_reader :labels
+
+    # The shabe of the bars or columns
+    # must be one of  [:percentStacked, :clustered, :standard, :stacked]
+    # @return [Symbol]
+    attr_accessor :shape
+
+    # Creates a new series
+    # @option options [Array, SimpleTypedList] data
+    # @option options [Array, SimpleTypedList] labels
+    # @option options [String] title
+    # @option options [String] shape
+    # @param [Chart] chart
+    def initialize(chart, options={})
+      @shape = :box
+      super(chart, options)
+      self.labels = CatAxisData.new(options[:labels]) unless options[:labels].nil?
+      self.data = ValAxisData.new(options[:data]) unless options[:data].nil?
+    end 
+
+    def shape=(v) 
+      RestrictionValidator.validate "BarSeries.shape", [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax], v
+      @shape = v
+    end
+
+    # Serializes the series
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @return [String]
+    def to_xml(xml)
+      super(xml) do |xml|
+        @labels.to_xml(xml) unless @labels.nil?
+        @data.to_xml(xml) unless @data.nil?
+        xml.send('c:shape', :val=>@shape)
+      end      
+    end
+
+    
+    private 
+
+    # assigns the data for this series
+    def data=(v) DataTypeValidator.validate "Series.data", [SimpleTypedList], v; @data = v; end
+
+    # assigns the labels for this series
+    def labels=(v) DataTypeValidator.validate "Series.labels", [SimpleTypedList], v; @labels = v; end
+
+  end
+
+end

data/lib/axlsx/drawing/axis.rb

@@ -1,9 +1,8 @@
 module Axlsx
- # the access class defines common properties and values for chart axis
+ # the access class defines common properties and values for a chart axis.
   class Axis
 
-
-    # the id of the axis
+    # the id of the axis. 
     # @return [Integer]
     attr_reader :axId
 
@@ -12,6 +11,7 @@ module Axlsx
     attr_reader :crossAx
 
     # The scaling of the axis
+    # @see Scaling
     # @return [Scaling]
     attr_reader :scaling
     
@@ -25,8 +25,8 @@ module Axlsx
     # @return [Symbol]
     attr_accessor :tickLblPos
 
-
     # The number format format code for this axis
+    # default :General
     # @return [String]
     attr_accessor :format_code
 
@@ -41,15 +41,16 @@ module Axlsx
     # @option options [Symbol] axPos
     # @option options [Symbol] crosses
     # @option options [Symbol] tickLblPos
+    # @raise [ArgumentError] If axId or crossAx are not unsigned integers
     def initialize(axId, crossAx, options={})
       Axlsx::validate_unsigned_int(axId)
       Axlsx::validate_unsigned_int(crossAx)
       @axId = axId
       @crossAx = crossAx
+      @scaling = Scaling.new(:orientation=>:minMax)
       self.axPos = :l
       self.tickLblPos = :nextTo
-      @scaling = Scaling.new(:orientation=>:minMax)
-      @formatCode = ""
+      self.format_code = "General"
       self.crosses = :autoZero
       options.each do |o|
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="

data/lib/axlsx/drawing/bar_3D_chart.rb

@@ -1,43 +1,17 @@
 module Axlsx
 
   # The Bar3DChart is a three dimentional barchart (who would have guessed?) that you can add to your worksheet.
-  # @example Creating a chart
-  #   # This example creates two charts in a single sheet.
-  #   # The first uses data directly fed to the sheet, while the second references cells withing the worksheet for data.
-  #
-  #   require "rubygems" # if that is your preferred way to manage gems!
-  #   require "axlsx"
-  #
-  #   p = Axlsx::Package.new
-  #   ws = p.workbook.add_worksheet
-  #   ws.add_row :values => ["This is a chart with no data in the sheet"]
-  #
-  #   chart = ws.add_chart(Axlsx::Bar3DChart, :start_at=> [0,1], :end_at=>[0,6], :title=>"Most Popular Pets")
-  #   chart.add_series :data => [1, 9, 10], :labels => ["Slimy Reptiles", "Fuzzy Bunnies", "Rottweiler"]
-  # 
-  #   ws.add_row :values => ["This chart uses the data below"]
-  #   title_row = ws.add_row :values => ["Least Popular Pets"]
-  #   label_row = ws.add_row :values => ["", "Dry Skinned Reptiles", "Bald Cats", "Violent Parrots"]
-  #   data_row = ws.add_row :values => ["Votes", 6, 4, 1]
-  #   
-  #   chart = ws.add_chart(Axlsx::Pie3DChart, :start_at => [0,11], :end_at =>[0,16], :title => title_row.cells.last)
-  #   chart.add_series :data => data_row.cells[(1..-1)], :labels => label_row.cells  
-  #
-  #   f = File.open('example_pie_3d_chart.xlsx', 'w')
-  #   p.serialize(f)
-  #
   # @see Worksheet#add_chart
-  # @see Worksheet#add_row
   # @see Chart#add_series
-  # @see Series
   # @see Package#serialize
+  # @see README for an example
   class Bar3DChart < Chart
 
     # the category axis
     # @return [CatAxis]
     attr_reader :catAxis
 
-    # the category axis
+    # the valueaxis
     # @return [ValAxis]
     attr_reader :valAxis
 
@@ -60,7 +34,7 @@ module Axlsx
     attr_accessor :grouping
 
     # The shabe of the bars or columns
-    # must be one of  [:percentStacked, :clustered, :standard, :stacked]
+    # must be one of  [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax]
     # @return [Symbol]
     attr_accessor :shape
 
@@ -76,6 +50,14 @@ module Axlsx
     # @option options [String] gapWidth
     # @option options [String] gapDepth
     # @option options [Symbol] shape
+    # @option options [Integer] rotX
+    # @option options [String] hPercent
+    # @option options [Integer] rotY
+    # @option options [String] depthPercent
+    # @option options [Boolean] rAngAx
+    # @option options [Integer] perspective
+    # @see Chart
+    # @see View3D
     def initialize(frame, options={})
       @barDir = :bar
       @grouping = :clustered
@@ -83,9 +65,9 @@ module Axlsx
       @valAxId = rand(8 ** 8)
       @catAxis = CatAxis.new(@catAxId, @valAxId)
       @valAxis = ValAxis.new(@valAxId, @catAxId)
-      @view3D = View3D.new(:rAngAx=>1)
       super(frame, options)      
       @series_type = BarSeries
+      @view3D = View3D.new({:rAngAx=>1}.merge(options))
     end
     
     def barDir=(v) 

data/lib/axlsx/drawing/bar_series.rb

@@ -28,8 +28,8 @@ module Axlsx
     def initialize(chart, options={})
       @shape = :box
       super(chart, options)
-      self.data = options[:data]  || []
-      self.labels = options[:labels] || []
+      self.labels = CatAxisData.new(options[:labels]) unless options[:labels].nil?
+      self.data = ValAxisData.new(options[:data]) unless options[:data].nil?
     end 
 
     def shape=(v) 
@@ -42,37 +42,8 @@ module Axlsx
     # @return [String]
     def to_xml(xml)
       super(xml) do |xml|
-        if !labels.empty?
-          xml.send('c:cat') {
-            xml.send('c:strRef') {
-              xml.send('c:f', Axlsx::cell_range(labels))
-              xml.send('c:strCache') {
-                xml.send('c:ptCount', :val=>labels.size)
-                labels.each_with_index do |cell, index|
-                  v = cell.is_a?(Cell) ? cell.value : cell
-                  xml.send('c:pt', :idx=>index) {
-                    xml.send('c:v', v)
-                  }                          
-                end
-              }
-            }
-          }
-        end
-        xml.send('c:val') {
-          xml.send('c:numRef') {
-            xml.send('c:f', Axlsx::cell_range(data))
-            xml.send('c:numCache') {
-              xml.send('c:formatCode', 'General')
-              xml.send('c:ptCount', :val=>data.size)
-              data.each_with_index do |cell, index|
-                v = cell.is_a?(Cell) ? cell.value : cell
-                xml.send('c:pt', :idx=>index) {
-                  xml.send('c:v', v) 
-                }
-              end
-            }                        
-          }
-        }
+        @labels.to_xml(xml) unless @labels.nil?
+        @data.to_xml(xml) unless @data.nil?
         xml.send('c:shape', :val=>@shape)
       end      
     end
@@ -82,10 +53,10 @@ module Axlsx
 
 
     # assigns the data for this series
-    def data=(v) DataTypeValidator.validate "Series.data", [Array, SimpleTypedList], v; @data = v; end
+    def data=(v) DataTypeValidator.validate "Series.data", [SimpleTypedList], v; @data = v; end
 
     # assigns the labels for this series
-    def labels=(v) DataTypeValidator.validate "Series.labels", [Array, SimpleTypedList], v; @labels = v; end
+    def labels=(v) DataTypeValidator.validate "Series.labels", [SimpleTypedList], v; @labels = v; end
 
   end
 

data/lib/axlsx/drawing/cat_axis.rb

@@ -1,6 +1,7 @@
 module Axlsx
   #A CatAxis object defines a chart category axis
   class CatAxis < Axis
+
     # From the docs: This element specifies that this axis is a date or text axis based on the data that is used for the axis labels, not a specific choice.
     # @return [Boolean]
     attr_accessor :auto
@@ -18,23 +19,20 @@ module Axlsx
     # regex for validating label offset
     LBL_OFFSET_REGEX = /0*(([0-9])|([1-9][0-9])|([1-9][0-9][0-9])|1000)%/
 
-    # Creates a new CatAxis object
-    # @param [Integer] axId the id of this axis
-    # @param [Integer] crossAx the id of the perpendicular axis
-    # @option options [Symbol] axPos
-    # @option options [Symbol] tickLblPos
-    # @option options [Symbol] crosses
+    # Creates a new CatAxis object    
+    # @param [Integer] axId the id of this axis. Inherited
+    # @param [Integer] crossAx the id of the perpendicular axis. Inherited
+    # @option options [Symbol] axPos. Inherited
+    # @option options [Symbol] tickLblPos. Inherited
+    # @option options [Symbol] crosses. Inherited
     # @option options [Boolean] auto
     # @option options [Symbol] lblAlgn
     # @option options [Integer] lblOffset    
     def initialize(axId, crossAx, options={})
-      super(axId, crossAx, options)
       self.auto = true
       self.lblAlgn = :ctr
       self.lblOffset = "100%"
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
+      super(axId, crossAx, options)
     end 
 
     def auto=(v) Axlsx::validate_boolean(v); @auto = v; end

data/lib/axlsx/drawing/cat_axis_data.rb

@@ -0,0 +1,34 @@
+module Axlsx
+  # The CatAxisData class serializes the category axis data for a chart
+  class CatAxisData < SimpleTypedList
+
+    # Create a new CatAxisData object
+    # @param [Array, SimpleTypedList] data the data for this category axis. This can be a simple array or a simple typed list of cells.
+    def initialize(data=[])
+      super Object
+      @list.concat data if data.is_a?(Array)
+    end
+
+    # Serializes the category axis data
+    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # @return [String]
+    def to_xml(xml)
+      xml.send('c:cat') {
+        xml.send('c:strRef') {
+          xml.send('c:f', Axlsx::cell_range(@list))
+          xml.send('c:strCache') {
+            xml.send('c:ptCount', :val=>size)
+            each_with_index do |item, index|
+              v = item.is_a?(Cell) ? item.value : item
+              xml.send('c:pt', :idx=>index) {
+                xml.send('c:v', v)
+              }                          
+            end
+          }
+        }
+      }
+    end
+
+  end
+  
+end

data/lib/axlsx/drawing/cat_axis_data.rb~

@@ -0,0 +1,28 @@
+module Axlsx
+
+  class CatAxisData < SimpleTypedList
+    def initialize(data=[])
+      super Object
+      @list.concat data if data.is_a?(Array)
+    end
+
+    def to_xml(xml)
+      xml.send('c:cat') {
+        xml.send('c:strRef') {
+          xml.send('c:f', Axlsx::cell_range(@list))
+          xml.send('c:strCache') {
+            xml.send('c:ptCount', :val=>size)
+            each_with_index do |item, index|
+              v = item.is_a?(Cell) ? item.value : item
+              xml.send('c:pt', :idx=>index) {
+                xml.send('c:v', v)
+              }                          
+            end
+          }
+        }
+      }
+    end
+
+  end
+  
+end