Class: Axlsx::PieSeries

Inherits:
Series
  • Object
show all
Defined in:
lib/axlsx/drawing/pie_series.rb

Overview

Note:

The recommended way to manage series is to use Chart#add_series

A PieSeries defines the data and labels and explosion for pie charts series.

See Also:

Instance Attribute Summary collapse

Attributes inherited from Series

#chart, #title

Instance Method Summary collapse

Methods inherited from Series

#index, #order, #order=

Constructor Details

#initialize(chart, options = {}) ⇒ PieSeries

Creates a new series

Parameters:

  • chart (Chart)
  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • data (Array, SimpleTypedList)
  • labels (Array, SimpleTypedList)
  • title (String)
  • explosion (Integer) 


27
28
29
30
31
32
 
# File 'lib/axlsx/drawing/pie_series.rb', line 27

def initialize(chart, options={})
  @explosion = nil
  super(chart, options)
  self.labels = CatAxisData.new(options[:labels]) unless options[:labels].nil?
  self.data = ValAxisData.new(options[:data]) unless options[:data].nil?
end

Instance Attribute Details

#data ⇒ SimpleTypedList

The data for this series.

Returns:

  • (SimpleTypedList) 


11
12
13
 
# File 'lib/axlsx/drawing/pie_series.rb', line 11

def data
  @data
end

#explosion ⇒ Integert

The explosion for this series

Returns:

  • (Integert) 


19
20
21
 
# File 'lib/axlsx/drawing/pie_series.rb', line 19

def explosion
  @explosion
end

#labels ⇒ SimpleTypedList

The labels for this series.

Returns:

  • (SimpleTypedList) 


15
16
17
 
# File 'lib/axlsx/drawing/pie_series.rb', line 15

def labels
  @labels
end

Instance Method Details

#to_xml(xml) ⇒ String

Serializes the series

Parameters:

  • xml (Nokogiri::XML::Builder) —

    The document builder instance this objects xml will be added to.

Returns:

  • (String) 


40
41
42
43
44
45
46
 
# File 'lib/axlsx/drawing/pie_series.rb', line 40

def to_xml(xml)
  super(xml) do  |xml_inner|
    xml_inner.explosion :val=>@explosion unless @explosion.nil?
    @labels.to_xml(xml_inner) unless @labels.nil?
    @data.to_xml(xml_inner) unless @data.nil?
  end      
end