caxlsx 2.0.2

data/lib/axlsx/drawing/picture_locking.rb

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+module Axlsx
+  # The picture locking class defines the locking properties for pictures in your workbook.
+  class PictureLocking
+
+    include Axlsx::OptionsParser
+    include Axlsx::SerializedAttributes
+    include Axlsx::Accessors
+
+    boolean_attr_accessor :noGrp, :noSelect, :noRot, :noChangeAspect,
+                            :noMove, :noResize, :noEditPoints, :noAdjustHandles,
+                            :noChangeArrowheads, :noChangeShapeType
+
+    serializable_attributes :noGrp, :noSelect, :noRot, :noChangeAspect,
+                            :noMove, :noResize, :noEditPoints, :noAdjustHandles,
+                            :noChangeArrowheads, :noChangeShapeType
+
+    # Creates a new PictureLocking object
+    # @option options [Boolean] noGrp
+    # @option options [Boolean] noSelect
+    # @option options [Boolean] noRot
+    # @option options [Boolean] noChangeAspect
+    # @option options [Boolean] noMove
+    # @option options [Boolean] noResize
+    # @option options [Boolean] noEditPoints
+    # @option options [Boolean] noAdjustHandles
+    # @option options [Boolean] noChangeArrowheads
+    # @option options [Boolean] noChangeShapeType
+    def initialize(options={})
+      @noChangeAspect = true
+      parse_options options
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<a:picLocks '
+      serialized_attributes str
+      str << '/>'
+    end
+
+  end
+end

data/lib/axlsx/drawing/pie_3D_chart.rb

@@ -0,0 +1,48 @@
+# encoding: UTF-8
+module Axlsx
+
+
+  # The Pie3DChart is a three dimentional piechart (who would have guessed?) that you can add to your worksheet.
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  # @see README for an example
+  class Pie3DChart < Chart
+
+    # Creates a new pie 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] 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={})
+      @vary_colors = true
+      super(frame, options)
+      @series_type = PieSeries
+      @view_3D = View3D.new({:rot_x =>30, :perspective=>30}.merge(options))
+      @d_lbls = nil
+    end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do |str_inner|
+
+        str_inner << '<c:pie3DChart>'
+        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:pie3DChart>'
+      end
+    end
+
+  end
+end

data/lib/axlsx/drawing/pie_series.rb

@@ -0,0 +1,74 @@
+# encoding: UTF-8
+module Axlsx
+
+  # A PieSeries defines the data and labels and explosion for pie charts series.
+  # @note The recommended way to manage series is to use Chart#add_series
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  class PieSeries < Series
+
+    # The data for this series.
+    # @return [SimpleTypedList]
+    attr_reader :data
+
+    # The labels for this series.
+    # @return [SimpleTypedList]
+    attr_reader :labels
+
+    # The explosion for this series
+    # @return [Integert]
+    attr_reader :explosion
+
+    # An array of rgb colors to apply to your bar chart.
+    attr_reader :colors
+
+    # Creates a new series
+    # @option options [Array, SimpleTypedList] data
+    # @option options [Array, SimpleTypedList] labels
+    # @option options [String] title
+    # @option options [Integer] explosion
+    # @param [Chart] chart
+    def initialize(chart, options={})
+      @explosion = nil
+      @colors = []
+      super(chart, options)
+      self.labels = AxDataSource.new(:data => options[:labels]) unless options[:labels].nil?
+      self.data = NumDataSource.new(options) unless options[:data].nil?
+    end
+
+    # @see colors
+    def colors=(v) DataTypeValidator.validate "BarSeries.colors", [Array], v; @colors = v end
+
+    # @see explosion
+    def explosion=(v) Axlsx::validate_unsigned_int(v); @explosion = v; end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do |str_inner|
+        str_inner << '<c:explosion val="' << @explosion << '"/>' unless @explosion.nil?
+        colors.each_with_index do |c, index|
+          str << '<c:dPt>'
+          str << '<c:idx val="' << index.to_s << '"/>'
+          str << '<c:spPr><a:solidFill>'
+          str << '<a:srgbClr val="' << c << '"/>'
+          str << '</a:solidFill></c:spPr></c:dPt>'
+        end
+        @labels.to_xml_string str_inner unless @labels.nil?
+        @data.to_xml_string str_inner unless @data.nil?
+      end
+      str
+    end
+
+    private
+
+    # assigns the data for this series
+    def data=(v) DataTypeValidator.validate "Series.data", [NumDataSource], v; @data = v; end
+
+    # assigns the labels for this series
+    def labels=(v) DataTypeValidator.validate "Series.labels", [AxDataSource], v; @labels = v; end
+
+  end
+
+end

data/lib/axlsx/drawing/scaling.rb

@@ -0,0 +1,60 @@
+# encoding: UTF-8
+module Axlsx
+  # The Scaling class defines axis scaling
+  class Scaling
+
+    include Axlsx::OptionsParser
+
+    # creates a new Scaling object
+    # @option options [Integer, Fixnum] logBase
+    # @option options [Symbol] orientation
+    # @option options [Float] max
+    # @option options [Float] min
+    def initialize(options={})
+      @orientation = :minMax
+      @logBase, @min, @max = nil, nil, nil
+      parse_options options
+    end
+
+    # logarithmic base for a logarithmic axis.
+    # must be between 2 and 1000
+    # @return [Integer]
+    attr_reader :logBase
+
+    # the orientation of the axis
+    # must be one of [:minMax, :maxMin]
+    # @return [Symbol]
+    attr_reader :orientation
+
+    # the maximum scaling
+    # @return [Float]
+    attr_reader :max
+
+    # the minimu scaling
+    # @return [Float]
+    attr_reader :min
+
+    # @see logBase
+    def logBase=(v) DataTypeValidator.validate "Scaling.logBase", [Integer, Fixnum], v, lambda { |arg| arg >= 2 && arg <= 1000}; @logBase = v; end
+    # @see orientation
+    def orientation=(v) RestrictionValidator.validate "Scaling.orientation", [:minMax, :maxMin], v; @orientation = v; end
+    # @see max
+    def max=(v) DataTypeValidator.validate "Scaling.max", Float, v; @max = v; end
+
+    # @see min
+    def min=(v) DataTypeValidator.validate "Scaling.min", Float, v; @min = v; end
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      str << '<c:scaling>'
+      str << '<c:logBase val="' << @logBase.to_s << '"/>' unless @logBase.nil?
+      str << '<c:orientation val="' << @orientation.to_s << '"/>' unless @orientation.nil?
+      str << '<c:min val="' << @min.to_s << '"/>' unless @min.nil?
+      str << '<c:max val="' << @max.to_s << '"/>' unless @max.nil?
+      str << '</c:scaling>'
+    end
+
+  end
+end

data/lib/axlsx/drawing/scatter_chart.rb

@@ -0,0 +1,74 @@
+# encoding: UTF-8
+module Axlsx
+
+  # The ScatterChart allows you to insert a scatter chart into your worksheet
+  # @see Worksheet#add_chart
+  # @see Chart#add_series
+  # @see README for an example
+  class ScatterChart < Chart
+
+    include Axlsx::OptionsParser
+
+    # The Style for the scatter chart
+    # must be one of :none | :line | :lineMarker | :marker | :smooth | :smoothMarker
+    # return [Symbol]
+    attr_reader :scatter_style
+    alias :scatterStyle :scatter_style
+
+    # the x value axis
+    # @return [ValAxis]
+    def x_val_axis
+      axes[:x_val_axis]
+    end
+    alias :xValAxis :x_val_axis
+
+    # the y value axis
+    # @return [ValAxis]
+    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
+      @scatter_style = :lineMarker
+
+           super(frame, options)
+      @series_type = ScatterSeries
+      @d_lbls = nil
+      parse_options options
+    end
+
+    # see #scatterStyle
+    def scatter_style=(v)
+      Axlsx.validate_scatter_style(v)
+      @scatter_style = v
+    end
+    alias :scatterStyle= :scatter_style=
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do |str_inner|
+        str_inner << '<c:scatterChart>'
+        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_inner) if @d_lbls
+        axes.to_xml_string(str_inner, :ids => true)
+        str_inner << '</c:scatterChart>'
+        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/scatter_series.rb

@@ -0,0 +1,65 @@
+# 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
+
+    # Creates a new ScatterSeries
+    def initialize(chart, options={})
+      @xData, @yData = 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
+
+    # Serializes the object
+    # @param [String] str
+    # @return [String]
+    def to_xml_string(str = '')
+      super(str) do |inner_str|
+        # 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
+        @xData.to_xml_string(inner_str) unless @xData.nil?
+        @yData.to_xml_string(inner_str) unless @yData.nil?
+      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 str if block_given?
+      str << '</c:ser>'
+    end
+  end
+end