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

Class: Axlsx::Workbook + + + +

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

Overview

+
+

+The Workbook class is an xlsx workbook that manages worksheets, charts, +drawings and styles. The following parts of the Office Open XML spreadsheet +specification are not implimented in this version. +

+
+  bookViews
+  calcPr
+  customWorkbookViews
+  definedNames
+  externalReferences
+  extLst
+  fileRecoveryPr
+  fileSharing
+  fileVersion
+  functionGroups
+  oleSize
+  pivotCaches
+  smartTagPr
+  smartTagTypes
+  webPublishing
+  webPublishObjects
+  workbookProtection
+  workbookPr*
+
+  *workbookPr is only supported to the extend of date1904
+
+ + +
+
+
+ + +
+

Constant Summary

+ +
+ +
@@date1904 = +
+
+

+Indicates if the epoc date for serialization should be 1904. If false, 1900 +is used. +

+ + +
+
+
+ + +
+
+ 
false
+
+ +
+ + + +

Instance Attribute Summary (collapse)

+ + + + + + +

+ Class Method Summary + (collapse) +

+ + + +

+ Instance Method Summary + (collapse) +

+ + + + +
+

Constructor Details

+ +
+

+ + - (Workbook) initialize(options = {}) {|_self| ... } + + + +

+
+

+Creates a new Workbook +

+ + +
+
+
+

Parameters:

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

    +a customizable set of options +

    +
    + +
    • + +
+ + + + +

Options Hash (options):

+
    + +
  • + date1904 + (Boolean) + + + + +
    • + +
+ + +

Yields:

+
    + +
  • + + + (_self) + + + +
    • + +
+

Yield Parameters:

+
    + +
  • + + _self + + + (Axlsx::Workbook) + + + + — +

    +the object that the method was called on +

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+75
+76
+77
+78
+79
+80
+81
+82
+ 		+ 
# File 'lib/axlsx/workbook/workbook.rb', line 75
+
+def initialize(options={})
+  @styles = Styles.new
+  @worksheets = SimpleTypedList.new Worksheet
+  @drawings = SimpleTypedList.new Drawing
+  @charts = SimpleTypedList.new Chart
+  self.date1904= options[:date1904] unless options[:date1904].nil?
+  yield self if block_given?      
+end
+
+
+
+ +
+ +
+

Instance Attribute Details

+ + + + +
+

+ + - (SimpleTypedList) charts (readonly) + + + +

+
+ +
+ Note: +

+The recommended way to manage charts is Worksheet#add_chart +

+
+
+ +

+A colllection of charts associated with this workbook +

+ + +
+
+
+ +

Returns:

+ + +

See Also:

+ + +
+ + + + +
+ 
+
+
+45
+46
+47
+ 		+ 
# File 'lib/axlsx/workbook/workbook.rb', line 45
+
+def charts
+  @charts
+end
+
+
+
+ + + + +
+

+ + - (Boolean) date1904 + + + +

+
+

+Instance level access to the class variable 1904 +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Boolean) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+67
+ 		+ 
# File 'lib/axlsx/workbook/workbook.rb', line 67
+
+def date1904() @@date1904; end
+
+
+
+ + + + +
+

+ + - (SimpleTypedList) drawings (readonly) + + + +

+
+ +
+ Note: +

+The recommended way to manage drawings is Worksheet#add_chart +

+
+
+ +

+A colllection of drawings associated with this workbook +

+ + +
+
+
+ +

Returns:

+ + +

See Also:

+ + +
+ + + + +
+ 
+
+
+52
+53
+54
+ 		+ 
# File 'lib/axlsx/workbook/workbook.rb', line 52
+
+def drawings
+  @drawings
+end
+
+
+
+ + + + +
+

+ + - (Relationships) relationships (readonly) + + + +

+
+

+The workbook relationships. This is managed automatically by the workbook +

+ + +
+
+
+ +

Returns:

+ + +
+ + + + +
+ 
+
+
+63
+64
+65
+66
+67
+68
+69
+70
+ 		+ 
# File 'lib/axlsx/workbook/workbook.rb', line 63
+
+def relationships
+  r = Relationships.new
+  @worksheets.each do |sheet|
+    r << Relationship.new(WORKSHEET_R, WORKSHEET_PN % (r.size+1))
+  end 
+  r << Relationship.new(STYLES_R,  STYLES_PN)
+  r
+end
+
+
+
+ + + + +
+

+ + - (Styles) styles (readonly) + + + +

+
+ +
+ Note: +

+The recommended way to manage styles is Styles#add_style +

+
+
+ +

+The styles associated with this workbook +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Styles) + + + +
    • + +
+ +

See Also:

+
    + +
  • Style#add_style
    • + +
  • Style
    • + +
+ +
+ + + + +
+ 
+
+
+59
+60
+61
+ 		+ 
# File 'lib/axlsx/workbook/workbook.rb', line 59
+
+def styles
+  @styles
+end
+
+
+
+ + + + +
+

+ + - (SimpleTypedList) worksheets (readonly) + + + +

+
+ +
+ Note: +

+The recommended way to manage worksheets is add_worksheet +

+
+
+ +

+A collection of worksheets associated with this workbook. +

+ + +
+
+
+ +

Returns:

+ + +

See Also:

+ + +
+ + + + +
+ 
+
+
+38
+39
+40
+ 		+ 
# File 'lib/axlsx/workbook/workbook.rb', line 38
+
+def worksheets
+  @worksheets
+end
+
+
+
+ +
+ + +
+

Class Method Details

+ + +
+

+ + + (Boolean) date1904 + + + +

+
+

+retrieves the date1904 attribute +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Boolean) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+93
+ 		+ 
# File 'lib/axlsx/workbook/workbook.rb', line 93
+
+def self.date1904() @@date1904; end
+
+
+
+ +
+

+ + + (Boolean) date1904=(v) + + + +

+
+

+Sets the date1904 attribute to the provided boolean +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Boolean) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+89
+ 		+ 
# File 'lib/axlsx/workbook/workbook.rb', line 89
+
+def self.date1904=(v) Axlsx::validate_boolean v; @@date1904 = v end
+
+
+
+ +
+ +
+

Instance Method Details

+ + +
+

+ + - (Worksheet) add_worksheet(options = {}) {|worksheet| ... } + + + +

+
+

+Adds a worksheet to this workbook +

+ + +
+
+
+

Parameters:

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

    +a customizable set of options +

    +
    + +
    • + +
+ + + + +

Options Hash (options):

+
    + +
  • + name + (String) + + + + —

    +The name of the worksheet. +

    +
    +
    • + +
+ + +

Yields:

+
    + +
  • + + + (worksheet) + + + +
    • + +
+

Returns:

+ + +

See Also:

+ + +
+ + + + +
+ 
+
+
+99
+100
+101
+102
+103
+ 		+ 
# File 'lib/axlsx/workbook/workbook.rb', line 99
+
+def add_worksheet(options={})
+  worksheet = Worksheet.new(self, options)
+  yield worksheet if block_given?
+  worksheet
+end
+
+
+
+ +
+

+ + - (String) to_xml + + + +

+
+

+Serializes the workbook document +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+116
+117
+118
+119
+120
+121
+122
+123
+124
+125
+126
+127
+128
+129
+ 		+ 
# File 'lib/axlsx/workbook/workbook.rb', line 116
+
+def to_xml()
+  add_worksheet unless worksheets.size > 0
+  builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
+    xml.workbook(:xmlns => XML_NS, :'xmlns:r' => XML_NS_R) {
+      xml.workbookPr(:date1904=>@@date1904)
+      xml.sheets {
+        @worksheets.each_with_index do |sheet, index|              
+          xml.sheet(:name=>sheet.name, :sheetId=>index+1, :"r:id"=>sheet.rId)
+        end
+      }
+    }
+  end      
+  builder.to_xml(:indent=>0)
+end
+
+
+
+ +
+ +
+ + + + + \ No newline at end of file -- cgit v1.2.3