axlsx 1.1.7 → 1.1.8

data/lib/axlsx/drawing/bar_series.rb

@@ -64,6 +64,7 @@ module Axlsx
 
         @labels.to_xml_string(str_inner) unless @labels.nil?
         @data.to_xml_string(str_inner) unless @data.nil?
+        # this is actually only required for shapes other than box 
         str_inner << '<c:shape val="' << shape.to_s << '"></c:shape>'
       end
     end

data/lib/axlsx/drawing/cat_axis.rb

@@ -3,6 +3,26 @@ module Axlsx
   #A CatAxis object defines a chart category axis
   class CatAxis < Axis
 
+    # Creates a new CatAxis object
+    # @param [Integer] ax_id the id of this axis. Inherited
+    # @param [Integer] cross_ax the id of the perpendicular axis. Inherited
+    # @option options [Symbol] ax_pos. Inherited
+    # @option options [Symbol] tick_lbl_pos. Inherited
+    # @option options [Symbol] crosses. Inherited
+    # @option options [Boolean] auto
+    # @option options [Symbol] lbl_algn
+    # @option options [Integer] lbl_offset
+    # @option options [Integer] tick_lbl_skip
+    # @option options [Integer] tick_mark_skip
+    def initialize(ax_id, cross_ax, options={})
+      @tick_lbl_skip = 1
+      @tick_mark_skip = 1
+      self.auto = 1
+      self.lbl_algn = :ctr
+      self.lbl_offset = "100"
+      super(ax_id, cross_ax, options)
+    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.
     # @return [Boolean]
     attr_reader :auto
@@ -10,64 +30,48 @@ module Axlsx
     # specifies how the perpendicular axis is crossed
     # must be one of [:ctr, :l, :r]
     # @return [Symbol]
-    attr_reader :lblAlgn
+    attr_reader :lbl_algn
+    alias :lblAlgn :lbl_algn
 
     # The offset of the labels
     # must be between a string between 0 and 1000
     # @return [Integer]
-    attr_reader :lblOffset
-
+    attr_reader :lbl_offset
+    alias :lblOffset :lbl_offset
 
     # 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
 
     # 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. 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
-    # @option options [Integer] tickLblSkip
-    # @option options [Integer] tickMarkSkip
-    def initialize(axId, crossAx, options={})
-      @tickLblSkip = 1
-      @tickMarkSkip = 1
-      self.auto = 1
-      self.lblAlgn = :ctr
-      self.lblOffset = "100"
-      super(axId, crossAx, options)
-    end
-
-
-    # @see tickLblSkip
-    def tickLblSkip=(v) Axlsx::validate_unsigned_int(v); @tickLblSkip = v; end
-
-    # @see tickMarkSkip
-    def tickMarkSkip=(v) Axlsx::validate_unsigned_int(v); @tickMarkSkip = v; end
+    # @see tick_lbl_skip
+    def tick_lbl_skip=(v) Axlsx::validate_unsigned_int(v); @tick_lbl_skip = v; end
+    alias :tickLblSkip= :tick_lbl_skip=
 
+    # @see tick_mark_skip
+    def tick_mark_skip=(v) Axlsx::validate_unsigned_int(v); @tick_mark_skip = v; end
+    alias :tickMarkSkip= :tick_mark_skip=
 
     # 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
 
     # specifies how the perpendicular axis is crossed
     # must be one of [:ctr, :l, :r]
-    def lblAlgn=(v) RestrictionValidator.validate "#{self.class}.lblAlgn", [:ctr, :l, :r], v; @lblAlgn = v; end
+    def lbl_algn=(v) RestrictionValidator.validate "#{self.class}.lbl_algn", [:ctr, :l, :r], v; @lbl_algn = v; end
+    alias :lblAlgn= :lbl_algn=
 
     # The offset of the labels
     # must be between a string between 0 and 1000
-    def lblOffset=(v) RegexValidator.validate "#{self.class}.lblOffset", LBL_OFFSET_REGEX, v; @lblOffset = v; end
+    def lbl_offset=(v) RegexValidator.validate "#{self.class}.lbl_offset", LBL_OFFSET_REGEX, v; @lbl_offset = v; end
+    alias :lblOffset= :lbl_offset=
 
     # Serializes the object
     # @param [String] str
@@ -76,10 +80,10 @@ module Axlsx
       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_i.to_s << '"/>'
-      str << '<c:tickLblSkip val="' << @tickLblSkip.to_s << '"/>'
-      str << '<c:tickMarkSkip val="' << @tickMarkSkip.to_s << '"/>'
+      str << '<c:lblAlgn val="' << @lbl_algn.to_s << '"/>'
+      str << '<c:lblOffset val="' << @lbl_offset.to_i.to_s << '"/>'
+      str << '<c:tickLblSkip val="' << @tick_lbl_skip.to_s << '"/>'
+      str << '<c:tickMarkSkip val="' << @tick_mark_skip.to_s << '"/>'
       str << '</c:catAx>'
     end
 

data/lib/axlsx/drawing/chart.rb

@@ -1,13 +1,37 @@
 # encoding: UTF-8
 module Axlsx
+
   # A Chart is the superclass for specific charts
   # @note Worksheet#add_chart is the recommended way to create charts for your worksheets.
   # @see README for examples
   class Chart
 
+    # Creates a new chart object
+    # @param [GraphicalFrame] frame The frame that holds this chart.
+    # @option options [Cell, String] title
+    # @option options [Boolean] show_legend
+    # @option options [Array|String|Cell] start_at The X, Y coordinates defining the top left corner of the chart.
+    # @option options [Array|String|Cell] end_at The X, Y coordinates defining the bottom right corner of the chart.
+    def initialize(frame, options={})
+      @style = 18  
+      @view_3D = nil
+      @graphic_frame=frame
+      @graphic_frame.anchor.drawing.worksheet.workbook.charts << self
+      @series = SimpleTypedList.new Series
+      @show_legend = true
+      @series_type = Series
+      @title = Title.new
+      options.each do |o|
+        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+      end
+      start_at(*options[:start_at]) if options[:start_at]
+      end_at(*options[:end_at]) if options[:end_at]
+      yield self if block_given?
+    end
 
     # The 3D view properties for the chart
-    attr_reader :view3D
+    attr_reader :view_3D
+    alias :view3D :view_3D
 
     # A reference to the graphic frame that owns this chart
     # @return [GraphicFrame]
@@ -37,29 +61,6 @@ module Axlsx
     # @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
-    # @option options [Array|String|Cell] start_at The X, Y coordinates defining the top left corner of the chart.
-    # @option options [Array|String|Cell] end_at The X, Y coordinates defining the bottom right corner of the chart.
-    def initialize(frame, options={})
-      @style = 18  
-      @view3D = nil
-      @graphic_frame=frame
-      @graphic_frame.anchor.drawing.worksheet.workbook.charts << self
-      @series = SimpleTypedList.new Series
-      @show_legend = true
-      @series_type = Series
-      @title = Title.new
-      options.each do |o|
-        self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-      end
-      start_at(*options[:start_at]) if options[:start_at]
-      end_at(*options[:end_at]) if options[:end_at]
-      yield self if block_given?
-    end
-
     # The index of this chart in the workbooks charts collection
     # @return [Integer]
     def index
@@ -89,7 +90,6 @@ module Axlsx
     # @return [Boolean]
     def show_legend=(v) Axlsx::validate_boolean(v); @show_legend = v; end
 
-
     # The style for the chart.
     # see ECMA Part 1 §21.2.2.196
     # @param [Integer] v must be between 1 and 48
@@ -127,7 +127,7 @@ module Axlsx
       @title.to_xml_string str
       # do these need the c: namespace as well???
       str << '<c:autoTitleDeleted val="' << (@title == nil).to_s << '"/>'
-      @view3D.to_xml_string(str) if @view3D
+      @view_3D.to_xml_string(str) if @view_3D
       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>'
@@ -146,6 +146,11 @@ module Axlsx
       str << '<c:dispBlanksAs val="zero"/>'
       str << '<c:showDLblsOverMax val="1"/>'
       str << '</c:chart>'
+      str << '<c:printSettings>'
+      str << '<c:headerFooter/>'
+      str << '<c:pageMargins b="1.0" l="0.75" r="0.75" t="1.0" header="0.5" footer="0.5"/>'
+      str << '<c:pageSetup/>'
+      str << '</c:printSettings>'
       str << '</c:chartSpace>'
     end
 
@@ -188,7 +193,9 @@ module Axlsx
       [x, y]
     end
 
-    def view3D=(v) DataTypeValidator.validate "#{self.class}.view3D", View3D, v; @view3D = v; end
+    def view_3D=(v) DataTypeValidator.validate "#{self.class}.view_3D", View3D, v; @view_3D = v; end
+    alias :view3D= :view_3D=
 
   end
+
 end

data/lib/axlsx/drawing/drawing.rb

@@ -42,12 +42,13 @@ module Axlsx
   require 'axlsx/drawing/vml_drawing.rb'
   require 'axlsx/drawing/vml_shape.rb'
 
-  # A Drawing is a canvas for charts. Each worksheet has a single drawing that manages anchors.
-  # The anchors reference the charts 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 method.
+  # 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 README for an example of how to create a chart.
+  # see examples/example.rb for an example of how to create a chart.
   class Drawing
 
     # The worksheet that owns the drawing

data/lib/axlsx/drawing/line_3D_chart.rb

@@ -70,7 +70,7 @@ module Axlsx
       @serAxis = SerAxis.new(@serAxId, @valAxId)
       super(frame, options)
       @series_type = LineSeries
-      @view3D = View3D.new({:perspective=>30}.merge(options))
+      @view_3D = View3D.new({:perspective=>30}.merge(options))
     end
 
     # @see grouping

data/lib/axlsx/drawing/num_data_source.rb

@@ -36,7 +36,7 @@ module Axlsx
     end
 
     # sets the tag name for this data source
-    # @param [Symbol] One of the allowed_tag_names
+    # @param [Symbol] v One of the allowed_tag_names
     def tag_name=(v)
       Axlsx::RestrictionValidator.validate "#{self.class.name}.tag_name", self.class.allowed_tag_names, v
       @tag_name = v

data/lib/axlsx/drawing/pie_3D_chart.rb

@@ -13,19 +13,19 @@ module Axlsx
     # @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 [String] gap_depth
+    # @option options [Integer] rot_x
+    # @option options [String] h_percent
+    # @option options [Integer] rot_y
+    # @option options [String] depth_percent
+    # @option options [Boolean] r_ang_ax
     # @option options [Integer] perspective
     # @see Chart
     # @see View3D
     def initialize(frame, options={})
       super(frame, options)
       @series_type = PieSeries
-      @view3D = View3D.new({:rotX=>30, :perspective=>30}.merge(options))
+      @view_3D = View3D.new({:rot_x =>30, :perspective=>30}.merge(options))
     end
 
     # Serializes the object

data/lib/axlsx/drawing/two_cell_anchor.rb

@@ -26,16 +26,11 @@ module Axlsx
     attr_reader :drawing
 
 
-    # Creates a new TwoCellAnchor object and sets up a reference to the from and to markers in the
-    # graphic_frame's chart. That means that you can do stuff like
-    # c = worksheet.add_chart Axlsx::Chart
+    # Creates a new TwoCellAnchor object
     # c.start_at 5, 9
-    # @note the chart_type parameter will be replaced with object in v. 2.0.0
     # @param [Drawing] drawing
-    # @param [Class] chart_type This is passed to the graphic frame for instantiation. must be Chart or a subclass of Chart
-    # @param object The object this anchor holds.
-    # @option options [Array] start_at the col, row to start at THIS IS DOCUMENTED BUT NOT IMPLEMENTED HERE!
-    # @option options [Array] end_at the col, row to end at
+    # @option options [Array] :start_at the col, row to start at THIS IS DOCUMENTED BUT NOT IMPLEMENTED HERE!
+    # @option options [Array] :end_at the col, row to end at
     def initialize(drawing, options={})
       @drawing = drawing
       drawing.anchors << self

data/lib/axlsx/drawing/view_3D.rb

@@ -12,63 +12,73 @@ module Axlsx
     # x rotation for the chart
     # must be between -90 and 90
     # @return [Integer]
-    attr_reader :rotX
-
+    attr_reader :rot_x
+    alias :rotX :rot_x
+    
     # height of chart as % of chart
     # must be between 5% and 500%
     # @return [String]
-    attr_reader :hPercent
+    attr_reader :h_percent
+    alias :hPercent :h_percent
 
     # y rotation for the chart
     # must be between 0 and 360
     # @return [Integer]
-    attr_reader :rotY
-
+    attr_reader :rot_y
+    alias :rotY :rot_y
+    
     # depth or chart as % of chart width
     # must be between 20% and 2000%
     # @return [String]
-    attr_reader :depthPercent
+    attr_reader :depth_percent
+    alias :depthPercent :depth_percent
 
     # Chart axis are at right angles
     # @return [Boolean]
-    attr_reader :rAngAx
+    attr_reader :r_ang_ax
+    alias :rAngAx :r_ang_ax
 
     # field of view angle
     # @return [Integer]
     attr_reader :perspective
 
     # Creates a new View3D for charts
-    # @option options [Integer] rotX
-    # @option options [String] hPercent
-    # @option options [Integer] rotY
-    # @option options [String] depthPercent
-    # @option options [Boolean] rAngAx
+    # @option options [Integer] rot_x
+    # @option options [String] h_percent
+    # @option options [Integer] rot_y
+    # @option options [String] depth_percent
+    # @option options [Boolean] r_ang_ax
     # @option options [Integer] perspective
     def initialize(options={})
-      @rotX, @hPercent, @rotY, @depthPercent, @rAngAx, @perspective  = nil, nil, nil, nil, nil, nil
+      @rot_x, @h_percent, @rot_y, @depth_percent, @r_ang_ax, @perspective  = nil, nil, nil, nil, nil, nil
       options.each do |o|
         self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
       end
     end
 
-    # @see rotX
-    def rotX=(v) DataTypeValidator.validate "#{self.class}.rotX", [Integer, Fixnum], v, lambda {|arg| arg >= -90 && arg <= 90 }; @rotX = v; end
+    # @see rot_x
+    def rot_x=(v) DataTypeValidator.validate "#{self.class}.rot_x", [Integer, Fixnum], v, lambda {|arg| arg >= -90 && arg <= 90 }; @rot_x = v; end
+    alias :rotX= :rot_x=
 
-    # @see hPercent
-    def hPercent=(v)
-      RegexValidator.validate "#{self.class}.hPercent", H_PERCENT_REGEX, v
-      @hPercent = v
+    # @see h_percent
+    def h_percent=(v)
+      RegexValidator.validate "#{self.class}.h_percent", H_PERCENT_REGEX, v
+      @h_percent = v
     end
+    alias :hPercent= :h_percent=
 
-    # @see rotY
-    def rotY=(v) DataTypeValidator.validate "#{self.class}.rotY", [Integer, Fixnum], v, lambda {|arg| arg >= 0 && arg <= 360 }; @rotY = v; end
-
-    # @see depthPercent
-    def depthPercent=(v) RegexValidator.validate "#{self.class}.depthPercent", DEPTH_PERCENT_REGEX, v; @depthPercent = v; end
+    # @see rot_y
+    def rot_y=(v) DataTypeValidator.validate "#{self.class}.rot_y", [Integer, Fixnum], v, lambda {|arg| arg >= 0 && arg <= 360 }; @rot_y = v; end
+    alias :rotY= :rot_y=
 
-    # @see rAngAx
-    def rAngAx=(v) Axlsx::validate_boolean(v); @rAngAx = v; end
+    # @see depth_percent
+    def depth_percent=(v) RegexValidator.validate "#{self.class}.depth_percent", DEPTH_PERCENT_REGEX, v; @depth_percent = v; end
+    alias :depthPercent= :depth_percent=
 
+    # @see r_ang_ax
+    def r_ang_ax=(v) Axlsx::validate_boolean(v); @r_ang_ax = v; end
+    alias :rAngAx= :r_ang_ax=
+     
     # @see perspective
     def perspective=(v) DataTypeValidator.validate "#{self.class}.perspective", [Integer, Fixnum], v, lambda {|arg| arg >= 0 && arg <= 240 }; @perspective = v; end
 
@@ -78,11 +88,11 @@ module Axlsx
     # @return [String]
     def to_xml_string(str = '')
       str << '<c:view3D>'
-      str << '<c:rotX val="' << @rotX.to_s << '"/>' unless @rotX.nil?
-      str << '<c:hPercent val="' << @hPercent.to_s << '"/>' unless @hPercent.nil?
-      str << '<c:rotY val="' << @rotY.to_s << '"/>' unless @rotY.nil?
-      str << '<c:depthPercent val="' << @depthPercent.to_s << '"/>' unless @depthPercent.nil?
-      str << '<c:rAngAx val="' << @rAngAx.to_s << '"/>' unless @rAngAx.nil?
+      str << '<c:rotX val="' << @rot_x.to_s << '"/>' unless @rot_x.nil?
+      str << '<c:hPercent val="' << @h_percent.to_s << '"/>' unless @h_percent.nil?
+      str << '<c:rotY val="' << @rot_y.to_s << '"/>' unless @rot_y.nil?
+      str << '<c:depthPercent val="' << @depth_percent.to_s << '"/>' unless @depth_percent.nil?
+      str << '<c:rAngAx val="' << @r_ang_ax.to_s << '"/>' unless @r_ang_ax.nil?
       str << '<c:perspective val="' << @perspective.to_s << '"/>' unless @perspective.nil?
       str << '</c:view3D>'
     end

data/lib/axlsx/drawing/vml_drawing.rb

@@ -4,7 +4,7 @@ module Axlsx
   class VmlDrawing
 
     # creates a new Vml Drawing object.
-    # @param [Comments] the comments object this drawing is associated with
+    # @param [Comments] comments the comments object this drawing is associated with
     def initialize(comments)
       raise ArgumentError, "you must provide a comments object" unless comments.is_a?(Comments)
       @comments = comments