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/BorderPr.html | 709 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 709 insertions(+) create mode 100644 doc/Axlsx/BorderPr.html (limited to 'doc/Axlsx/BorderPr.html') diff --git a/doc/Axlsx/BorderPr.html b/doc/Axlsx/BorderPr.html new file mode 100644 index 00000000..72d6b7a0 --- /dev/null +++ b/doc/Axlsx/BorderPr.html @@ -0,0 +1,709 @@ + + + + + + Class: Axlsx::BorderPr + + — Documentation by YARD 0.7.3 + + + + + + + + + + + + + + + + + + + + + + +

Class: Axlsx::BorderPr + + + +

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

Overview

+
+

+A border part. +

+ + +
+
+
+ + +
+ +

Instance Attribute Summary (collapse)

+ + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + +
+

Constructor Details

+ +
+

+ + - (BorderPr) initialize(options = {}) + + + +

+
+

+Creates a new Border Part Object +

+ + +
+
+
+

Parameters:

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

    +a customizable set of options +

    +
    + +
    • + +
+ + + + +

Options Hash (options):

+
    + +
  • + color + (Color) + + + + +
    • + +
  • + name + (Symbol) + + + + +
    • + +
  • + style + (Symbol) + + + + +
    • + +
+ + + +

See Also:

+ + +
+ + + + +
+ 
+
+
+46
+47
+48
+49
+50
+ 		+ 
# File 'lib/axlsx/stylesheet/border_pr.rb', line 46
+
+def initialize(options={})
+  options.each do |o|
+    self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
+  end
+end
+
+
+
+ +
+ +
+

Instance Attribute Details

+ + + + +
+

+ + - (Color) color + + + +

+
+

+The color of this border part. +

+ + +
+
+
+ +

Returns:

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

    +The color of this border part. +

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+6
+7
+8
+ 		+ 
# File 'lib/axlsx/stylesheet/border_pr.rb', line 6
+
+def color
+  @color
+end
+
+
+
+ + + + +
+

+ + - (Symbol) name + + + +

+
+ +
+ Note: +

+The following are allowed +

+
+ :start
+ :end
+ :left
+ :right
+ :top
+ :bottom
+ :diagonal
+ :vertical
+ :horizontal
+
+
+
+ +

+The name of this border part +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Symbol) + + + + — +

    +The name of this border part +

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+39
+40
+41
+ 		+ 
# File 'lib/axlsx/stylesheet/border_pr.rb', line 39
+
+def name
+  @name
+end
+
+
+
+ + + + +
+

+ + - (Symbol) style + + + +

+
+ +
+ Note: +

+The following are allowed +

+
+ :none
+ :thin
+ :medium
+ :dashed
+ :dotted
+ :thick
+ :double
+ :hair
+ :mediumDashed
+ :dashDot
+ :mediumDashDot
+ :dashDotDot
+ :mediumDashDotDot
+ :slantDashDot
+
+
+
+ +

+The syle of this border part. +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Symbol) + + + + — +

    +The syle of this border part. +

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+25
+26
+27
+ 		+ 
# File 'lib/axlsx/stylesheet/border_pr.rb', line 25
+
+def style
+  @style
+end
+
+
+
+ +
+ + +
+

Instance Method Details

+ + +
+

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

+
+

+Serializes the border part +

+ + +
+
+
+

Parameters:

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

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

    +
    + +
    • + +
+ +

Returns:

+
    + +
  • + + + (String) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+59
+60
+61
+62
+63
+ 		+ 
# File 'lib/axlsx/stylesheet/border_pr.rb', line 59
+
+def to_xml(xml)
+  xml.send(@name, :style=>@style) {
+    @color.to_xml(xml) if @color.is_a? Color
+  } 
+end
+
+
+
+ +
+ +
+ + + + + \ No newline at end of file -- cgit v1.2.3