Class: Axlsx::Scaling

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

Overview

The Scaling class defines axis scaling

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from OptionsParser

#parse_options

Constructor Details

#initialize(options = {}) ⇒ Scaling

creates a new Scaling object

Parameters:

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

    a customizable set of options

Options Hash (options):

  • logBase (Integer)
  • orientation (Symbol)
  • max (Float)
  • min (Float) 


13
14
15
16
17
 
# File 'lib/axlsx/drawing/scaling.rb', line 13

def initialize(options={})
  @orientation = :minMax
  @logBase, @min, @max = nil, nil, nil
  parse_options options
end

Instance Attribute Details

#logBase ⇒ Integer

logarithmic base for a logarithmic axis. must be between 2 and 1000

Returns:

  • (Integer) 


22
23
24
 
# File 'lib/axlsx/drawing/scaling.rb', line 22

def logBase
  @logBase
end

#max ⇒ Float

the maximum scaling

Returns:

  • (Float) 


31
32
33
 
# File 'lib/axlsx/drawing/scaling.rb', line 31

def max
  @max
end

#min ⇒ Float

the minimu scaling

Returns:

  • (Float) 


35
36
37
 
# File 'lib/axlsx/drawing/scaling.rb', line 35

def min
  @min
end

#orientation ⇒ Symbol

the orientation of the axis must be one of [:minMax, :maxMin]

Returns:

  • (Symbol) 


27
28
29
 
# File 'lib/axlsx/drawing/scaling.rb', line 27

def orientation
  @orientation
end

Instance Method Details

#to_xml_string(str = '') ⇒ String

Serializes the object

Parameters:

  • str (String) (defaults to: '')

Returns:

  • (String) 


50
51
52
53
54
55
56
57
 
# File 'lib/axlsx/drawing/scaling.rb', line 50

def to_xml_string(str = '')
  str << '<c:scaling>'
  str << ('<c:logBase val="' << @logBase.to_s << '"/>') unless @logBase.nil?
  str << ('<c:orientation val="' << @orientation.to_s << '"/>') unless @orientation.nil?
  str << ('<c:min val="' << @min.to_s << '"/>') unless @min.nil?
  str << ('<c:max val="' << @max.to_s << '"/>') unless @max.nil?
  str << '</c:scaling>'
end