summaryrefslogtreecommitdiffhomepage
path: root/lib/axlsx/drawing/scatter_chart.rb
blob: b9fcffbddfa3288e7653d1a153502f923d471618 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
# frozen_string_literal: true

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[:y_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 << '<c:scatterChart>'
        str << '<c:scatterStyle val="' << scatter_style.to_s << '"/>'
        str << '<c:varyColors val="' << vary_colors.to_s << '"/>'
        @series.each { |ser| ser.to_xml_string(str) }
        d_lbls.to_xml_string(str) if @d_lbls
        axes.to_xml_string(str, ids: true)
        str << '</c:scatterChart>'
        axes.to_xml_string(str)
      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