Class: Axlsx::LineSeries

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

Overview

Note:

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

A LineSeries defines the title, data and labels for line 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 = {}) ⇒ LineSeries

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) 


20
21
22
23
24
25
 
# File 'lib/axlsx/drawing/line_series.rb', line 20

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

Instance Attribute Details

#data ⇒ ValAxisData

The data for this series.

Returns:



10
11
12
 
# File 'lib/axlsx/drawing/line_series.rb', line 10

def data
  @data
end

#labels ⇒ CatAxisData

The labels for this series.

Returns:



14
15
16
 
# File 'lib/axlsx/drawing/line_series.rb', line 14

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) 


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

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?
  end      
end