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/CatAxis.html | 750 ------------------------------------------------- 1 file changed, 750 deletions(-) delete mode 100644 doc/Axlsx/CatAxis.html (limited to 'doc/Axlsx/CatAxis.html') diff --git a/doc/Axlsx/CatAxis.html b/doc/Axlsx/CatAxis.html deleted file mode 100644 index 51fbc5ab..00000000 --- a/doc/Axlsx/CatAxis.html +++ /dev/null @@ -1,750 +0,0 @@ - - - - - - Class: Axlsx::CatAxis - - — AXLSX - - - - - - - - - - - - - - - - - - - - - - -

Class: Axlsx::CatAxis - - - -

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

Overview

-
- -

A CatAxis object defines a chart category axis

- - -
-
-
- - -
-

Constant Summary

- -
- -
LBL_OFFSET_REGEX = -
-
- -

regex for validating label offset

- - -
-
-
- - -
-
- 
/0*(([0-9])|([1-9][0-9])|([1-9][0-9][0-9])|1000)%/
-
- -
- - - - - - - -

Instance Attribute Summary (collapse)

- - - - - - - - - -

Attributes inherited from Axis

-

axId, axPos, crossAx, crosses, format_code, scaling, tickLblPos

- - - -

- Instance Method Summary - (collapse) -

- - - - - - - - - -
-

Constructor Details

- -
-

- - - (CatAxis) initialize(axId, crossAx, options = {}) - - - -

-
- -

Creates a new CatAxis object

- - -
-
-
-

Parameters:

-
    - -
  • - - axId - - - (Integer) - - - - — -
    -

    the id of this axis. Inherited

    -
    - -
    • - -
  • - - crossAx - - - (Integer) - - - - — -
    -

    the id of the perpendicular axis. Inherited

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

    a customizable set of options

    -
    - -
    • - -
- - - - - - - - -

Options Hash (options):

-
    - -
  • - axPos. - (Symbol) - - - - —
    -

    Inherited

    -
    -
    • - -
  • - tickLblPos. - (Symbol) - - - - —
    -

    Inherited

    -
    -
    • - -
  • - crosses. - (Symbol) - - - - —
    -

    Inherited

    -
    -
    • - -
  • - auto - (Boolean) - - - - -
    • - -
  • - lblAlgn - (Symbol) - - - - -
    • - -
  • - lblOffset - (Integer) - - - - -
    • - -
- - - -
- - - - -
- 
-
-
-31
-32
-33
-34
-35
-36
- 		- 
# File 'lib/axlsx/drawing/cat_axis.rb', line 31
-
-def initialize(axId, crossAx, options={})
-  self.auto = true
-  self.lblAlgn = :ctr
-  self.lblOffset = "100%"
-  super(axId, crossAx, options)
-end
-
-
-
- -
- -
-

Instance Attribute Details

- - - - -
-

- - - (Boolean) auto - - - -

-
- -

From the docs: This element specifies that this axis is a date or text axis -based on the data that is used for the axis labels, not a specific choice.

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Boolean) - - - -
    • - -
- -
- - - - -
- 
-
-
-7
-8
-9
- 		- 
# File 'lib/axlsx/drawing/cat_axis.rb', line 7
-
-def auto
-  @auto
-end
-
-
-
- - - - -
-

- - - (Symbol) lblAlgn - - - -

-
- -

specifies how the perpendicular axis is crossed must be one of [:ctr, :l, -:r]

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Symbol) - - - -
    • - -
- -
- - - - -
- 
-
-
-12
-13
-14
- 		- 
# File 'lib/axlsx/drawing/cat_axis.rb', line 12
-
-def lblAlgn
-  @lblAlgn
-end
-
-
-
- - - - -
-

- - - (Integer) lblOffset - - - -

-
- -

The offset of the labels must be between a string between 0 and 1000

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Integer) - - - -
    • - -
- -
- - - - -
- 
-
-
-17
-18
-19
- 		- 
# File 'lib/axlsx/drawing/cat_axis.rb', line 17
-
-def lblOffset
-  @lblOffset
-end
-
-
-
- -
- - -
-

Instance Method Details

- - -
-

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

-
- -

Serializes the category axis

- - -
-
-
-

Parameters:

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

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

    -
    - -
    • - -
- -

Returns:

-
    - -
  • - - - (String) - - - -
    • - -
- -
- - - - -
- 
-
-
-52
-53
-54
-55
-56
-57
-58
-59
- 		- 
# File 'lib/axlsx/drawing/cat_axis.rb', line 52
-
-def to_xml(xml)
-  xml.send('c:catAx') {
-    super(xml)
-    xml.send('c:auto', :val=>@auto)
-    xml.send('c:lblAlgn', :val=>@lblAlgn)
-    xml.send('c:lblOffset', :val=>@lblOffset)                 
-  }
-end
-
-
-
- -
- -
- - - - - \ No newline at end of file -- cgit v1.2.3