Class: Axlsx::BarSeries

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

Overview

Note:

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

A BarSeries defines the title, data and labels for bar charts

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 = {}) ⇒ BarSeries

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)
  • shape (String) 


29
30
31
32
33
34
 
# File 'lib/axlsx/drawing/bar_series.rb', line 29

def initialize(chart, options={})
  @shape = :box
  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 ⇒ Array, SimpleTypedList

The data for this series.

Returns:

  • (Array, SimpleTypedList) 


12
13
14
 
# File 'lib/axlsx/drawing/bar_series.rb', line 12

def data
  @data
end

#labels ⇒ Array, SimpleTypedList

The labels for this series.

Returns:

  • (Array, SimpleTypedList) 


16
17
18
 
# File 'lib/axlsx/drawing/bar_series.rb', line 16

def labels
  @labels
end

#shape ⇒ Symbol

The shabe of the bars or columns must be one of [:percentStacked, :clustered, :standard, :stacked]

Returns:

  • (Symbol) 


21
22
23
 
# File 'lib/axlsx/drawing/bar_series.rb', line 21

def shape
  @shape
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) 


46
47
48
49
50
51
52
 
# File 'lib/axlsx/drawing/bar_series.rb', line 46

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