bonio-axlsx 2.2.1

data/lib/axlsx/drawing/scatter_series.rb

@@ -0,0 +1,98 @@
+# encoding: UTF-8
+module Axlsx
+
+  # A ScatterSeries defines the x and y position of data in the chart
+  # @note The recommended way to manage series is to use Chart#add_series
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  # @see examples/example.rb
+  class ScatterSeries < Series
+
+    # The x data for this series.
+    # @return [NamedAxisData]
+    attr_reader :xData
+
+    # The y data for this series.
+    # @return [NamedAxisData]
+    attr_reader :yData
+
+    # The fill color for this series.
+    # Red, green, and blue is expressed as sequence of hex digits, RRGGBB. A perceptual gamma of 2.2 is used.
+    # @return [String]
+    attr_reader :color
+
+    # @return [String]
+    attr_reader :ln_width
+
+    # Line smoothing between data points
+    # @return [Boolean]
+    attr_reader :smooth
+    
+    # Creates a new ScatterSeries
+    def initialize(chart, options={})
+      @xData, @yData = nil
+      if options[:smooth].nil?
+        # If caller hasn't specified smoothing or not, turn smoothing on or off based on scatter style
+        @smooth = [:smooth, :smoothMarker].include?(chart.scatter_style)
+      else
+        # Set smoothing according to the option provided
+        Axlsx::validate_boolean(options[:smooth])
+        @smooth = options[:smooth]
+      end
+      @ln_width = options[:ln_width] unless options[:ln_width].nil?
+      super(chart, options)
+      @xData = AxDataSource.new(:tag_name => :xVal, :data => options[:xData]) unless options[:xData].nil?
+      @yData = NumDataSource.new({:tag_name => :yVal, :data => options[:yData]}) unless options[:yData].nil?
+    end
+
+    # @see color
+    def color=(v)
+      @color = v
+    end
+
+    # @see smooth
+    def smooth=(v)
+      Axlsx::validate_boolean(v)
+      @smooth = v
+    end
+    
+    # @see ln_width
+    def ln_width=(v)
+      @ln_width = v
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do
+        # needs to override the super color here to push in ln/and something else!
+        if color
+          str << '<c:spPr><a:solidFill>'
+          str << ('<a:srgbClr val="' << color << '"/>')
+          str << '</a:solidFill>'
+          str << '<a:ln><a:solidFill>'
+          str << ('<a:srgbClr val="' << color << '"/></a:solidFill></a:ln>')
+          str << '</c:spPr>'
+          str << '<c:marker>'
+          str << '<c:spPr><a:solidFill>'
+          str << ('<a:srgbClr val="' << color << '"/>')
+          str << '</a:solidFill>'
+          str << '<a:ln><a:solidFill>'
+          str << ('<a:srgbClr val="' << color << '"/></a:solidFill></a:ln>')
+          str << '</c:spPr>'
+          str << '</c:marker>'
+        end
+        if ln_width
+          str << '<c:spPr>'
+          str << '<a:ln w="' << ln_width << '"/>'
+          str << '</c:spPr>'
+        end
+        @xData.to_xml_string(str) unless @xData.nil?
+        @yData.to_xml_string(str) unless @yData.nil?
+        str << ('<c:smooth val="' << ((smooth) ? '1' : '0') << '"/>')
+      end
+      str
+    end
+  end
+end

data/lib/axlsx/drawing/ser_axis.rb

@@ -0,0 +1,45 @@
+# encoding: UTF-8
+module Axlsx
+  #A SerAxis object defines a series axis
+  class SerAxis < Axis
+
+    # The number of tick lables to skip between labels
+    # @return [Integer]
+    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 :tick_mark_skip
+    alias :tickMarkSkip :tick_mark_skip
+
+    # Creates a new SerAxis object
+    # @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 tick_lbl_skip=(v) Axlsx::validate_unsigned_int(v); @tick_lbl_skip = v; end
+    alias :tickLblSkip= :tick_lbl_skip=
+
+    # @see tickMarkSkip
+    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
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<c:serAx>'
+      super(str)
+      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
+
+
+end

data/lib/axlsx/drawing/series.rb

@@ -0,0 +1,69 @@
+# encoding: UTF-8
+module Axlsx
+  # A Series defines the common series attributes and is the super class for all concrete series types.
+  # @note The recommended way to manage series is to use Chart#add_series
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  class Series
+
+    include Axlsx::OptionsParser
+
+    # The chart that owns this series
+    # @return [Chart]
+    attr_reader :chart
+
+    # The title of the series
+    # @return [SeriesTitle]
+    attr_reader :title
+
+    # Creates a new series
+    # @param [Chart] chart
+    # @option options [Integer] order
+    # @option options [String] title
+    def initialize(chart, options={})
+      @order = nil
+      self.chart = chart
+      @chart.series << self
+      parse_options options
+    end
+
+    # The index of this series in the chart's series.
+    # @return [Integer]
+    def index
+      @chart.series.index(self)
+    end
+
+    # The order of this series in the chart's series. By default the order is the index of the series.
+    # @return [Integer]
+    def order
+      @order || index
+    end
+
+    # @see order
+    def order=(v)  Axlsx::validate_unsigned_int(v); @order = v; end
+
+    # @see title
+    def title=(v)
+      v = SeriesTitle.new(v) if v.is_a?(String) || v.is_a?(Cell)
+      DataTypeValidator.validate "#{self.class}.title", SeriesTitle, v
+      @title = v
+    end
+
+    private
+
+    # assigns the chart for this series
+    def chart=(v)  DataTypeValidator.validate "Series.chart", Chart, v; @chart = v; end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<c:ser>'
+      str << ('<c:idx val="' << index.to_s << '"/>')
+      str << ('<c:order val="' << (order || index).to_s << '"/>')
+      title.to_xml_string(str) unless title.nil?
+      yield if block_given?
+      str << '</c:ser>'
+    end
+  end
+end

data/lib/axlsx/drawing/series_title.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+module Axlsx
+  # A series title is a Title with a slightly different serialization than chart titles.
+  class SeriesTitle < Title
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<c:tx>'
+      str << '<c:strRef>'
+      str << ('<c:f>' << Axlsx::cell_range([@cell]) << '</c:f>')
+      str << '<c:strCache>'
+      str << '<c:ptCount val="1"/>'
+      str << '<c:pt idx="0">'
+      str << ('<c:v>' << @text << '</c:v>')
+      str << '</c:pt>'
+      str << '</c:strCache>'
+      str << '</c:strRef>'
+      str << '</c:tx>'
+    end
+  end
+end

data/lib/axlsx/drawing/str_data.rb

@@ -0,0 +1,42 @@
+# -*- coding: utf-8 -*-
+module Axlsx
+
+  #This specifies the last string data used for a chart. (e.g. strLit and strCache)
+  # This class is extended for NumData to include the formatCode attribute required for numLit and numCache
+  class StrData
+
+    include Axlsx::OptionsParser
+
+    # creates a new StrVal object
+    # @option options [Array] :data
+    # @option options [String] :tag_name
+    def initialize(options={})
+      @tag_prefix = :str
+      @type = StrVal
+      @pt = SimpleTypedList.new(@type)
+      parse_options options
+    end
+
+    # Creates the val objects for this data set. I am not overly confident this is going to play nicely with time and data types.
+    # @param [Array] values An array of cells or values.
+    def data=(values=[])
+      @tag_name = values.first.is_a?(Cell) ? :strCache : :strLit
+      values.each do |value|
+        v = value.is_a?(Cell) ? value.value : value
+        @pt << @type.new(:v => v)
+      end
+    end
+
+    # serialize the object
+    def to_xml_string(str = "")
+      str << ('<c:' << @tag_name.to_s << '>')
+      str << ('<c:ptCount val="' << @pt.size.to_s << '"/>')
+      @pt.each_with_index do |value, index|
+        value.to_xml_string index, str
+      end
+      str << ('</c:' << @tag_name.to_s << '>')
+    end
+
+  end
+
+end

data/lib/axlsx/drawing/str_val.rb

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+module Axlsx
+
+  #This class specifies data for a particular data point.
+  class StrVal
+
+    include Axlsx::OptionsParser
+
+    # creates a new StrVal object
+    # @option options [String] v
+    def initialize(options={})
+      @v = ""
+      @idx = 0
+      parse_options options
+    end
+
+    # a string value.
+    # @return [String]
+    attr_reader :v
+
+    # @see v
+    def v=(v)
+      @v = v.to_s
+    end
+
+    # serialize the object
+    def to_xml_string(idx, str = "")
+      Axlsx::validate_unsigned_int(idx)
+      if !v.to_s.empty?
+        str << ('<c:pt idx="' << idx.to_s << '"><c:v>' << ::CGI.escapeHTML(v.to_s) << '</c:v></c:pt>')
+      end
+    end
+  end
+end

data/lib/axlsx/drawing/title.rb

@@ -0,0 +1,96 @@
+# encoding: UTF-8
+module Axlsx
+  # A Title stores information about the title of a chart
+  class Title
+
+    # The text to be shown. Setting this property directly with a string will remove the cell reference.
+    # @return [String]
+    attr_reader :text
+
+    # Text size property
+    # @return [String]
+    attr_reader :text_size
+
+    # The cell that holds the text for the title. Setting this property will automatically update the text attribute.
+    # @return [Cell]
+    attr_reader :cell
+
+    # Creates a new Title object
+    # @param [String, Cell] title The cell or string to be used for the chart's title
+    def initialize(title="", title_size="")
+      self.cell = title if title.is_a?(Cell)
+      self.text = title.to_s unless title.is_a?(Cell)
+      if title_size.to_s.empty?
+        self.text_size = "1600"
+      else
+        self.text_size = title_size.to_s
+      end
+    end
+
+    # @see text
+    def text=(v)
+      DataTypeValidator.validate 'Title.text', String, v
+      @text = v
+      @cell = nil
+      v
+    end
+
+    # @see text_size
+    def text_size=(v)
+      DataTypeValidator.validate 'Title.text_size', String, v
+      @text_size = v
+      @cell = nil
+      v
+    end
+
+    # @see cell
+    def cell=(v)
+      DataTypeValidator.validate 'Title.text', Cell, v
+      @cell = v
+      @text = v.value.to_s
+      v
+    end
+
+    # Not implemented at this time.
+    #def layout=(v) DataTypeValidator.validate 'Title.layout', Layout, v; @layout = v; end
+    #def overlay=(v) Axlsx::validate_boolean v; @overlay=v; end
+    #def spPr=(v) DataTypeValidator.validate 'Title.spPr', SpPr, v; @spPr = v; end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<c:title>'
+      unless @text.empty?
+        str << '<c:tx>'
+        if @cell.is_a?(Cell)
+          str << '<c:strRef>'
+          str << ('<c:f>' << Axlsx::cell_range([@cell]) << '</c:f>')
+          str << '<c:strCache>'
+          str << '<c:ptCount val="1"/>'
+          str << '<c:pt idx="0">'
+          str << ('<c:v>' << @text << '</c:v>')
+          str << '</c:pt>'
+          str << '</c:strCache>'
+          str << '</c:strRef>'
+        else
+          str << '<c:rich>'
+            str << '<a:bodyPr/>'
+            str << '<a:lstStyle/>'
+            str << '<a:p>'
+              str << '<a:r>'
+                str << ('<a:rPr sz="' << @text_size.to_s << '"/>')
+                str << ('<a:t>' << @text.to_s << '</a:t>')
+              str << '</a:r>'
+            str << '</a:p>'
+          str << '</c:rich>'
+        end
+        str << '</c:tx>'
+      end
+      str << '<c:layout/>'
+      str << '<c:overlay val="0"/>'
+      str << '</c:title>'
+    end
+
+  end
+end

data/lib/axlsx/drawing/two_cell_anchor.rb

@@ -0,0 +1,92 @@
+# encoding: UTF-8
+module Axlsx
+  # This class details the anchor points for drawings.
+  # @note The recommended way to manage drawings and charts is Worksheet#add_chart. Anchors are specified by the :start_at and :end_at options to that method.
+  # @see Worksheet#add_chart
+  class TwoCellAnchor
+
+    include Axlsx::OptionsParser
+
+    # A marker that defines the from cell anchor. The default from column and row are 0 and 0 respectively
+    # @return [Marker]
+    attr_reader :from
+    # A marker that returns the to cell anchor. The default to column and row are 5 and 10 respectively
+    # @return [Marker]
+    attr_reader :to
+
+    # The frame for your chart
+    # @note this will be discontinued in version 2.0 please use object
+    # @return [GraphicFrame]
+    # attr_reader :graphic_frame
+
+    # The object this anchor hosts
+    # @return [Pic, GraphicFrame]
+    attr_reader :object
+
+    # The drawing that holds this anchor
+    # @return [Drawing]
+    attr_reader :drawing
+
+    # Creates a new TwoCellAnchor object
+    # c.start_at 5, 9
+    # @param [Drawing] drawing
+    # @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
+      @from, @to =  Marker.new, Marker.new(:col => 5, :row=>10)
+      parse_options options
+    end
+
+    # sets the col, row attributes for the from marker.
+    # @note The recommended way to set the start position for graphical
+    # objects is directly thru the object. 
+    # @see Chart#start_at
+    def start_at(x, y=nil)
+      from.coord x, y
+    end
+
+    # sets the col, row attributes for the to marker
+    # @note the recommended way to set the to position for graphical
+    # objects is directly thru the object
+    # @see Char#end_at
+    def end_at(x, y=nil)
+      to.coord x, y
+    end
+
+    # Creates a graphic frame and chart object associated with this anchor
+    # @return [Chart]
+    def add_chart(chart_type, options)
+      @object = GraphicFrame.new(self, chart_type, options)
+      @object.chart
+    end
+
+    # Creates an image associated with this anchor.
+    def add_pic(options={})
+      @object = Pic.new(self, options)
+    end
+
+    # The index of this anchor in the drawing
+    # @return [Integer]
+    def index
+      @drawing.anchors.index(self)
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<xdr:twoCellAnchor>'
+      str << '<xdr:from>'
+      from.to_xml_string str
+      str << '</xdr:from>'
+      str << '<xdr:to>'
+      to.to_xml_string str
+      str << '</xdr:to>'
+      object.to_xml_string(str)
+      str << '<xdr:clientData/>'
+      str << '</xdr:twoCellAnchor>'
+    end
+  end
+end