diff options
| author | Randy Morgan <[email protected]> | 2012-04-03 08:38:37 +0900 |
|---|---|---|
| committer | Randy Morgan <[email protected]> | 2012-04-03 08:38:37 +0900 |
| commit | 7df172a8f3815e1291f41098705650afd5a2b41d (patch) | |
| tree | 35f25742e09201a50c595ac0250c000a3c272c65 /lib/axlsx/drawing/scatter_series.rb | |
| parent | 6f998ecb098c2a3a5eabc6f8ef44a0f25632f2c8 (diff) | |
| download | caxlsx-7df172a8f3815e1291f41098705650afd5a2b41d.tar.gz caxlsx-7df172a8f3815e1291f41098705650afd5a2b41d.zip | |
pre-release cleanup
Diffstat (limited to 'lib/axlsx/drawing/scatter_series.rb')
| -rw-r--r-- | lib/axlsx/drawing/scatter_series.rb | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/lib/axlsx/drawing/scatter_series.rb b/lib/axlsx/drawing/scatter_series.rb index 03b2cbdd..2469e0bf 100644 --- a/lib/axlsx/drawing/scatter_series.rb +++ b/lib/axlsx/drawing/scatter_series.rb @@ -1,6 +1,13 @@ # 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 @@ -9,6 +16,7 @@ module Axlsx # @return [NamedAxisData] attr_reader :yData + # Creates a new ScatterSeries def initialize(chart, options={}) @xData, @yData = nil super(chart, options) @@ -17,6 +25,9 @@ module Axlsx @yData = NamedAxisData.new("yVal", options[:yData]) unless options[:yData].nil? end + # Serializes the object + # @param [String] str + # @return [String] def to_xml_string(str = '') super(str) do |inner_str| @xData.to_xml_string(inner_str) unless @xData.nil? |
