From 8cf0296bbc16e8eb535e9af932eed2557d5e66d2 Mon Sep 17 00:00:00 2001 From: Randy Morgan Date: Thu, 1 Dec 2011 14:11:42 +0900 Subject: removing generated yard docs from repository --- doc/Axlsx/Scaling.html | 727 ------------------------------------------------- 1 file changed, 727 deletions(-) delete mode 100644 doc/Axlsx/Scaling.html (limited to 'doc/Axlsx/Scaling.html') diff --git a/doc/Axlsx/Scaling.html b/doc/Axlsx/Scaling.html deleted file mode 100644 index 333a8ba2..00000000 --- a/doc/Axlsx/Scaling.html +++ /dev/null @@ -1,727 +0,0 @@ - - - - - - Class: Axlsx::Scaling - - — AXLSX - - - - - - - - - - - - - - - - - - - - - - -

Class: Axlsx::Scaling - - - -

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

Overview

-
- -

The Scaling class defines axis scaling

- - -
-
-
- - -
- -

Instance Attribute Summary (collapse)

- - - - - - -

- Instance Method Summary - (collapse) -

- - - - -
-

Constructor Details

- -
-

- - - (Scaling) initialize(options = {}) - - - -

-
- -

creates a new Scaling object

- - -
-
-
-

Parameters:

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

    a customizable set of options

    -
    - -
    • - -
- - - - -

Options Hash (options):

-
    - -
  • - logBase - (Integer, Fixnum) - - - - -
    • - -
  • - orientation - (Symbol) - - - - -
    • - -
  • - max - (Float) - - - - -
    • - -
  • - min - (Float) - - - - -
    • - -
- - - -
- - - - -
- 
-
-
-28
-29
-30
-31
-32
-33
-34
- 		- 
# File 'lib/axlsx/drawing/scaling.rb', line 28
-
-def initialize(options={})
-  @orientation = :minMax
-  @logBase, @min, @max = nil, nil, nil
-  options.each do |o|
-    self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-  end
-end
-
-
-
- -
- -
-

Instance Attribute Details

- - - - -
-

- - - (Integer) logBase - - - -

-
- -

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

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Integer) - - - -
    • - -
- -
- - - - -
- 
-
-
-8
-9
-10
- 		- 
# File 'lib/axlsx/drawing/scaling.rb', line 8
-
-def logBase
-  @logBase
-end
-
-
-
- - - - -
-

- - - (Float) max - - - -

-
- -

the maximum scaling

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Float) - - - -
    • - -
- -
- - - - -
- 
-
-
-17
-18
-19
- 		- 
# File 'lib/axlsx/drawing/scaling.rb', line 17
-
-def max
-  @max
-end
-
-
-
- - - - -
-

- - - (Float) min - - - -

-
- -

the minimu scaling

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Float) - - - -
    • - -
- -
- - - - -
- 
-
-
-21
-22
-23
- 		- 
# File 'lib/axlsx/drawing/scaling.rb', line 21
-
-def min
-  @min
-end
-
-
-
- - - - -
-

- - - (Symbol) orientation - - - -

-
- -

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

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Symbol) - - - -
    • - -
- -
- - - - -
- 
-
-
-13
-14
-15
- 		- 
# File 'lib/axlsx/drawing/scaling.rb', line 13
-
-def orientation
-  @orientation
-end
-
-
-
- -
- - -
-

Instance Method Details

- - -
-

- - - (String) to_xml(xml) - - - -

-
- -

Serializes the axId

- - -
-
-
-

Parameters:

-
    - -
  • - - xml - - - (Nokogiri::XML::Builder) - - - - — -
    -

    The document builder instance this objects xml will be added to.

    -
    - -
    • - -
- -

Returns:

-
    - -
  • - - - (String) - - - -
    • - -
- -
- - - - -
- 
-
-
-49
-50
-51
-52
-53
-54
-55
-56
- 		- 
# File 'lib/axlsx/drawing/scaling.rb', line 49
-
-def to_xml(xml)
-  xml.send('c:scaling') {
-    xml.send('c:logBase', :val=> @logBase) unless @logBase.nil?
-    xml.send('c:orientation', :val=> @orientation) unless @orientation.nil?
-    xml.send('c:min', :val => @min) unless @min.nil?
-    xml.send('c:max', :val => @max) unless @max.nil?
-  }
-end
-
-
-
- -
- -
- - - - - \ No newline at end of file -- cgit v1.2.3