caxlsx 3.2.0 → 3.4.0

data/lib/axlsx/drawing/d_lbls.rb

@@ -1,90 +1,92 @@
-module Axlsx
-  # There are more elements in the dLbls spec that allow for
-  # customizations and formatting. For now, I am just implementing the
-  # basics.
-  #The DLbls class manages serialization of data labels
-  # showLeaderLines and leaderLines are not currently implemented
-  class DLbls
-
-    include Axlsx::Accessors
-    include Axlsx::OptionsParser 
-    # creates a new DLbls object
-    def initialize(chart_type, options={})
-      raise ArgumentError, 'chart_type must inherit from Chart' unless [Chart, LineChart].include?(chart_type.superclass)
-      @chart_type = chart_type
-      initialize_defaults
-      parse_options options
-    end
-
-    # These attributes are all boolean so I'm doing a bit of a hand
-    # waving magic show to set up the attriubte accessors
-    # @note 
-    #   not all charts support all methods! 
-    #   Bar3DChart and Line3DChart and ScatterChart do not support d_lbl_pos or show_leader_lines
-    #    
-    boolean_attr_accessor :show_legend_key, 
-                          :show_val, 
-                          :show_cat_name, 
-                          :show_ser_name, 
-                          :show_percent, 
-                          :show_bubble_size, 
-                          :show_leader_lines
-
-    # Initialize all the values to false as Excel requires them to
-    # explicitly be disabled or all will show.
-    def initialize_defaults
-      [:show_legend_key, :show_val, :show_cat_name, 
-       :show_ser_name, :show_percent, :show_bubble_size, 
-       :show_leader_lines].each do |attr|
-        self.send("#{attr}=", false)
-      end
-    end
-
-    # The chart type that is using this data lables instance. 
-    # This affects the xml output as not all chart types support the
-    # same data label attributes. 
-    attr_reader :chart_type
-
-    # The position of the data labels in the chart
-    # @see d_lbl_pos= for a list of allowed values
-    # @return [Symbol]
-    def d_lbl_pos
-      return unless [Pie3DChart, LineChart].include? @chart_type
-      @d_lbl_pos ||= :bestFit
-    end
-
-    # @see DLbls#d_lbl_pos
-    # Assigns the label postion for this data labels on this chart.
-    # Allowed positions are :bestFit, :b, :ctr, :inBase, :inEnd, :l,
-    # :outEnd, :r and :t
-    # The default is :bestFit
-    # @param [Symbol] label_position the postion you want to use.
-    def d_lbl_pos=(label_position)
-      return unless [Pie3DChart, LineChart].include? @chart_type
-      Axlsx::RestrictionValidator.validate 'DLbls#d_lbl_pos',  [:bestFit, :b, :ctr, :inBase, :inEnd, :l, :outEnd, :r, :t], label_position
-      @d_lbl_pos = label_position
-    end
-
-   
-    # serializes the data labels
-    # @return [String]
-    def to_xml_string(str = '')
-      validate_attributes_for_chart_type
-      str << '<c:dLbls>'
-      %w(d_lbl_pos show_legend_key show_val show_cat_name show_ser_name show_percent show_bubble_size show_leader_lines).each do |key|
-        next unless instance_values.keys.include?(key) && instance_values[key] != nil
-        str <<  "<c:#{Axlsx::camel(key, false)} val='#{instance_values[key]}' />" 
-      end
-      str << '</c:dLbls>'
-    end
-
-    # nills out d_lbl_pos and show_leader_lines as these attributes, while valid in the spec actually chrash excel for any chart type other than pie charts.
-    def validate_attributes_for_chart_type
-      return if [Pie3DChart, LineChart].include? @chart_type
-      @d_lbl_pos = nil
-      @show_leader_lines = nil
-    end
-
-
-  end
-end
+module Axlsx
+  # There are more elements in the dLbls spec that allow for
+  # customizations and formatting. For now, I am just implementing the
+  # basics.
+  # The DLbls class manages serialization of data labels
+  # showLeaderLines and leaderLines are not currently implemented
+  class DLbls
+    include Axlsx::Accessors
+    include Axlsx::OptionsParser
+    # creates a new DLbls object
+    def initialize(chart_type, options = {})
+      raise ArgumentError, 'chart_type must inherit from Chart' unless [Chart, LineChart].include?(chart_type.superclass)
+
+      @chart_type = chart_type
+      initialize_defaults
+      parse_options options
+    end
+
+    # These attributes are all boolean so I'm doing a bit of a hand
+    # waving magic show to set up the attriubte accessors
+    # @note
+    #   not all charts support all methods!
+    #   Bar3DChart and Line3DChart and ScatterChart do not support d_lbl_pos or show_leader_lines
+    #
+    boolean_attr_accessor :show_legend_key,
+                          :show_val,
+                          :show_cat_name,
+                          :show_ser_name,
+                          :show_percent,
+                          :show_bubble_size,
+                          :show_leader_lines
+
+    # Initialize all the values to false as Excel requires them to
+    # explicitly be disabled or all will show.
+    def initialize_defaults
+      [:show_legend_key, :show_val, :show_cat_name,
+       :show_ser_name, :show_percent, :show_bubble_size,
+       :show_leader_lines].each do |attr|
+        self.send("#{attr}=", false)
+      end
+    end
+
+    # The chart type that is using this data lables instance.
+    # This affects the xml output as not all chart types support the
+    # same data label attributes.
+    attr_reader :chart_type
+
+    # The position of the data labels in the chart
+    # @see d_lbl_pos= for a list of allowed values
+    # @return [Symbol]
+    def d_lbl_pos
+      return unless [Pie3DChart, LineChart].include? @chart_type
+
+      @d_lbl_pos ||= :bestFit
+    end
+
+    # @see DLbls#d_lbl_pos
+    # Assigns the label postion for this data labels on this chart.
+    # Allowed positions are :bestFit, :b, :ctr, :inBase, :inEnd, :l,
+    # :outEnd, :r and :t
+    # The default is :bestFit
+    # @param [Symbol] label_position the postion you want to use.
+    def d_lbl_pos=(label_position)
+      return unless [Pie3DChart, LineChart].include? @chart_type
+
+      Axlsx::RestrictionValidator.validate 'DLbls#d_lbl_pos', [:bestFit, :b, :ctr, :inBase, :inEnd, :l, :outEnd, :r, :t], label_position
+      @d_lbl_pos = label_position
+    end
+
+    # serializes the data labels
+    # @return [String]
+    def to_xml_string(str = '')
+      validate_attributes_for_chart_type
+      str << '<c:dLbls>'
+      instance_vals = Axlsx.instance_values_for(self)
+      %w(d_lbl_pos show_legend_key show_val show_cat_name show_ser_name show_percent show_bubble_size show_leader_lines).each do |key|
+        next unless instance_vals.keys.include?(key) && instance_vals[key] != nil
+
+        str << "<c:#{Axlsx::camel(key, false)} val='#{instance_vals[key]}' />"
+      end
+      str << '</c:dLbls>'
+    end
+
+    # nills out d_lbl_pos and show_leader_lines as these attributes, while valid in the spec actually chrash excel for any chart type other than pie charts.
+    def validate_attributes_for_chart_type
+      return if [Pie3DChart, LineChart].include? @chart_type
+
+      @d_lbl_pos = nil
+      @show_leader_lines = nil
+    end
+  end
+end

data/lib/axlsx/drawing/drawing.rb

@@ -1,167 +1,163 @@
-# encoding: UTF-8
-module Axlsx
-  require 'axlsx/drawing/d_lbls.rb'
-  require 'axlsx/drawing/title.rb'
-  require 'axlsx/drawing/series_title.rb'
-  require 'axlsx/drawing/series.rb'
-  require 'axlsx/drawing/pie_series.rb'
-  require 'axlsx/drawing/bar_series.rb'
-  require 'axlsx/drawing/line_series.rb'
-  require 'axlsx/drawing/scatter_series.rb'
-  require 'axlsx/drawing/bubble_series.rb'
-  require 'axlsx/drawing/area_series.rb'
-
-  require 'axlsx/drawing/scaling.rb'
-  require 'axlsx/drawing/axis.rb'
-
-  require 'axlsx/drawing/str_val.rb'
-  require 'axlsx/drawing/num_val.rb'
-  require 'axlsx/drawing/str_data.rb'
-  require 'axlsx/drawing/num_data.rb'
-  require 'axlsx/drawing/num_data_source.rb'
-  require 'axlsx/drawing/ax_data_source.rb'
-
-  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'
-
-  require 'axlsx/drawing/one_cell_anchor.rb'
-  require 'axlsx/drawing/two_cell_anchor.rb'
-  require 'axlsx/drawing/graphic_frame.rb'
-
-  require 'axlsx/drawing/view_3D.rb'
-  require 'axlsx/drawing/chart.rb'
-  require 'axlsx/drawing/pie_3D_chart.rb'
-  require 'axlsx/drawing/bar_3D_chart.rb'
-  require 'axlsx/drawing/bar_chart.rb'
-  require 'axlsx/drawing/line_chart.rb'
-  require 'axlsx/drawing/line_3D_chart.rb'
-  require 'axlsx/drawing/scatter_chart.rb'
-  require 'axlsx/drawing/bubble_chart.rb'
-  require 'axlsx/drawing/area_chart.rb'
-
-  require 'axlsx/drawing/picture_locking.rb'
-  require 'axlsx/drawing/pic.rb'
-  require 'axlsx/drawing/hyperlink.rb'
-
-  require 'axlsx/drawing/vml_drawing.rb'
-  require 'axlsx/drawing/vml_shape.rb'
-
-  # A Drawing is a canvas for charts and images. Each worksheet has a single drawing that manages anchors.
-  # The anchors reference the charts or images via graphical frames. This is not a trivial relationship so please do follow the advice in the note.
-  # @note The recommended way to manage drawings is to use the Worksheet.add_chart and Worksheet.add_image methods.
-  # @see Worksheet#add_chart
-  # @see Worksheet#add_image
-  # @see Chart
-  # see examples/example.rb for an example of how to create a chart.
-  class Drawing
-
-    # The worksheet that owns the drawing
-    # @return [Worksheet]
-    attr_reader :worksheet
-
-    # A collection of anchors for this drawing
-    # only TwoCellAnchors are supported in this version
-    # @return [SimpleTypedList]
-    attr_reader :anchors
-
-    # Creates a new Drawing object
-    # @param [Worksheet] worksheet The worksheet that owns this drawing
-    def initialize(worksheet)
-      DataTypeValidator.validate "Drawing.worksheet", Worksheet, worksheet
-      @worksheet = worksheet
-      @worksheet.workbook.drawings << self
-      @anchors = SimpleTypedList.new [TwoCellAnchor, OneCellAnchor]
-    end
-
-
-    # Adds an image to the chart If th end_at option is specified we create a two cell anchor. By default we use a one cell anchor.
-    # @note The recommended way to manage images is to use Worksheet.add_image. Please refer to that method for documentation.
-    # @see Worksheet#add_image
-    # @return [Pic]
-    def add_image(options={})
-      if options[:end_at]
-        TwoCellAnchor.new(self, options).add_pic(options)
-      else
-        OneCellAnchor.new(self, options)
-      end
-      @anchors.last.object
-    end
-
-    # Adds a chart to the drawing.
-    # @note The recommended way to manage charts is to use Worksheet.add_chart. Please refer to that method for documentation.
-    # @see Worksheet#add_chart
-    def add_chart(chart_type, options={})
-      TwoCellAnchor.new(self, options)
-      @anchors.last.add_chart(chart_type, options)
-    end
-
-    # An array of charts that are associated with this drawing's anchors
-    # @return [Array]
-    def charts
-      charts = @anchors.select { |a| a.object.is_a?(GraphicFrame) }
-      charts.map { |a| a.object.chart }
-    end
-
-    # An array of hyperlink objects associated with this drawings images
-    # @return [Array]
-    def hyperlinks
-      links = self.images.select { |a| a.hyperlink.is_a?(Hyperlink) }
-      links.map { |a| a.hyperlink }
-    end
-
-    # An array of image objects that are associated with this drawing's anchors
-    # @return [Array]
-    def images
-      images = @anchors.select { |a| a.object.is_a?(Pic) }
-      images.map { |a| a.object }
-    end
-
-    # The index of this drawing in the owning workbooks's drawings collection.
-    # @return [Integer]
-    def index
-      @worksheet.workbook.drawings.index(self)
-    end
-
-    # The part name for this drawing
-    # @return [String]
-    def pn
-      "#{DRAWING_PN % (index+1)}"
-    end
-
-    # The relational part name for this drawing
-    # #NOTE This should be rewritten to return an Axlsx::Relationship object.
-    # @return [String]
-    def rels_pn
-      "#{DRAWING_RELS_PN % (index+1)}"
-    end
-
-    # A list of objects this drawing holds.
-    # @return [Array]
-    def child_objects
-      charts + images + hyperlinks
-    end
-
-    # The drawing's relationships.
-    # @return [Relationships]
-    def relationships
-      r = Relationships.new
-      child_objects.each { |child| r << child.relationship }
-      r
-    end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      str << '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'
-      str << ('<xdr:wsDr xmlns:xdr="' << XML_NS_XDR << '" xmlns:a="' << XML_NS_A << '">')
-      anchors.each { |anchor| anchor.to_xml_string(str) }
-      str << '</xdr:wsDr>'
-    end
-
-  end
-end
+module Axlsx
+  require 'axlsx/drawing/d_lbls.rb'
+  require 'axlsx/drawing/title.rb'
+  require 'axlsx/drawing/series_title.rb'
+  require 'axlsx/drawing/series.rb'
+  require 'axlsx/drawing/pie_series.rb'
+  require 'axlsx/drawing/bar_series.rb'
+  require 'axlsx/drawing/line_series.rb'
+  require 'axlsx/drawing/scatter_series.rb'
+  require 'axlsx/drawing/bubble_series.rb'
+  require 'axlsx/drawing/area_series.rb'
+
+  require 'axlsx/drawing/scaling.rb'
+  require 'axlsx/drawing/axis.rb'
+
+  require 'axlsx/drawing/str_val.rb'
+  require 'axlsx/drawing/num_val.rb'
+  require 'axlsx/drawing/str_data.rb'
+  require 'axlsx/drawing/num_data.rb'
+  require 'axlsx/drawing/num_data_source.rb'
+  require 'axlsx/drawing/ax_data_source.rb'
+
+  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'
+
+  require 'axlsx/drawing/one_cell_anchor.rb'
+  require 'axlsx/drawing/two_cell_anchor.rb'
+  require 'axlsx/drawing/graphic_frame.rb'
+
+  require 'axlsx/drawing/view_3D.rb'
+  require 'axlsx/drawing/chart.rb'
+  require 'axlsx/drawing/pie_3D_chart.rb'
+  require 'axlsx/drawing/bar_3D_chart.rb'
+  require 'axlsx/drawing/bar_chart.rb'
+  require 'axlsx/drawing/line_chart.rb'
+  require 'axlsx/drawing/line_3D_chart.rb'
+  require 'axlsx/drawing/scatter_chart.rb'
+  require 'axlsx/drawing/bubble_chart.rb'
+  require 'axlsx/drawing/area_chart.rb'
+
+  require 'axlsx/drawing/picture_locking.rb'
+  require 'axlsx/drawing/pic.rb'
+  require 'axlsx/drawing/hyperlink.rb'
+
+  require 'axlsx/drawing/vml_drawing.rb'
+  require 'axlsx/drawing/vml_shape.rb'
+
+  # A Drawing is a canvas for charts and images. Each worksheet has a single drawing that manages anchors.
+  # The anchors reference the charts or images via graphical frames. This is not a trivial relationship so please do follow the advice in the note.
+  # @note The recommended way to manage drawings is to use the Worksheet.add_chart and Worksheet.add_image methods.
+  # @see Worksheet#add_chart
+  # @see Worksheet#add_image
+  # @see Chart
+  # see examples/example.rb for an example of how to create a chart.
+  class Drawing
+    # The worksheet that owns the drawing
+    # @return [Worksheet]
+    attr_reader :worksheet
+
+    # A collection of anchors for this drawing
+    # only TwoCellAnchors are supported in this version
+    # @return [SimpleTypedList]
+    attr_reader :anchors
+
+    # Creates a new Drawing object
+    # @param [Worksheet] worksheet The worksheet that owns this drawing
+    def initialize(worksheet)
+      DataTypeValidator.validate "Drawing.worksheet", Worksheet, worksheet
+      @worksheet = worksheet
+      @worksheet.workbook.drawings << self
+      @anchors = SimpleTypedList.new [TwoCellAnchor, OneCellAnchor]
+    end
+
+    # Adds an image to the chart If th end_at option is specified we create a two cell anchor. By default we use a one cell anchor.
+    # @note The recommended way to manage images is to use Worksheet.add_image. Please refer to that method for documentation.
+    # @see Worksheet#add_image
+    # @return [Pic]
+    def add_image(options = {})
+      if options[:end_at]
+        TwoCellAnchor.new(self, options).add_pic(options)
+      else
+        OneCellAnchor.new(self, options)
+      end
+      @anchors.last.object
+    end
+
+    # Adds a chart to the drawing.
+    # @note The recommended way to manage charts is to use Worksheet.add_chart. Please refer to that method for documentation.
+    # @see Worksheet#add_chart
+    def add_chart(chart_type, options = {})
+      TwoCellAnchor.new(self, options)
+      @anchors.last.add_chart(chart_type, options)
+    end
+
+    # An array of charts that are associated with this drawing's anchors
+    # @return [Array]
+    def charts
+      charts = @anchors.select { |a| a.object.is_a?(GraphicFrame) }
+      charts.map { |a| a.object.chart }
+    end
+
+    # An array of hyperlink objects associated with this drawings images
+    # @return [Array]
+    def hyperlinks
+      links = self.images.select { |a| a.hyperlink.is_a?(Hyperlink) }
+      links.map { |a| a.hyperlink }
+    end
+
+    # An array of image objects that are associated with this drawing's anchors
+    # @return [Array]
+    def images
+      images = @anchors.select { |a| a.object.is_a?(Pic) }
+      images.map { |a| a.object }
+    end
+
+    # The index of this drawing in the owning workbooks's drawings collection.
+    # @return [Integer]
+    def index
+      @worksheet.workbook.drawings.index(self)
+    end
+
+    # The part name for this drawing
+    # @return [String]
+    def pn
+      "#{DRAWING_PN % (index + 1)}"
+    end
+
+    # The relational part name for this drawing
+    # #NOTE This should be rewritten to return an Axlsx::Relationship object.
+    # @return [String]
+    def rels_pn
+      "#{DRAWING_RELS_PN % (index + 1)}"
+    end
+
+    # A list of objects this drawing holds.
+    # @return [Array]
+    def child_objects
+      charts + images + hyperlinks
+    end
+
+    # The drawing's relationships.
+    # @return [Relationships]
+    def relationships
+      r = Relationships.new
+      child_objects.each { |child| r << child.relationship }
+      r
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>'
+      str << ('<xdr:wsDr xmlns:xdr="' << XML_NS_XDR << '" xmlns:a="' << XML_NS_A << '">')
+      anchors.each { |anchor| anchor.to_xml_string(str) }
+      str << '</xdr:wsDr>'
+    end
+  end
+end

data/lib/axlsx/drawing/graphic_frame.rb

@@ -1,54 +1,51 @@
-# encoding: UTF-8
-module Axlsx
-  # A graphic frame defines a container for a chart object
-  # @note The recommended way to manage charts is Worksheet#add_chart
-  # @see Worksheet#add_chart
-  class GraphicFrame
-
-    # A reference to the chart object associated with this frame
-    # @return [Chart]
-    attr_reader :chart
-
-    # A anchor that holds this frame
-    # @return [TwoCellAnchor]
-    attr_reader :anchor
-
-    # Creates a new GraphicFrame object
-    # @param [TwoCellAnchor] anchor
-    # @param [Class] chart_type
-    def initialize(anchor, chart_type, options)
-      DataTypeValidator.validate "Drawing.chart_type", Chart, chart_type
-      @anchor = anchor
-      @chart = chart_type.new(self, options)
-    end
-
-    # The relationship id for this graphic frame.
-    # @return [String]
-    def rId
-      @anchor.drawing.relationships.for(chart).Id
-    end
-
-    # Serializes the object
-    # @param [String] str
-    # @return [String]
-    def to_xml_string(str = '')
-      # macro attribute should be optional!
-      str << '<xdr:graphicFrame>'
-      str << '<xdr:nvGraphicFramePr>'
-      str << ('<xdr:cNvPr id="' << @anchor.drawing.index.to_s << '" name="' << 'item_' << @anchor.drawing.index.to_s << '"/>')
-      str << '<xdr:cNvGraphicFramePr/>'
-      str << '</xdr:nvGraphicFramePr>'
-      str << '<xdr:xfrm>'
-      str << '<a:off x="0" y="0"/>'
-      str << '<a:ext cx="0" cy="0"/>'
-      str << '</xdr:xfrm>'
-      str << '<a:graphic>'
-      str << ('<a:graphicData uri="' << XML_NS_C << '">')
-      str << ('<c:chart xmlns:c="' << XML_NS_C << '" xmlns:r="' << XML_NS_R << '" r:id="' << rId << '"/>')
-      str << '</a:graphicData>'
-      str << '</a:graphic>'
-      str << '</xdr:graphicFrame>'
-    end
-
-  end
-end
+module Axlsx
+  # A graphic frame defines a container for a chart object
+  # @note The recommended way to manage charts is Worksheet#add_chart
+  # @see Worksheet#add_chart
+  class GraphicFrame
+    # A reference to the chart object associated with this frame
+    # @return [Chart]
+    attr_reader :chart
+
+    # A anchor that holds this frame
+    # @return [TwoCellAnchor]
+    attr_reader :anchor
+
+    # Creates a new GraphicFrame object
+    # @param [TwoCellAnchor] anchor
+    # @param [Class] chart_type
+    def initialize(anchor, chart_type, options)
+      DataTypeValidator.validate "Drawing.chart_type", Chart, chart_type
+      @anchor = anchor
+      @chart = chart_type.new(self, options)
+    end
+
+    # The relationship id for this graphic frame.
+    # @return [String]
+    def rId
+      @anchor.drawing.relationships.for(chart).Id
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      # macro attribute should be optional!
+      str << '<xdr:graphicFrame>'
+      str << '<xdr:nvGraphicFramePr>'
+      str << ('<xdr:cNvPr id="' << @anchor.drawing.index.to_s << '" name="' << 'item_' << @anchor.drawing.index.to_s << '"/>')
+      str << '<xdr:cNvGraphicFramePr/>'
+      str << '</xdr:nvGraphicFramePr>'
+      str << '<xdr:xfrm>'
+      str << '<a:off x="0" y="0"/>'
+      str << '<a:ext cx="0" cy="0"/>'
+      str << '</xdr:xfrm>'
+      str << '<a:graphic>'
+      str << ('<a:graphicData uri="' << XML_NS_C << '">')
+      str << ('<c:chart xmlns:c="' << XML_NS_C << '" xmlns:r="' << XML_NS_R << '" r:id="' << rId << '"/>')
+      str << '</a:graphicData>'
+      str << '</a:graphic>'
+      str << '</xdr:graphicFrame>'
+    end
+  end
+end