Class: Axlsx::Series

Inherits:
Object
  • Object
show all
Includes:
OptionsParser
Defined in:
lib/axlsx/drawing/series.rb

Overview

Note:

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

A Series defines the common series attributes and is the super class for all concrete series types.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from OptionsParser

#parse_options

Constructor Details

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

Creates a new series

Parameters:

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

    a customizable set of options

Options Hash (options):

  • order (Integer)
  • title (String)

23
24
25
26
27
28
# File 'lib/axlsx/drawing/series.rb', line 23

def initialize(chart, options={})
  @order = nil
  self.chart = chart
  @chart.series << self
  parse_options options
end

Instance Attribute Details

#chartChart

The chart that owns this series

Returns:


13
14
15
# File 'lib/axlsx/drawing/series.rb', line 13

def chart
  @chart
end

#titleSeriesTitle

The title of the series

Returns:


17
18
19
# File 'lib/axlsx/drawing/series.rb', line 17

def title
  @title
end

Instance Method Details

#indexInteger

The index of this series in the chart's series.

Returns:

  • (Integer)

32
33
34
# File 'lib/axlsx/drawing/series.rb', line 32

def index
  @chart.series.index(self)
end

#orderInteger

The order of this series in the chart's series. By default the order is the index of the series.

Returns:

  • (Integer)

38
39
40
# File 'lib/axlsx/drawing/series.rb', line 38

def order
  @order || index
end

#order=(v) ⇒ Object

See Also:


43
# File 'lib/axlsx/drawing/series.rb', line 43

def order=(v)  Axlsx::validate_unsigned_int(v); @order = v; end