Class: Axlsx::PieChart

Inherits:
Chart
  • Object
show all
Defined in:
lib/axlsx/drawing/pie_chart.rb

Overview

The PieChart is a pie chart that you can add to your worksheet.

See Also:

Instance Attribute Summary

Attributes inherited from Chart

#bg_color, #display_blanks_as, #graphic_frame, #legend_position, #plot_visible_only, #rounded_corners, #series, #series_type, #show_legend, #style, #title, #vary_colors, #view_3D

Instance Method Summary collapse

Methods inherited from Chart

#add_series, #d_lbls, #end_at, #from, #index, #pn, #relationship, #start_at, #title_size=, #to

Methods included from OptionsParser

#parse_options

Constructor Details

#initialize(frame, options = {}) ⇒ PieChart

Creates a new pie chart object

Parameters:

  • frame (GraphicFrame)

    The workbook that owns this chart.

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • title (Cell, String)
  • show_legend (Boolean)
  • grouping (Symbol)
  • gap_depth (String)

See Also:



16
17
18
19
20
21
# File 'lib/axlsx/drawing/pie_chart.rb', line 16

def initialize(frame, options = {})
  @vary_colors = true
  super(frame, options)
  @series_type = PieSeries
  @d_lbls = nil
end

Instance Method Details

#to_xml_string(str = +'')) ⇒ String

Serializes the object

Parameters:

  • str (String) (defaults to: +''))

Returns:

  • (String)


26
27
28
29
30
31
32
33
34
# File 'lib/axlsx/drawing/pie_chart.rb', line 26

def to_xml_string(str = +'')
  super(str) do
    str << '<c:pieChart>'
    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
    str << '</c:pieChart>'
  end
end