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

Class: Axlsx::TableStyleElement + + + +

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

Overview

+
+ +
+ Note: +

+tables and table styles are not supported in this version. This class +exists in preparation for that support. +

+
+
+ +

+an element of style that belongs to a table style. +

+ + +
+
+
+ + +
+ +

Instance Attribute Summary (collapse)

+ + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + +
+

Constructor Details

+ +
+

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

+
+

+creates a new TableStyleElement object +

+ + +
+
+
+

Parameters:

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

    +a customizable set of options +

    +
    + +
    • + +
+ + + + +

Options Hash (options):

+
    + +
  • + type + (Symbol) + + + + +
    • + +
  • + size + (Integer) + + + + +
    • + +
  • + dxfId + (Integer) + + + + +
    • + +
+ + + +
+ + + + +
+ 
+
+
+49
+50
+51
+52
+53
+ 		+ 
# File 'lib/axlsx/stylesheet/table_style_element.rb', line 49
+
+def initialize(options={})
+  options.each do |o|
+    self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
+  end
+end
+
+
+
+ +
+ +
+

Instance Attribute Details

+ + + + +
+

+ + - (Integer) dxfId + + + +

+
+

+The dxfId this style element points to +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Integer) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+43
+44
+45
+ 		+ 
# File 'lib/axlsx/stylesheet/table_style_element.rb', line 43
+
+def dxfId
+  @dxfId
+end
+
+
+
+ + + + +
+

+ + - (Integer) size + + + +

+
+

+Number of rows or columns used in striping when the type is firstRowStripe, +secondRowStripe, firstColumnStripe, or secondColumnStripe. +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Integer) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+39
+40
+41
+ 		+ 
# File 'lib/axlsx/stylesheet/table_style_element.rb', line 39
+
+def size
+  @size
+end
+
+
+
+ + + + +
+

+ + - (Symbol) type + + + +

+
+

+The type of style element. The following type are allowed +

+
+  :wholeTable
+  :headerRow
+  :totalRow
+  :firstColumn
+  :lastColumn
+  :firstRowStripe
+  :secondRowStripe
+  :firstColumnStripe
+  :secondColumnStripe
+  :firstHeaderCell
+  :lastHeaderCell
+  :firstTotalCell
+  :lastTotalCell
+  :firstSubtotalColumn
+  :secondSubtotalColumn
+  :thirdSubtotalColumn
+  :firstSubtotalRow
+  :secondSubtotalRow
+  :thirdSubtotalRow
+  :blankRow
+  :firstColumnSubheading
+  :secondColumnSubheading
+  :thirdColumnSubheading
+  :firstRowSubheading
+  :secondRowSubheading
+  :thirdRowSubheading
+  :pageFieldLabels
+  :pageFieldValues
+
+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Symbol) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+35
+36
+37
+ 		+ 
# File 'lib/axlsx/stylesheet/table_style_element.rb', line 35
+
+def type
+  @type
+end
+
+
+
+ +
+ + +
+

Instance Method Details

+ + +
+

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

+
+

+Serializes the table style element +

+ + +
+
+
+

Parameters:

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

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

    +
    + +
    • + +
+ +

Returns:

+
    + +
  • + + + (String) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+62
+63
+64
+ 		+ 
# File 'lib/axlsx/stylesheet/table_style_element.rb', line 62
+
+def to_xml(xml)
+  xml.tableStyleElement self.instance_values
+end
+
+
+
+ +
+ +
+ + + + + \ No newline at end of file -- cgit v1.2.3