axlsx 1.0.18 → 1.1.0

data/lib/axlsx/doc_props/core.rb

@@ -7,29 +7,24 @@ module Axlsx
     # The author of the document. By default this is 'axlsx'
     # @return [String]
     attr_accessor :creator
-    
+
     # Creates a new Core object.
     # @option options [String] creator
     def initialize(options={})
-      @creator = options[:creator] || 'axlsx'      
+      @creator = options[:creator] || 'axlsx'
     end
 
-    # Serializes the core object. The created dcterms item is set to the current time when this method is called.
+    # serializes the core.xml document
     # @return [String]
-    def to_xml()
-      builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
-        xml.send('cp:coreProperties', 
-                 :"xmlns:cp" => CORE_NS, 
-                 :'xmlns:dc' => CORE_NS_DC, 
-                 :'xmlns:dcmitype'=>CORE_NS_DCMIT, 
-                 :'xmlns:dcterms'=>CORE_NS_DCT, 
-                 :'xmlns:xsi'=>CORE_NS_XSI) {
-          xml['dc'].creator self.creator
-          xml['dcterms'].created Time.now.strftime('%Y-%m-%dT%H:%M:%S'), :'xsi:type'=>"dcterms:W3CDTF"
-          xml['cp'].revision 0
-        }
-      end  
-      builder.to_xml(:save_with => 0)
+    def to_xml_string(str = '')
+      str << '<?xml version="1.0" encoding="UTF-8"?>'
+      str << '<cp:coreProperties xmlns:cp="' << CORE_NS << '" xmlns:dc="' << CORE_NS_DC << '" '
+      str << 'xmlns:dcmitype="' << CORE_NS_DCMIT << '" xmlns:dcterms="' << CORE_NS_DCT << '" '
+      str << 'xmlns:xsi="' << CORE_NS_XSI << '">'
+      str << '<dc:creator>' << self.creator << '</dc:creator>'
+      str << '<dcterms:created xsi:type="dcterms:W3CDTF">' << Time.now.strftime('%Y-%m-%dT%H:%M:%S') << '</dcterms:created>'
+      str << '<cp:revision>0</cp:revision>'
+      str << '</cp:coreProperties>'
     end
   end
 end

data/lib/axlsx/drawing/axis.rb

@@ -3,7 +3,7 @@ module Axlsx
  # 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
 
@@ -15,7 +15,7 @@ module Axlsx
     # @see Scaling
     # @return [Scaling]
     attr_reader :scaling
-    
+
     # The position of the axis
     # must be one of [:l, :r, :t, :b]
     # @return [Symbol]
@@ -34,7 +34,11 @@ module Axlsx
     # specifies how the perpendicular axis is crossed
     # must be one of [:autoZero, :min, :max]
     # @return [Symbol]
-    attr_reader :crosses 
+    attr_reader :crosses
+
+    # specifies if gridlines should be shown in the chart
+    # @return [Boolean]
+    attr_reader :gridlines
 
     # Creates an Axis object
     # @param [Integer] axId the id of this axis
@@ -49,11 +53,12 @@ module Axlsx
       @axId = axId
       @crossAx = crossAx
       @format_code = "General"
-      @scaling = Scaling.new(:orientation=>:minMax)      
+      @scaling = Scaling.new(:orientation=>:minMax)
       self.axPos = :b
       self.tickLblPos = :nextTo
       self.format_code = "General"
       self.crosses = :autoZero
+      self.gridlines = true
       options.each do |o|
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
       end
@@ -70,25 +75,39 @@ module Axlsx
     # default :General
     def format_code=(v) Axlsx::validate_string(v); @format_code = v; end
 
+    # Specify if gridlines should be shown for this axis
+    # default true
+    def gridlines=(v) Axlsx::validate_boolean(v); @gridlines = v; end
+
     # specifies how the perpendicular axis is crossed
     # must be one of [:autoZero, :min, :max]
     def crosses=(v) RestrictionValidator.validate "#{self.class}.crosses", [:autoZero, :min, :max], v; @crosses = v; end
 
-    # Serializes the common axis
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml)
-      xml.axId :val=>@axId
-      @scaling.to_xml(xml)
-      xml.delete :val=>0
-      xml.axPos :val=>@axPos
-      xml.majorGridlines
-      xml.numFmt :formatCode => @format_code, :sourceLinked=>"1"
-      xml.majorTickMark :val=>"none"
-      xml.minorTickMark :val=>"none"
-      xml.tickLblPos :val=>@tickLblPos
-      xml.crossAx :val=>@crossAx
-      xml.crosses :val=>@crosses
-    end    
+    def to_xml_string(str = '')
+      str << '<c:axId val="' << @axId.to_s << '"/>'
+      @scaling.to_xml_string str
+      str << '<c:delete val="0"/>'
+      str << '<c:axPos val="' << @axPos.to_s << '"/>'
+      str << '<c:majorGridlines>'
+      if self.gridlines == false
+        str << '<c:spPr>'
+        str << '<a:ln>'
+        str << '<a:noFill/>'
+        str << '</a:ln>'
+        str << '</c:spPr>'
+      end
+      str << '</c:majorGridlines>'
+      str << '<c:numFmt formatCode="' << @format_code << '" sourceLinked="1"/>'
+      str << '<c:majorTickMark val="none"/>'
+      str << '<c:minorTickMark val="none"/>'
+      str << '<c:tickLblPos val="' << @tickLblPos.to_s << '"/>'
+      str << '<c:crossAx val="' << @crossAx.to_s << '"/>'
+      str << '<c:crosses val="' << @crosses.to_s << '"/>'
+    end
+
   end
 end

data/lib/axlsx/drawing/bar_3D_chart.rb

@@ -41,7 +41,7 @@ module Axlsx
 
     # validation regex for gap amount percent
     GAP_AMOUNT_PERCENT = /0*(([0-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/
-    
+
     # Creates a new bar chart object
     # @param [GraphicFrame] frame The workbook that owns this chart.
     # @option options [Cell, String] title
@@ -67,14 +67,14 @@ module Axlsx
       @valAxId = rand(8 ** 8)
       @catAxis = CatAxis.new(@catAxId, @valAxId)
       @valAxis = ValAxis.new(@valAxId, @catAxId, :tickLblPos => :low)
-      super(frame, options)      
+      super(frame, options)
       @series_type = BarSeries
       @view3D = View3D.new({:rAngAx=>1}.merge(options))
     end
 
     # The direction of the bars in the chart
     # must be one of [:bar, :col]
-    def barDir=(v) 
+    def barDir=(v)
       RestrictionValidator.validate "Bar3DChart.barDir", [:bar, :col], v
       @barDir = v
     end
@@ -100,38 +100,39 @@ module Axlsx
 
     # The shabe of the bars or columns
     # must be one of  [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax]
-    def shape=(v) 
+    def shape=(v)
       RestrictionValidator.validate "Bar3DChart.shape", [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax], v
       @shape = v
     end
-    
-    # Serializes the bar chart
+
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml
-      super() do |xml|
-        xml.bar3DChart {
-          xml.barDir :val => barDir
-          xml.grouping :val=>grouping
-          xml.varyColors :val=>1
-          @series.each { |ser| ser.to_xml(xml) }
-          xml.dLbls {
-            xml.showLegendKey :val=>0
-            xml.showVal :val=>0
-            xml.showCatName :val=>0
-            xml.showSerName :val=>0
-            xml.showPercent :val=>0
-            xml.showBubbleSize :val=>0            
-          }
-          xml.gapWidth :val=>@gapWidth unless @gapWidth.nil?
-          xml.gapDepth :val=>@gapDepth unless @gapDepth.nil?
-          xml.shape :val=>@shape unless @shape.nil?
-          xml.axId :val=>@catAxId
-          xml.axId :val=>@valAxId
-          xml.axId :val=>0
-        }
-        @catAxis.to_xml(xml)
-        @valAxis.to_xml(xml)        
+    def to_xml_string(str = '')
+      super(str) do |str_inner|
+        str_inner << '<c:bar3DChart>'
+        str_inner << '<c:barDir val="' << barDir.to_s << '"/>'
+        str_inner << '<c:grouping val="' << grouping.to_s << '"/>'
+        str_inner << '<c:varyColors val="1"/>'
+        @series.each { |ser| ser.to_xml_string(str_inner) }
+        str_inner << '<c:dLbls>'
+        str_inner << '<c:showLegendKey val="0"/>'
+        str_inner << '<c:showVal val="0"/>'
+        str_inner << '<c:showCatName val="0"/>'
+        str_inner << '<c:showSerName val="0"/>'
+        str_inner << '<c:showPercent val="0"/>'
+        str_inner << '<c:showBubbleSize val="0"/>'
+        str_inner << '</c:dLbls>'
+        str_inner << '<c:gapWidth val="' << @gapWidth.to_s << '"/>' unless @gapWidth.nil?
+        str_inner << '<c:gapDepth val="' << @gapDepth.to_s << '"/>' unless @gapDepth.nil?
+        str_inner << '<c:shape val="' << @shape.to_s << '"/>' unless @shape.nil?
+        str_inner << '<c:axId val="' << @catAxId.to_s << '"/>'
+        str_inner << '<c:axId val="' << @valAxId.to_s << '"/>'
+        str_inner << '<c:axId val="0"/>'
+        str_inner << '</c:bar3DChart>'
+        @catAxis.to_xml_string str_inner
+        @valAxis.to_xml_string str_inner
       end
-    end    
-  end  
+    end
+  end
 end

data/lib/axlsx/drawing/bar_series.rb

@@ -6,8 +6,8 @@ module Axlsx
   # @see Chart#add_series
   class BarSeries < Series
 
-  
-    # The data for this series. 
+
+    # The data for this series.
     # @return [Array, SimpleTypedList]
     attr_reader :data
 
@@ -31,28 +31,27 @@ module Axlsx
       super(chart, options)
       self.labels = CatAxisData.new(options[:labels]) unless options[:labels].nil?
       self.data = ValAxisData.new(options[:data]) unless options[:data].nil?
-    end 
+    end
 
     # The shabe of the bars or columns
     # must be one of  [:percentStacked, :clustered, :standard, :stacked]
-    def shape=(v) 
+    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.
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml)
-      super(xml) do |xml_inner|
-        @labels.to_xml(xml_inner) unless @labels.nil?
-        @data.to_xml(xml_inner) unless @data.nil?
-        xml_inner.shape :val=>@shape
-      end      
+    def to_xml_string(str = '')
+      super(str) do |str_inner|
+        @labels.to_xml_string(str_inner) unless @labels.nil?
+        @data.to_xml_string(str_inner) unless @data.nil?
+        str_inner << '<shape val="' << @shape.to_s << '"/>'
+      end
     end
 
-    
-    private 
+    private
 
     # assigns the data for this series
     def data=(v) DataTypeValidator.validate "Series.data", [SimpleTypedList], v; @data = v; end

data/lib/axlsx/drawing/cat_axis.rb

@@ -10,7 +10,7 @@ module Axlsx
     # specifies how the perpendicular axis is crossed
     # must be one of [:ctr, :l, :r]
     # @return [Symbol]
-    attr_reader :lblAlgn 
+    attr_reader :lblAlgn
 
     # The offset of the labels
     # must be between a string between 0 and 1000
@@ -20,7 +20,7 @@ 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    
+    # 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
@@ -28,13 +28,13 @@ module Axlsx
     # @option options [Symbol] crosses. Inherited
     # @option options [Boolean] auto
     # @option options [Symbol] lblAlgn
-    # @option options [Integer] lblOffset    
+    # @option options [Integer] lblOffset
     def initialize(axId, crossAx, options={})
       self.auto = 1
       self.lblAlgn = :ctr
       self.lblOffset = "100%"
       super(axId, crossAx, options)
-    end 
+    end
 
     # 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.
     def auto=(v) Axlsx::validate_boolean(v); @auto = v; end
@@ -47,18 +47,19 @@ module Axlsx
     # must be between a string between 0 and 1000
     def lblOffset=(v) RegexValidator.validate "#{self.class}.lblOffset", LBL_OFFSET_REGEX, v; @lblOffset = v; end
 
-    # Serializes the category axis
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml)
-      xml.catAx {
-        super(xml)
-        xml.auto :val=>@auto
-        xml.lblAlgn :val=>@lblAlgn
-        xml.lblOffset :val=>@lblOffset
-      }
+    def to_xml_string(str = '')
+      str << '<c:catAx>'
+      super(str)
+      str << '<c:auto val="' << @auto.to_s << '"/>'
+      str << '<c:lblAlgn val="' << @lblAlgn.to_s << '"/>'
+      str << '<c:lblOffset val="' << @lblOffset.to_s << '"/>'
+      str << '</c:catAx>'
     end
+
   end
-  
+
 
 end

data/lib/axlsx/drawing/cat_axis_data.rb

@@ -11,26 +11,24 @@ module Axlsx
       data.each { |i| @list << i } if data.is_a?(SimpleTypedList)
     end
 
-    # Serializes the category axis data
-    # @param [Nokogiri::XML::Builder] xml The document builder instance this objects xml will be added to.
+    # Serializes the object
+    # @param [String] str
     # @return [String]
-    def to_xml(xml)
-      xml.cat {
-        xml.strRef {
-          xml.f Axlsx::cell_range(@list)
-          xml.strCache {
-            xml.ptCount :val=>size
-            each_with_index do |item, index|
-              v = item.is_a?(Cell) ? item.value : item
-              xml.pt(:idx=>index) {
-                xml.v v
-              }                          
-            end
-          }
-        }
-      }
+    def to_xml_string(str = '')
+      str << '<c:cat>'
+      str << '<c:strRef>'
+      str << '<c:f>' << Axlsx::cell_range(@list) << '</c:f>'
+      str << '<c:strCache>'
+      str << '<c:ptCount val="' << size.to_s << '"/>'
+      each_with_index do |item, index|
+        v = item.is_a?(Cell) ?  item.value.to_s : item
+        str << '<c:pt idx="' << index.to_s << '"><c:v>' << v << '</c:v></c:pt>'
+      end
+      str << '</c:strCache>'
+      str << '</c:strRef>'
+      str << '</c:cat>'
     end
 
   end
-  
+
 end

data/lib/axlsx/drawing/chart.rb

@@ -28,7 +28,7 @@ module Axlsx
     # @return [Title]
     attr_reader :title
 
-    # The style for the chart. 
+    # The style for the chart.
     # see ECMA Part 1 §21.2.2.196
     # @return [Integer]
     attr_reader :style
@@ -36,13 +36,14 @@ module Axlsx
     # Show the legend in the chart
     # @return [Boolean]
     attr_reader :show_legend
-   
+
     # Creates a new chart object
     # @param [GraphicalFrame] frame The frame that holds this chart.
     # @option options [Cell, String] title
     # @option options [Boolean] show_legend
     def initialize(frame, options={})
       @style = 2
+      @view3D = nil
       @graphic_frame=frame
       @graphic_frame.anchor.drawing.worksheet.workbook.charts << self
       @series = SimpleTypedList.new Series
@@ -72,7 +73,7 @@ module Axlsx
     # The title object for the chart.
     # @param [String, Cell] v
     # @return [Title]
-    def title=(v) 
+    def title=(v)
       DataTypeValidator.validate "#{self.class}.title", [String, Cell], v
       if v.is_a?(String)
         @title.text = v
@@ -80,14 +81,14 @@ module Axlsx
         @title.cell = v
       end
     end
-    
+
     # Show the legend in the chart
     # @param [Boolean] v
     # @return [Boolean]
     def show_legend=(v) Axlsx::validate_boolean(v); @show_legend = v; end
 
 
-    # The style for the chart. 
+    # The style for the chart.
     # see ECMA Part 1 §21.2.2.196
     # @param [Integer] v must be between 1 and 48
     def style=(v) DataTypeValidator.validate "Chart.style", Integer, v, lambda { |arg| arg >= 1 && arg <= 48 }; @style = v; end
@@ -112,40 +113,38 @@ module Axlsx
       @series.last
     end
 
-    # Chart Serialization
-    # serializes the chart
-    def to_xml
-      builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
-        xml.send('c:chartSpace', :'xmlns:c' => XML_NS_C, :'xmlns:a' => XML_NS_A) {
-          xml[:c].date1904 :val => Axlsx::Workbook.date1904
-          xml[:c].style :val=>style
-          xml[:c].chart {
-            @title.to_xml(xml)
-            xml.autoTitleDeleted :val=>0
-            @view3D.to_xml(xml) unless @view3D.nil?
-            
-            xml.floor { xml.thickness(:val=>0) }
-            xml.sideWall { xml.thickness(:val=>0) }
-            xml.backWall { xml.thickness(:val=>0) }
-            xml.plotArea {
-              xml.layout
-              yield xml if block_given?
-            }
-            if @show_legend
-                xml.legend {
-                xml.legendPos :val => "r"
-                xml.layout
-                xml.overlay :val => 0                  
-              }
-            end
-            xml.plotVisOnly :val => 1
-            xml.dispBlanksAs :val => :zero
-            xml.showDLblsOverMax :val => 1
-          }
-          
-        }
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<?xml version="1.0" encoding="UTF-8"?>'
+      str << '<c:chartSpace xmlns:c="' << XML_NS_C << '" xmlns:a="' << XML_NS_A << '">'
+      str << '<c:date1904 val="' << Axlsx::Workbook.date1904.to_s << '"/>'
+      str << '<c:style val="' << style.to_s << '"/>'
+      str << '<c:chart>'
+      @title.to_xml_string str
+      # do these need the c: namespace as well???
+      str << '<c:autoTitleDeleted val="0"/>'
+      @view3D.to_xml_string(str) if @view3D
+      str << '<c:floor><c:thickness val="0"/></c:floor>'
+      str << '<c:sideWall><c:thickness val="0"/></c:sideWall>'
+      str << '<c:backWall><c:thickness val="0"/></c:backWall>'
+      str << '<c:plotArea>'
+      str << '<c:layout/>'
+      yield str if block_given?
+      str << '</c:plotArea>'
+      if @show_legend
+        str << '<c:legend>'
+        str << '<c:legendPos val="r"/>'
+        str << '<c:layout/>'
+        str << '<c:overlay val="0"/>'
+        str << '</c:legend>'
       end
-      builder.to_xml(:save_with => 0)
+      str << '<c:plotVisOnly val="1"/>'
+      str << '<c:dispBlanksAs val="zero"/>'
+      str << '<c:showDLblsOverMax val="1"/>'
+      str << '</c:chart>'
+      str << '</c:chartSpace>'
     end
 
     # This is a short cut method to set the start anchor position