Class: Axlsx::Axes

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

Overview

The Axes class creates and manages axis information and serialization for charts.

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Axes

should be an axis name like :val_axis and its value should be the class of the axis type to construct. The :cat_axis, if there is one, must come first (we assume a Ruby 1.9+ Hash or an OrderedHash).

Parameters:

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

    options used to generate axis each key

Raises:

  • (ArgumentError) 


11
12
13
14
15
16
 
# File 'lib/axlsx/drawing/axes.rb', line 11

def initialize(options={})
  raise(ArgumentError, "CatAxis must come first") if options.keys.include?(:cat_axis) && options.keys.first != :cat_axis
  options.each do |name, axis_class|
    add_axis(name, axis_class)
  end
end

Instance Method Details

#[](name) ⇒ Axis

[] provides assiciative access to a specic axis store in an axes instance.

Returns:



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

def [](name)
  axes.assoc(name)[1]
end

#add_axis(name, axis_class) ⇒ Object

Adds an axis to the collection

Parameters:

  • name (Symbol) —

    The name of the axis

  • axis_class (Axis) —

    The axis class to generate



44
45
46
47
48
 
# File 'lib/axlsx/drawing/axes.rb', line 44

def add_axis(name, axis_class)
  axis = axis_class.new
  set_cross_axis(axis)
  axes << [name, axis]
end

#to_xml_string(str = '', options = {}) ⇒ Object

Serializes the object If the ids option is specified only the axis identifier is serialized. Otherwise, each axis is serialized in full.

Parameters:

  • str (String) (defaults to: '')
  • options (Hash) (defaults to: {})

Options Hash (options):

  • ids (Object) 


31
32
33
34
35
36
37
38
39
 
# File 'lib/axlsx/drawing/axes.rb', line 31

def to_xml_string(str = '', options = {})
  if options[:ids]
    # CatAxis must come first in the XML (for Microsoft Excel at least)
    sorted = axes.sort_by { |name, axis| axis.kind_of?(CatAxis) ? 0 : 1 }
    sorted.inject(str) { |string, axis| string << '<c:axId val="' << axis[1].id.to_s << '"/>' }        
  else
    axes.each { |axis| axis[1].to_xml_string(str) }
  end
end