summaryrefslogtreecommitdiffhomepage
path: root/lib/axlsx/drawing/area_chart.rb
diff options
context:
space:
mode:
authorDavid N. Robinson <[email protected]>2017-11-07 16:18:43 +0200
committerDavid N. Robinson <[email protected]>2017-11-07 16:18:43 +0200
commite855b75cd13e5a7e16c755ab648594c5a85e6653 (patch)
tree845aa38658997b32948d29ddcb91837802a94d1c /lib/axlsx/drawing/area_chart.rb
parentc8ac844572b25fda358cc01d2104720c4c42f450 (diff)
downloadcaxlsx-e855b75cd13e5a7e16c755ab648594c5a85e6653.tar.gz
caxlsx-e855b75cd13e5a7e16c755ab648594c5a85e6653.zip
Add support for area charts
Diffstat (limited to 'lib/axlsx/drawing/area_chart.rb')
-rw-r--r--lib/axlsx/drawing/area_chart.rb99
1 files changed, 99 insertions, 0 deletions
diff --git a/lib/axlsx/drawing/area_chart.rb b/lib/axlsx/drawing/area_chart.rb
new file mode 100644
index 00000000..e58b2cf1
--- /dev/null
+++ b/lib/axlsx/drawing/area_chart.rb
@@ -0,0 +1,99 @@
+# encoding: UTF-8
+module Axlsx
+
+ # The AreaChart is a two dimentional line chart (who would have guessed?) that you can add to your worksheet.
+ # @example Creating a chart
+ # # This example creates a line in a single sheet.
+ # require "rubygems" # if that is your preferred way to manage gems!
+ # require "axlsx"
+ #
+ # p = Axlsx::Package.new
+ # ws = p.workbook.add_worksheet
+ # ws.add_row ["This is a chart with no data in the sheet"]
+ #
+ # chart = ws.add_chart(Axlsx::AreaChart, :start_at=> [0,1], :end_at=>[0,6], :title=>"Most Popular Pets")
+ # chart.add_series :data => [1, 9, 10], :labels => ["Slimy Reptiles", "Fuzzy Bunnies", "Rottweiler"]
+ #
+ # @see Worksheet#add_chart
+ # @see Worksheet#add_row
+ # @see Chart#add_series
+ # @see Series
+ # @see Package#serialize
+ class AreaChart < Chart
+
+ # the category axis
+ # @return [CatAxis]
+ def cat_axis
+ axes[:cat_axis]
+ end
+ alias :catAxis :cat_axis
+
+ # the category axis
+ # @return [ValAxis]
+ def val_axis
+ axes[:val_axis]
+ end
+ alias :valAxis :val_axis
+
+ # must be one of [:percentStacked, :clustered, :standard, :stacked]
+ # @return [Symbol]
+ attr_reader :grouping
+
+ # Creates a new line 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
+ # @see Chart
+ def initialize(frame, options={})
+ @vary_colors = false
+ @grouping = :standard
+ super(frame, options)
+ @series_type = LineSeries
+ @d_lbls = nil
+ end
+
+ # @see grouping
+ def grouping=(v)
+ RestrictionValidator.validate "AreaChart.grouping", [:percentStacked, :standard, :stacked], v
+ @grouping = v
+ end
+
+ # The node name to use in serialization. As AreaChart is used as the
+ # base class for Liine3DChart we need to be sure to serialize the
+ # chart based on the actual class type and not a fixed node name.
+ # @return [String]
+ def node_name
+ path = self.class.to_s
+ if i = path.rindex('::')
+ path = path[(i+2)..-1]
+ end
+ path[0] = path[0].chr.downcase
+ path
+ end
+
+ # Serializes the object
+ # @param [String] str
+ # @return [String]
+ def to_xml_string(str = '')
+ super(str) do
+ str << ("<c:" << node_name << ">")
+ str << ('<c:grouping val="' << grouping.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
+ yield if block_given?
+ axes.to_xml_string(str, :ids => true)
+ str << ("</c:" << node_name << ">")
+ axes.to_xml_string(str)
+ end
+ end
+
+ # The axes for this chart. AreaCharts have a category and value
+ # axis.
+ # @return [Axes]
+ def axes
+ @axes ||= Axes.new(:cat_axis => CatAxis, :val_axis => ValAxis)
+ end
+ end
+end