axlsx 1.3.5 → 1.3.6

data/lib/axlsx/drawing/d_lbls.rb

@@ -10,7 +10,7 @@ module Axlsx
     include Axlsx::OptionsParser 
     # creates a new DLbls object
     def initialize(chart_type, options={})
-      raise ArgumentError, 'chart_type must inherit from Chart' unless chart_type.superclass == Chart
+      raise ArgumentError, 'chart_type must inherit from Chart' unless [Chart, LineChart].include?(chart_type.superclass)
       @chart_type = chart_type
       initialize_defaults
       parse_options options

data/lib/axlsx/drawing/drawing.rb

@@ -22,6 +22,7 @@ module Axlsx
   require 'axlsx/drawing/ser_axis.rb'
   require 'axlsx/drawing/cat_axis.rb'
   require 'axlsx/drawing/val_axis.rb'
+  require 'axlsx/drawing/axes.rb'
 
   require 'axlsx/drawing/marker.rb'
 
@@ -33,6 +34,7 @@ module Axlsx
   require 'axlsx/drawing/chart.rb'
   require 'axlsx/drawing/pie_3D_chart.rb'
   require 'axlsx/drawing/bar_3D_chart.rb'
+  require 'axlsx/drawing/line_chart.rb'
   require 'axlsx/drawing/line_3D_chart.rb'
   require 'axlsx/drawing/scatter_chart.rb'
 

data/lib/axlsx/drawing/line_3D_chart.rb

@@ -11,7 +11,7 @@ module Axlsx
   #   ws = p.workbook.add_worksheet
   #   ws.add_row ["This is a chart with no data in the sheet"]
   #
-  #   chart = ws.add_chart(Axlsx::Line3DChart, :start_at=> [0,1], :end_at=>[0,6], :title=>"Most Popular Pets")
+  #   chart = ws.add_chart(Axlsx::Line3DChart, :start_at=> [0,1], :end_at=>[0,6], :t#itle=>"Most Popular Pets")
   #   chart.add_series :data => [1, 9, 10], :labels => ["Slimy Reptiles", "Fuzzy Bunnies", "Rottweiler"]
   #
   # @see Worksheet#add_chart
@@ -19,93 +19,50 @@ module Axlsx
   # @see Chart#add_series
   # @see Series
   # @see Package#serialize
-  class Line3DChart < Chart
-
-    # the category axis
-    # @return [CatAxis]
-    attr_reader :catAxis
-
-    # the category axis
-    # @return [ValAxis]
-    attr_reader :valAxis
-
-    # the category axis
-    # @return [Axis]
-    attr_reader :serAxis
+  class Line3DChart < Axlsx::LineChart
 
     # space between bar or column clusters, as a percentage of the bar or column width.
     # @return [String]
-    attr_reader :gapDepth
-
-    #grouping for a column, line, or area chart.
-    # must be one of  [:percentStacked, :clustered, :standard, :stacked]
-    # @return [Symbol]
-    attr_reader :grouping
+    attr_reader :gap_depth
+    alias :gapDepth :gap_depth
 
     # validation regex for gap amount percent
     GAP_AMOUNT_PERCENT = /0*(([0-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/
 
+    # the category axis
+    # @return [Axis]
+    def ser_axis
+      axes[:ser_axis]
+    end
+    alias :serAxis :ser_axis
+
     # Creates a new line chart object
-    # @param [GraphicFrame] frame The workbook that owns this chart.
-    # @option options [Cell, String] title
-    # @option options [Boolean] show_legend
-    # @option options [Symbol] grouping
-    # @option options [String] gapDepth
-    # @option options [Integer] rotX
-    # @option options [String] hPercent
-    # @option options [Integer] rotY
-    # @option options [String] depthPercent
-    # @option options [Boolean] rAngAx
-    # @option options [Integer] perspective
+    # @option options [String] gap_depth
     # @see Chart
+    # @see lineChart
     # @see View3D
     def initialize(frame, options={})
-      @vary_colors = false
-      @gapDepth = nil
-      @grouping = :standard
-      @catAxId = rand(8 ** 8)
-      @valAxId = rand(8 ** 8)
-      @serAxId = rand(8 ** 8)
-      @catAxis = CatAxis.new(@catAxId, @valAxId)
-      @valAxis = ValAxis.new(@valAxId, @catAxId)
-      @serAxis = SerAxis.new(@serAxId, @valAxId)
+      @gap_depth = nil
+      @view_3D = View3D.new({:r_ang_ax=>1}.merge(options))
       super(frame, options)
-      @series_type = LineSeries
-      @view_3D = View3D.new({:perspective=>30}.merge(options))
-      @d_lbls = nil
+      axes.add_axis :ser_axis, SerAxis
     end
 
-    # @see grouping
-    def grouping=(v)
-      RestrictionValidator.validate "Bar3DChart.grouping", [:percentStacked, :standard, :stacked], v
-      @grouping = v
-    end
 
     # @see gapDepth
-    def gapDepth=(v)
-      RegexValidator.validate "Bar3DChart.gapWidth", GAP_AMOUNT_PERCENT, v
-      @gapDepth=(v)
+    def gap_depth=(v)
+      RegexValidator.validate "Line3DChart.gapWidth", GAP_AMOUNT_PERCENT, v
+      @gap_depth=(v)
     end
+    alias :gapDepth= :gap_depth=
 
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      super(str) do |str_inner|
-        str_inner << '<c:line3DChart>'
-        str_inner << '<c:grouping val="' << grouping.to_s << '"/>'
-        str_inner << '<c:varyColors val="' << vary_colors.to_s << '"/>'
-        @series.each { |ser| ser.to_xml_string(str_inner) }
-        @d_lbls.to_xml_string(str) if @d_lbls
-        str_inner << '<c:gapDepth val="' << @gapDepth.to_s << '"/>' unless @gapDepth.nil?
-        str_inner << '<c:axId val="' << @catAxId.to_s << '"/>'
-        str_inner << '<c:axId val="' << @valAxId.to_s << '"/>'
-        str_inner << '<c:axId val="' << @serAxId.to_s << '"/>'
-        str_inner << '</c:line3DChart>'
-        @catAxis.to_xml_string str_inner
-        @valAxis.to_xml_string str_inner
-        @serAxis.to_xml_string str_inner
+      # Serializes the object
+      # @param [String] str
+      # @return [String]
+      def to_xml_string(str = '')
+        super(str) do |str_inner|
+          str_inner << '<c:gapDepth val="' << @gap_depth.to_s << '"/>' unless @gap_depth.nil?
+        end
       end
-    end
   end
 end

data/lib/axlsx/drawing/line_chart.rb

@@ -0,0 +1,99 @@
+# encoding: UTF-8
+module Axlsx
+
+  # The LineChart is a two dimentional line chart (who would have guessed?) that you can add to your worksheet.
+  # @example Creating a chart
+  #   # This example creates a line in a single sheet.
+  #   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 ["This is a chart with no data in the sheet"]
+  #
+  #   chart = ws.add_chart(Axlsx::LineChart, :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"]
+  #
+  # @see Worksheet#add_chart
+  # @see Worksheet#add_row
+  # @see Chart#add_series
+  # @see Series
+  # @see Package#serialize
+  class LineChart < Chart
+
+    # the category axis
+    # @return [CatAxis]
+    def cat_axis
+      axes[:cat_axis]
+    end
+    alias :catAxis :cat_axis
+
+    # the category axis
+    # @return [ValAxis]
+    def val_axis
+      axes[:val_axis]
+    end
+    alias :valAxis :val_axis
+
+     # must be one of  [:percentStacked, :clustered, :standard, :stacked]
+    # @return [Symbol]
+    attr_reader :grouping
+
+    # Creates a new line chart object
+    # @param [GraphicFrame] frame The workbook that owns this chart.
+    # @option options [Cell, String] title
+    # @option options [Boolean] show_legend
+    # @option options [Symbol] grouping
+    # @see Chart
+    def initialize(frame, options={})
+      @vary_colors = false
+      @grouping = :standard
+      super(frame, options)
+      @series_type = LineSeries
+      @d_lbls = nil
+    end
+
+    # @see grouping
+    def grouping=(v)
+      RestrictionValidator.validate "LineChart.grouping", [:percentStacked, :standard, :stacked], v
+      @grouping = v
+    end
+
+    # The node name to use in serialization. As LineChart is used as the
+    # base class for Liine3DChart we need to be sure to serialize the
+    # chart based on the actual class type and not a fixed node name.
+    # @return [String]
+    def node_name
+      path = self.class.to_s
+      if i = path.rindex('::')
+        path = path[(i+2)..-1]
+      end
+      path[0] = path[0].chr.downcase
+      path
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do |str_inner|
+        str_inner << "<c:" << node_name << ">"
+        str_inner << '<c:grouping val="' << grouping.to_s << '"/>'
+        str_inner << '<c:varyColors val="' << vary_colors.to_s << '"/>'
+        @series.each { |ser| ser.to_xml_string(str_inner) }
+        @d_lbls.to_xml_string(str_inner) if @d_lbls
+        yield str_inner if block_given?
+        axes.to_xml_string(str_inner, :ids => true)
+        str_inner << "</c:" << node_name << ">"
+        axes.to_xml_string(str_inner)
+      end
+    end
+
+    # The axes for this chart. LineCharts have a category and value
+    # axis.
+    # @return [Axes]
+    def axes
+      @axes ||= Axes.new(:cat_axis => CatAxis, :val_axis => ValAxis)
+    end
+  end
+end

data/lib/axlsx/drawing/line_series.rb

@@ -19,11 +19,16 @@ module Axlsx
     # @return [String]
     attr_reader :color
 
+    # show markers on values
+    # @return [Boolean]
+    attr_reader :show_marker
+
     # Creates a new series
     # @option options [Array, SimpleTypedList] data
     # @option options [Array, SimpleTypedList] labels
     # @param [Chart] chart
     def initialize(chart, options={})
+      @show_marker = false
       @labels, @data = nil, nil
       super(chart, options)
       @labels = AxDataSource.new(:data => options[:labels]) unless options[:labels].nil?
@@ -35,6 +40,12 @@ module Axlsx
       @color = v
     end
 
+    # @see show_marker
+    def show_marker=(v)
+      Axlsx::validate_boolean(v)
+      @show_marker = v
+    end
+
     # Serializes the object
     # @param [String] str
     # @return [String]
@@ -43,9 +54,16 @@ module Axlsx
         if color
           str << '<c:spPr><a:solidFill>'
           str << '<a:srgbClr val="' << color << '"/>'
-          str << '</a:solidFill></c:spPr>'
+          str << '</a:solidFill>'
+          str << '<a:ln w="28800">'
+          str << '<a:solidFill>'
+          str << '<a:srgbClr val="' << color << '"/>'
+          str << '</a:solidFill>'
+          str << '</a:ln>'
+          str << '<a:round/>'
+          str << '</c:spPr>'
         end
-
+        str << '<c:marker><c:symbol val="none"/></c:marker>' unless @show_marker
         @labels.to_xml_string(str) unless @labels.nil?
         @data.to_xml_string(str) unless @data.nil?
       end

data/lib/axlsx/drawing/scatter_chart.rb

@@ -12,35 +12,40 @@ module Axlsx
     # The Style for the scatter chart
     # must be one of :none | :line | :lineMarker | :marker | :smooth | :smoothMarker
     # return [Symbol]
-    attr_reader :scatterStyle
+    attr_reader :scatter_style
+    alias :scatterStyle :scatter_style
 
     # the x value axis
     # @return [ValAxis]
-    attr_reader :xValAxis
+    def x_val_axis
+      axes[:x_val_axis]
+    end
+    alias :xValAxis :x_val_axis
 
     # the y value axis
     # @return [ValAxis]
-    attr_reader :yValAxis
+    def y_val_axis
+      axes[:x_val_axis]
+    end
+    alias :yValAxis :y_val_axis
 
     # Creates a new scatter chart
     def initialize(frame, options={})
       @vary_colors = 0
-      @scatterStyle = :lineMarker
-      @xValAxId = rand(8 ** 8)
-      @yValAxId = rand(8 ** 8)
-      @xValAxis = ValAxis.new(@xValAxId, @yValAxId)
-      @yValAxis = ValAxis.new(@yValAxId, @xValAxId)
-      super(frame, options)
+      @scatter_style = :lineMarker
+
+           super(frame, options)
       @series_type = ScatterSeries
       @d_lbls = nil
       parse_options options
     end
 
     # see #scatterStyle
-    def scatterStyle=(v)
+    def scatter_style=(v)
       Axlsx.validate_scatter_style(v)
-      @scatterStyle = v
+      @scatter_style = v
     end
+    alias :scatterStyle= :scatter_style=
 
     # Serializes the object
     # @param [String] str
@@ -48,17 +53,22 @@ module Axlsx
     def to_xml_string(str = '')
       super(str) do |str_inner|
         str_inner << '<c:scatterChart>'
-        str_inner << '<c:scatterStyle val="' << scatterStyle.to_s << '"/>'
+        str_inner << '<c:scatterStyle val="' << scatter_style.to_s << '"/>'
         str_inner << '<c:varyColors val="' << vary_colors.to_s << '"/>'
         @series.each { |ser| ser.to_xml_string(str_inner) }
-        d_lbls.to_xml_string(str) if @d_lbls
-        str_inner << '<c:axId val="' << @xValAxId.to_s << '"/>'
-        str_inner << '<c:axId val="' << @yValAxId.to_s << '"/>'
+        d_lbls.to_xml_string(str_inner) if @d_lbls
+        axes.to_xml_string(str_inner, :ids => true)
         str_inner << '</c:scatterChart>'
-        @xValAxis.to_xml_string str_inner
-        @yValAxis.to_xml_string str_inner
+        axes.to_xml_string(str_inner)
       end
       str
     end
+
+    # The axes for the scatter chart. ScatterChart has an x_val_axis and
+    # a y_val_axis
+    # @return [Axes]
+    def axes
+      @axes ||= Axes.new(:x_val_axis => ValAxis, :y_val_axis => ValAxis)
+    end
   end
 end

data/lib/axlsx/drawing/ser_axis.rb

@@ -5,30 +5,29 @@ module Axlsx
 
     # The number of tick lables to skip between labels
     # @return [Integer]
-    attr_reader :tickLblSkip
+    attr_reader :tick_lbl_skip
+    alias :tickLblSkip :tick_lbl_skip
 
     # The number of tickmarks to be skipped before the next one is rendered.
     # @return [Boolean]
-    attr_reader :tickMarkSkip
+    attr_reader :tick_mark_skip
+    alias :tickMarkSkip :tick_mark_skip
 
     # Creates a new SerAxis 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 [Integer] tickLblSkip
-    # @option options [Integer] tickMarkSkip
-    def initialize(axId, crossAx, options={})
-      @tickLblSkip, @tickMarkSkip = 1, 1
-      super(axId, crossAx, options)
+    # @option options [Integer] tick_lbl_skip
+    # @option options [Integer] tick_mark_skip
+    def initialize(options={})
+      @tick_lbl_skip, @tick_mark_skip = 1, 1
+      super(options)
     end
 
     # @see tickLblSkip
-    def tickLblSkip=(v) Axlsx::validate_unsigned_int(v); @tickLblSkip = v; end
+    def tick_lbl_skip=(v) Axlsx::validate_unsigned_int(v); @tick_lbl_skip = v; end
+    alias :tickLblSkip= :tick_lbl_skip=
 
     # @see tickMarkSkip
-    def tickMarkSkip=(v) Axlsx::validate_unsigned_int(v); @tickMarkSkip = v; end
+    def tick_mark_skip=(v) Axlsx::validate_unsigned_int(v); @tick_mark_skip = v; end
+    alias :tickMarkSkip= :tick_mark_skip=
 
     # Serializes the object
     # @param [String] str
@@ -36,8 +35,8 @@ module Axlsx
     def to_xml_string(str = '')
       str << '<c:serAx>'
       super(str)
-      str << '<c:tickLblSkip val="' << @tickLblSkip.to_s << '"/>' unless @tickLblSkip.nil?
-      str << '<c:tickMarkSkip val="' << @tickMarkSkip.to_s << '"/>' unless @tickMarkSkip.nil?
+      str << '<c:tickLblSkip val="' << @tick_lbl_skip.to_s << '"/>' unless @tick_lbl_skip.nil?
+      str << '<c:tickMarkSkip val="' << @tick_mark_skip.to_s << '"/>' unless @tick_mark_skip.nil?
       str << '</c:serAx>'
     end
   end

data/lib/axlsx/drawing/val_axis.rb

@@ -6,21 +6,22 @@ module Axlsx
     # This element specifies how the value axis crosses the category axis.
     # must be one of [:between, :midCat]
     # @return [Symbol]
-    attr_reader :crossBetween
+    attr_reader :cross_between
+    alias :crossBetween :cross_between
 
     # Creates a new ValAxis 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
-    # @option options [Symbol] crossesBetween
-    def initialize(axId, crossAx, options={})
-      self.crossBetween = :between
-      super(axId, crossAx, options)
+    # @option options [Symbol] crosses_between
+    def initialize(options={})
+      self.cross_between = :between
+      super(options)
     end
-    # @see crossBetween
-    def crossBetween=(v) RestrictionValidator.validate "ValAxis.crossBetween", [:between, :midCat], v; @crossBetween = v; end
+
+    # @see cross_between
+    def cross_between=(v)
+      RestrictionValidator.validate "ValAxis.cross_between", [:between, :midCat], v
+      @cross_between = v
+    end
+    alias :crossBetween= :cross_between=
 
     # Serializes the object
     # @param [String] str
@@ -28,7 +29,7 @@ module Axlsx
     def to_xml_string(str = '')
       str << '<c:valAx>'
       super(str)
-      str << '<c:crossBetween val="' << @crossBetween.to_s << '"/>'
+      str << '<c:crossBetween val="' << @cross_between.to_s << '"/>'
       str << '</c:valAx>'
     end