From 2d0ac967e94c5944ccccf9adad8da5a9d082df29 Mon Sep 17 00:00:00 2001 From: Randy Morgan Date: Sun, 20 Nov 2011 23:44:58 +0900 Subject: pushing docs --- doc/Axlsx/GradientStop.html | 526 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 526 insertions(+) create mode 100644 doc/Axlsx/GradientStop.html (limited to 'doc/Axlsx/GradientStop.html') diff --git a/doc/Axlsx/GradientStop.html b/doc/Axlsx/GradientStop.html new file mode 100644 index 00000000..eacf1c92 --- /dev/null +++ b/doc/Axlsx/GradientStop.html @@ -0,0 +1,526 @@ + + + + + + Class: Axlsx::GradientStop + + — Documentation by YARD 0.7.3 + + + + + + + + + + + + + + + + + + + + + + +

Class: Axlsx::GradientStop + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
lib/axlsx/stylesheet/gradient_stop.rb
+ +
+
+ +

Overview

+
+

+The GradientStop object represents a color point in a gradient. +

+ + +
+
+
+ + +

See Also:

+
    + +
  • Office XML Part 1 ยง18.8.24
    • + +
+ +
+ +

Instance Attribute Summary (collapse)

+ + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + +
+

Constructor Details

+ +
+

+ + - (GradientStop) initialize(color, position) + + + +

+
+

+Creates a new GradientStop object +

+ + +
+
+
+

Parameters:

+
    + +
  • + + color + + + (Color) + + + +
    • + +
  • + + position + + + (Float) + + + +
    • + +
+ + +
+ + + + +
+ 
+
+
+18
+19
+20
+21
+ 		+ 
# File 'lib/axlsx/stylesheet/gradient_stop.rb', line 18
+
+def initialize(color, position)
+  self.color = color
+  self.position = position
+end
+
+
+
+ +
+ +
+

Instance Attribute Details

+ + + + +
+

+ + - (Color) color + + + +

+
+

+The color for this gradient stop +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Color) + + + +
    • + +
+ +

See Also:

+ + +
+ + + + +
+ 
+
+
+9
+10
+11
+ 		+ 
# File 'lib/axlsx/stylesheet/gradient_stop.rb', line 9
+
+def color
+  @color
+end
+
+
+
+ + + + +
+

+ + - (Float) position + + + +

+
+

+The position of the color +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Float) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+13
+14
+15
+ 		+ 
# File 'lib/axlsx/stylesheet/gradient_stop.rb', line 13
+
+def position
+  @position
+end
+
+
+
+ +
+ + +
+

Instance Method Details

+ + +
+

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

+
+

+Serializes the gradientStop +

+ + +
+
+
+

Parameters:

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

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

    +
    + +
    • + +
+ +

Returns:

+
    + +
  • + + + (String) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+29
+ 		+ 
# File 'lib/axlsx/stylesheet/gradient_stop.rb', line 29
+
+def to_xml(xml) xml.stop(:position => self.position) {self.color.to_xml(xml)} end
+
+
+
+ +
+ +
+ + + + + \ No newline at end of file -- cgit v1.2.3