axlsx 1.0.8 → 1.0.9

data/lib/axlsx/drawing/bar_series.rb

@@ -17,7 +17,7 @@ module Axlsx
     # The shabe of the bars or columns
     # must be one of  [:percentStacked, :clustered, :standard, :stacked]
     # @return [Symbol]
-    attr_accessor :shape
+    attr_reader :shape
 
     # Creates a new series
     # @option options [Array, SimpleTypedList] data
@@ -32,6 +32,8 @@ module Axlsx
       self.data = ValAxisData.new(options[:data]) unless options[:data].nil?
     end 
 
+    # The shabe of the bars or columns
+    # must be one of  [:percentStacked, :clustered, :standard, :stacked]
     def shape=(v) 
       RestrictionValidator.validate "BarSeries.shape", [:cone, :coneToMax, :box, :cylinder, :pyramid, :pyramidToMax], v
       @shape = v
@@ -41,10 +43,10 @@ module Axlsx
     # @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)
+      super(xml) do |xml_inner|
+        @labels.to_xml(xml_inner) unless @labels.nil?
+        @data.to_xml(xml_inner) unless @data.nil?
+        xml_inner.send('c:shape', :val=>@shape)
       end      
     end
 

data/lib/axlsx/drawing/cat_axis.rb

@@ -4,17 +4,17 @@ module Axlsx
 
     # 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
+    attr_reader :auto
 
     # specifies how the perpendicular axis is crossed
     # must be one of [:ctr, :l, :r]
     # @return [Symbol]
-    attr_accessor :lblAlgn 
+    attr_reader :lblAlgn 
 
     # The offset of the labels
     # must be between a string between 0 and 1000
     # @return [Integer]
-    attr_accessor :lblOffset
+    attr_reader :lblOffset
 
     # regex for validating label offset
     LBL_OFFSET_REGEX = /0*(([0-9])|([1-9][0-9])|([1-9][0-9][0-9])|1000)%/
@@ -35,8 +35,15 @@ module Axlsx
       super(axId, crossAx, 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.
     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
+
+    # 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
 
     # Serializes the category axis

data/lib/axlsx/drawing/chart.rb

@@ -21,29 +21,21 @@ module Axlsx
     # @return [Series]
     attr_reader :series_type
 
-    # The index of this chart in the workbooks charts collection
-    # @return [Integer]
-    attr_reader :index
-
-    # The part name for this chart
-    # @return [String]
-    attr_reader :pn
-
     #TODO data labels!
-    #attr_accessor :dLabls
+    #attr_reader :dLabls
 
     # The title object for the chart.
     # @return [Title]
-    attr_accessor :title
+    attr_reader :title
 
     # The style for the chart. 
     # see ECMA Part 1 §21.2.2.196
     # @return [Integer]
-    attr_accessor :style
+    attr_reader :style
 
     # Show the legend in the chart
     # @return [Boolean]
-    attr_accessor :show_legend
+    attr_reader :show_legend
    
     # Creates a new chart object
     # @param [GraphicalFrame] frame The frame that holds this chart.
@@ -59,28 +51,42 @@ module Axlsx
       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[:start_at]
+      start_at(*options[:start_at]) if options[:start_at]
+      end_at(*options[:end_at]) if options[:start_at]
       yield self if block_given?
     end
 
+    # The index of this chart in the workbooks charts collection
+    # @return [Integer]
     def index
       @graphic_frame.anchor.drawing.worksheet.workbook.charts.index(self)
     end
 
+    # The part name for this chart
+    # @return [String]
     def pn
       "#{CHART_PN % (index+1)}"
     end
 
+    # The title object for the chart.
+    # @param [String, Cell] v
+    # @return [Title]
     def title=(v) 
       v = Title.new(v) if v.is_a?(String) || v.is_a?(Cell)
       DataTypeValidator.validate "#{self.class}.title", Title, v
       @title = v
     end
 
+    # Show the legend in the chart
+    # @param [Boolean] v
+    # @return [Boolean]
     def show_legend=(v) Axlsx::validate_boolean(v); @show_legend = v; end
 
-    def style=(v) DataTypeValidator.validate "Chart.style", Integer, v, lambda { |v| v >= 1 && v <= 48 }; @style = v; end
+
+    # 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
 
     # backwards compatibility to allow chart.to and chart.from access to anchor markers
     # @note This will be disconinued in version 2.0.0. Please use the end_at method

data/lib/axlsx/drawing/drawing.rb

@@ -47,34 +47,6 @@ module Axlsx
     # @return [SimpleTypedList]
     attr_reader :anchors
 
-    # An array of charts that are associated with this drawing's anchors
-    # @return [Array]
-    attr_reader :charts
-
-    # An array of image objects that are associated with this drawing's anchors
-    # @return [Array]
-    attr_reader :images
-
-    # The index of this drawing in the owning workbooks's drawings collection.
-    # @return [Integer]
-    attr_reader :index
-
-    # The relation reference id for this drawing
-    # @return [String]
-    attr_reader :rId
-
-    # The part name for this drawing
-    # @return [String]
-    attr_reader :pn
-
-    # The relational part name for this drawing
-    # @return [String]
-    attr_reader :rels_pn
-
-    # The drawing's relationships.
-    # @return [Relationships]
-    attr_reader :relationships
-
     # Creates a new Drawing object
     # @param [Worksheet] worksheet The worksheet that owns this drawing
     def initialize(worksheet)
@@ -99,33 +71,47 @@ module Axlsx
       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 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 relation reference id for this drawing
+    # @return [String]
     def rId
       "rId#{index+1}"
     end
 
+    # The part name for this drawing
+    # @return [String]
     def pn
       "#{DRAWING_PN % (index+1)}"
     end
-    
+
+    # The relational part name for this drawing
+    # @return [String]
     def rels_pn
       "#{DRAWING_RELS_PN % (index+1)}"
     end
 
+    # The drawing's relationships.
+    # @return [Relationships]
     def relationships
       r = Relationships.new
       charts.each do |chart|

data/lib/axlsx/drawing/graphic_frame.rb

@@ -12,10 +12,6 @@ module Axlsx
     # @return [TwoCellAnchor]
     attr_reader :anchor
 
-    # The relationship id for this graphic
-    # @return [String]
-    attr_reader :rId
-
     # Creates a new GraphicFrame object
     # @param [TwoCellAnchor] anchor
     # @param [Class] chart_type
@@ -25,6 +21,8 @@ module Axlsx
       @chart = chart_type.new(self, options)
     end
 
+    # The relationship id for this graphic
+    # @return [String]
     def rId 
       "rId#{@anchor.index+1}"
     end

data/lib/axlsx/drawing/line_3D_chart.rb

@@ -34,12 +34,12 @@ module Axlsx
 
     # space between bar or column clusters, as a percentage of the bar or column width.
     # @return [String]
-    attr_accessor :gapDepth
+    attr_reader :gapDepth
 
     #grouping for a column, line, or area chart.
     # must be one of  [:percentStacked, :clustered, :standard, :stacked]
     # @return [Symbol]
-    attr_accessor :grouping
+    attr_reader :grouping
 
     # validation regex for gap amount percent
     GAP_AMOUNT_PERCENT = /0*(([0-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/
@@ -59,6 +59,7 @@ module Axlsx
     # @see Chart
     # @see View3D
     def initialize(frame, options={})
+      @gapDepth = nil
       @grouping = :standard
       @catAxId = rand(8 ** 8)
       @valAxId = rand(8 ** 8)
@@ -71,11 +72,13 @@ module Axlsx
       @view3D = View3D.new({:perspective=>30}.merge(options))
     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)

data/lib/axlsx/drawing/line_series.rb

@@ -18,18 +18,19 @@ module Axlsx
     # @option options [Array, SimpleTypedList] labels
     # @param [Chart] chart
     def initialize(chart, options={})
+      @labels, @data = nil, nil
       super(chart, options)
-      self.labels = CatAxisData.new(options[:labels]) unless options[:labels].nil?
-      self.data = ValAxisData.new(options[:data]) unless options[:data].nil?
+      @labels = CatAxisData.new(options[:labels]) unless options[:labels].nil?
+      @data = ValAxisData.new(options[:data]) unless options[:data].nil?
     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?
+      super(xml) do |xml_inner|
+        @labels.to_xml(xml_inner) unless @labels.nil?
+        @data.to_xml(xml_inner) unless @data.nil?
       end      
     end
 

data/lib/axlsx/drawing/marker.rb

@@ -6,19 +6,19 @@ module Axlsx
 
     # The column this marker anchors to
     # @return [Integer]
-    attr_accessor :col
+    attr_reader :col
 
     # The offset distance from this marker's column
     # @return [Integer]
-    attr_accessor :colOff
+    attr_reader :colOff
 
     # The row this marker anchors to
     # @return [Integer]
-    attr_accessor :row
+    attr_reader :row
 
     # The offset distance from this marker's row
     # @return [Integer]
-    attr_accessor :rowOff
+    attr_reader :rowOff
 
     # Creates a new Marker object
     # @option options [Integer] col
@@ -32,11 +32,15 @@ module Axlsx
       end      
     end
     
+    # @see col
     def col=(v) Axlsx::validate_unsigned_int v; @col = v end
+    # @see colOff
     def colOff=(v) Axlsx::validate_int v; @colOff = v end
+    # @see row
     def row=(v) Axlsx::validate_unsigned_int v; @row = v end
+    # @see rowOff
     def rowOff=(v) Axlsx::validate_int v; @rowOff = v end
-
+    
     # shortcut to set the column, row position for this marker
     # @param col the column for the marker
     # @param row the row of the marker

data/lib/axlsx/drawing/one_cell_anchor.rb

@@ -17,20 +17,15 @@ module Axlsx
     # @return [Drawing]
     attr_reader :drawing
 
-    # The index of this anchor in the drawing
-    # @return [Integer]
-    attr_reader :index
-
-
     # the width of the graphic object in pixels.
     # this is converted to EMU at a 92 ppi resolution
     # @return [Integer]
-    attr_accessor :width
+    attr_reader :width
 
     # the height of the graphic object in pixels
     # this is converted to EMU at a 92 ppi resolution
     # @return [Integer]
-    attr_accessor :height
+    attr_reader :height
 
 
     # Creates a new OneCellAnchor object and an Pic associated with it.
@@ -53,9 +48,14 @@ module Axlsx
       @object = Pic.new(self, options)
     end
 
+    # @see height
     def height=(v) Axlsx::validate_unsigned_int(v); @height = v; end
+
+    # @see width
     def width=(v) Axlsx::validate_unsigned_int(v); @width = v; end
 
+    # The index of this anchor in the drawing
+    # @return [Integer]
     def index
       @drawing.anchors.index(self)
     end

data/lib/axlsx/drawing/pic.rb

@@ -10,50 +10,22 @@ module Axlsx
 
     # The name to use for this picture
     # @return [String]
-    attr_accessor :name
+    attr_reader :name
 
-    # providing access to the anchor's width attribute
-    # @param [Integer] v
-    # @see OneCellAnchor.width
-    attr_accessor :width
-
-    # providing access to update the anchor's height attribute
-    # @param [Integer] v
-    # @see OneCellAnchor.width
-    attr_accessor :height
 
     # A description of the picture
     # @return [String]
-    attr_accessor :descr
+    attr_reader :descr
 
     # The path to the image you want to include
     # Only local images are supported at this time and only jpg support
     # @return [String]
-    attr_accessor :image_src
+    attr_reader :image_src
 
     # The anchor for this image
     # @return [OneCellAnchor]
     attr_reader :anchor
 
-    # returns the extension of image_src without the preceeding '.'
-    # @return [String]
-    attr_reader :extname
-
-    # The file name of image_src without any path information
-    # @return [String]
-    attr_reader :file_name
-
-    # The part name for this image used in serialization and relationship building
-    # @return [String]
-    attr_reader :pn
-
-    # The index of this image in the workbooks images collections
-    # @return [Index]
-    attr_reader :index
-
-    # The name of the image file, sans directory info
-    # @return [String]
-    attr_reader :file_name
    
     # Creates a new Pic(ture) object
     # @param [Anchor] anchor the anchor that holds this image
@@ -69,7 +41,7 @@ module Axlsx
       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]
+      start_at(*options[:start_at]) if options[:start_at]
       yield self if block_given?
     end
     
@@ -80,41 +52,61 @@ module Axlsx
       @image_src = v
     end
 
+    # @see name
     def name=(v) Axlsx::validate_string(v); @name = v; end
+
+    # @see descr
     def descr=(v) Axlsx::validate_string(v); @descr = v; end
 
+
+    # The file name of image_src without any path information
+    # @return [String]
     def file_name
       File.basename(image_src) unless image_src.nil?
     end    
     
+    # returns the extension of image_src without the preceeding '.'
+    # @return [String]
     def extname
       File.extname(image_src).delete('.') unless image_src.nil?
     end
 
+    # The index of this image in the workbooks images collections
+    # @return [Index]
     def index
       @anchor.drawing.worksheet.workbook.images.index(self)
     end
-    
+
+    # The part name for this image used in serialization and relationship building
+    # @return [String]
     def pn
       "#{IMAGE_PN % [(index+1), extname]}"
     end
 
+    # providing access to the anchor's width attribute
+    # @param [Integer] v
+    # @see OneCellAnchor.width
     def width
       @anchor.width
     end
 
+    # @see width
     def width=(v)
       @anchor.width = v
     end
 
-    def height=(v)
-      @anchor.height = v
-    end
-
+    # providing access to update the anchor's height attribute
+    # @param [Integer] v
+    # @see OneCellAnchor.width
     def height
       @anchor.height
     end
 
+    # @see height
+    def height=(v)
+      @anchor.height = v
+    end
+
     # This is a short cut method to set the start anchor position
     # If you need finer granularity in positioning use
     # graphic_frame.anchor.from.colOff / rowOff