From 058faf2581970fa18c314ad07f5658adeca32c69 Mon Sep 17 00:00:00 2001 From: Randy Morgan Date: Sun, 27 Nov 2011 22:08:55 +0900 Subject: update to README --- doc/Axlsx/Axis.html | 229 ++++++++++++++++++++++------------------------------ 1 file changed, 98 insertions(+), 131 deletions(-) (limited to 'doc/Axlsx/Axis.html') diff --git a/doc/Axlsx/Axis.html b/doc/Axlsx/Axis.html index 5588a0b4..460bcb51 100644 --- a/doc/Axlsx/Axis.html +++ b/doc/Axlsx/Axis.html @@ -94,9 +94,8 @@

Overview

-

-the access class defines common properties and values for a chart axis. -

+ +

the access class defines common properties and values for a chart axis.

@@ -132,9 +131,8 @@ the access class defines common properties and values for a chart axis. -

-the id of the axis. -

+
+

the id of the axis.

 @@ -159,9 +157,8 @@ the id of the axis. -

-The position of the axis must be one of [:l, :r, :t, :b]. -

+
+

The position of the axis must be one of [:l, :r, :t, :b].

 @@ -186,9 +183,8 @@ The position of the axis must be one of [:l, :r, :t, :b]. -

-The perpendicular axis. -

+
+

The perpendicular axis.

 @@ -213,10 +209,9 @@ The perpendicular axis. -

-specifies how the perpendicular axis is crossed must be one of [:autoZero, -:min, :max]. -

+
+

specifies how the perpendicular axis is crossed must be one of [:autoZero, +:min, :max].

 @@ -241,9 +236,8 @@ specifies how the perpendicular axis is crossed must be one of [:autoZero, -

-The number format format code for this axis default :General. -

+
+

The number format format code for this axis default :General.

 @@ -268,9 +262,8 @@ The number format format code for this axis default :General. -

-The scaling of the axis. -

+
+

The scaling of the axis.

 @@ -295,9 +288,8 @@ The scaling of the axis. -

-the position of the tick labels must be one of [:nextTo, :high, :low]. -

+
+

the position of the tick labels must be one of [:nextTo, :high, :low].

 @@ -334,9 +326,8 @@ the position of the tick labels must be one of [:nextTo, :high, :low]. -

-Creates an Axis object. -

+
+

Creates an Axis object.

 @@ -358,9 +349,8 @@ Creates an Axis object. -

-Serializes the common axis. -

+
+

Serializes the common axis.

 @@ -381,9 +371,8 @@ Serializes the common axis.

-

-Creates an Axis object -

+ +

Creates an Axis object

@@ -402,9 +391,8 @@ Creates an Axis object — -

-the id of this axis -

+
+

the id of this axis

@@ -419,9 +407,8 @@ the id of this axis — -

-the id of the perpendicular axis -

+
+

the id of the perpendicular axis

@@ -438,9 +425,8 @@ the id of the perpendicular axis — -

-a customizable set of options -

+
+

a customizable set of options

@@ -498,9 +484,8 @@ a customizable set of options — -

-If axId or crossAx are not unsigned integers -

+
+

If axId or crossAx are not unsigned integers

@@ -532,22 +517,21 @@ If axId or crossAx are not unsigned integers 
# File 'lib/axlsx/drawing/axis.rb', line 45
 
-def initialize(axId, crossAx, options={})
-  Axlsx::validate_unsigned_int(axId)
-  Axlsx::validate_unsigned_int(crossAx)
-  @axId = axId
-  @crossAx = crossAx
-  @format_code = "General"
-  @scaling = Scaling.new(:orientation=>:minMax)
-  self.axPos = :l
-  self.tickLblPos = :nextTo
-  self.format_code = "General"
-  self.crosses = :autoZero
-  options.each do |o|
-    self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
-  end
-end
-
+def initialize(axId, crossAx, options={}) + Axlsx::validate_unsigned_int(axId) + Axlsx::validate_unsigned_int(crossAx) + @axId = axId + @crossAx = crossAx + @format_code = "General" + @scaling = Scaling.new(:orientation=>:minMax) + self.axPos = :l + self.tickLblPos = :nextTo + self.format_code = "General" + self.crosses = :autoZero + options.each do |o| + self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}=" + end +end @@ -570,9 +554,8 @@ If axId or crossAx are not unsigned integers

-

-the id of the axis. -

+ +

the id of the axis.

@@ -606,10 +589,9 @@ the id of the axis. 
# File 'lib/axlsx/drawing/axis.rb', line 7
 
-def axId
-  @axId
-end
-
+def axId + @axId +end @@ -627,9 +609,8 @@ the id of the axis.

-

-The position of the axis must be one of [:l, :r, :t, :b] -

+ +

The position of the axis must be one of [:l, :r, :t, :b]

@@ -663,10 +644,9 @@ The position of the axis must be one of [:l, :r, :t, :b] 
# File 'lib/axlsx/drawing/axis.rb', line 21
 
-def axPos
-  @axPos
-end
-
+def axPos + @axPos +end @@ -684,9 +664,8 @@ The position of the axis must be one of [:l, :r, :t, :b]

-

-The perpendicular axis -

+ +

The perpendicular axis

@@ -720,10 +699,9 @@ The perpendicular axis 
# File 'lib/axlsx/drawing/axis.rb', line 11
 
-def crossAx
-  @crossAx
-end
-
+def crossAx + @crossAx +end @@ -741,10 +719,9 @@ The perpendicular axis

-

-specifies how the perpendicular axis is crossed must be one of [:autoZero, -:min, :max] -

+ +

specifies how the perpendicular axis is crossed must be one of [:autoZero, +:min, :max]

@@ -778,10 +755,9 @@ specifies how the perpendicular axis is crossed must be one of [:autoZero, 
# File 'lib/axlsx/drawing/axis.rb', line 36
 
-def crosses
-  @crosses
-end
-
+def crosses + @crosses +end @@ -799,9 +775,8 @@ specifies how the perpendicular axis is crossed must be one of [:autoZero,

-

-The number format format code for this axis default :General -

+ +

The number format format code for this axis default :General

@@ -835,10 +810,9 @@ The number format format code for this axis default :General 
# File 'lib/axlsx/drawing/axis.rb', line 31
 
-def format_code
-  @format_code
-end
-
+def format_code + @format_code +end @@ -856,9 +830,8 @@ The number format format code for this axis default :General

-

-The scaling of the axis -

+ +

The scaling of the axis

@@ -899,10 +872,9 @@ The scaling of the axis 
# File 'lib/axlsx/drawing/axis.rb', line 16
 
-def scaling
-  @scaling
-end
-
+def scaling + @scaling +end @@ -920,9 +892,8 @@ The scaling of the axis

-

-the position of the tick labels must be one of [:nextTo, :high, :low] -

+ +

the position of the tick labels must be one of [:nextTo, :high, :low]

@@ -956,10 +927,9 @@ the position of the tick labels must be one of [:nextTo, :high, :low] 
# File 'lib/axlsx/drawing/axis.rb', line 26
 
-def tickLblPos
-  @tickLblPos
-end
-
+def tickLblPos + @tickLblPos +end @@ -981,9 +951,8 @@ the position of the tick labels must be one of [:nextTo, :high, :low]

-

-Serializes the common axis -

+ +

Serializes the common axis

@@ -1002,9 +971,8 @@ Serializes the common axis — -

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

+
+

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

@@ -1045,17 +1013,16 @@ The document builder instance this objects xml will be added to. 
# File 'lib/axlsx/drawing/axis.rb', line 79
 
-def to_xml(xml)
-  xml.send('c:axId', :val=>@axId)
-  @scaling.to_xml(xml)
-  xml.send('c:axPos', :val=>@axPos)
-  xml.send('c:majorGridlines')
-  xml.send('c:numFmt', :formatCode => @format_code, :sourceLinked=>"1")
-  xml.send('c:tickLblPos', :val=>@tickLblPos)
-  xml.send('c:crossAx', :val=>@crossAx)
-  xml.send('c:crosses', :val=>@crosses)
-end
-
+def to_xml(xml) + xml.send('c:axId', :val=>@axId) + @scaling.to_xml(xml) + xml.send('c:axPos', :val=>@axPos) + xml.send('c:majorGridlines') + xml.send('c:numFmt', :formatCode => @format_code, :sourceLinked=>"1") + xml.send('c:tickLblPos', :val=>@tickLblPos) + xml.send('c:crossAx', :val=>@crossAx) + xml.send('c:crosses', :val=>@crosses) +end @@ -1066,9 +1033,9 @@ The document builder instance this objects xml will be added to.
-- cgit v1.2.3