Class: Axlsx::Workbook
- Inherits:
-
Object
- Object
- Axlsx::Workbook
- 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 collapse
- @@date1904 =
Indicates if the epoc date for serialization should be 1904. If false, 1900 is used.
false
Instance Attribute Summary collapse
-
#charts ⇒ SimpleTypedList
readonly
A colllection of charts associated with this workbook.
-
#date1904 ⇒ Boolean
Instance level access to the class variable 1904.
-
#drawings ⇒ SimpleTypedList
readonly
A colllection of drawings associated with this workbook.
-
#images ⇒ SimpleTypedList
readonly
A colllection of images associated with this workbook.
- #relationships ⇒ Relationships readonly
-
#styles ⇒ Styles
readonly
The styles associated with this workbook.
-
#worksheets ⇒ SimpleTypedList
readonly
A collection of worksheets associated with this workbook.
Class Method Summary collapse
-
.date1904 ⇒ Boolean
retrieves the date1904 attribute.
-
.date1904=(v) ⇒ Boolean
Sets the date1904 attribute to the provided boolean.
Instance Method Summary collapse
-
#add_worksheet(options = {}) {|worksheet| ... } ⇒ Worksheet
Adds a worksheet to this workbook.
-
#initialize(options = {}) {|_self| ... } ⇒ Workbook
constructor
Creates a new Workbook.
-
#to_xml ⇒ String
Serializes the workbook document.
Constructor Details
#initialize(options = {}) {|_self| ... } ⇒ Workbook
Creates a new Workbook
82 83 84 85 86 87 88 89 90 |
# File 'lib/axlsx/workbook/workbook.rb', line 82 def initialize(={}) @styles = Styles.new @worksheets = SimpleTypedList.new Worksheet @drawings = SimpleTypedList.new Drawing @charts = SimpleTypedList.new Chart @images = SimpleTypedList.new Pic self.date1904= [:date1904] unless [:date1904].nil? yield self if block_given? end |
Instance Attribute Details
#charts ⇒ SimpleTypedList (readonly)
The recommended way to manage charts is Worksheet#add_chart
A colllection of charts associated with this workbook
45 46 47 |
# File 'lib/axlsx/workbook/workbook.rb', line 45 def charts @charts end |
#date1904 ⇒ Boolean
Instance level access to the class variable 1904
74 75 76 |
# File 'lib/axlsx/workbook/workbook.rb', line 74 def date1904 @date1904 end |
#drawings ⇒ SimpleTypedList (readonly)
The recommended way to manage drawings is Worksheet#add_chart
A colllection of drawings associated with this workbook
59 60 61 |
# File 'lib/axlsx/workbook/workbook.rb', line 59 def drawings @drawings end |
#images ⇒ SimpleTypedList (readonly)
The recommended way to manage images is Worksheet#add_image
A colllection of images associated with this workbook
52 53 54 |
# File 'lib/axlsx/workbook/workbook.rb', line 52 def images @images end |
#relationships ⇒ Relationships (readonly)
70 71 72 |
# File 'lib/axlsx/workbook/workbook.rb', line 70 def relationships @relationships end |
#styles ⇒ Styles (readonly)
The recommended way to manage styles is Styles#add_style
The styles associated with this workbook
66 67 68 |
# File 'lib/axlsx/workbook/workbook.rb', line 66 def styles @styles end |
#worksheets ⇒ SimpleTypedList (readonly)
The recommended way to manage worksheets is add_worksheet
A collection of worksheets associated with this workbook.
38 39 40 |
# File 'lib/axlsx/workbook/workbook.rb', line 38 def worksheets @worksheets end |
Class Method Details
.date1904 ⇒ Boolean
retrieves the date1904 attribute
101 |
# File 'lib/axlsx/workbook/workbook.rb', line 101 def self.date1904() @@date1904; end |
.date1904=(v) ⇒ Boolean
Sets the date1904 attribute to the provided boolean
97 |
# File 'lib/axlsx/workbook/workbook.rb', line 97 def self.date1904=(v) Axlsx::validate_boolean v; @@date1904 = v; end |
Instance Method Details
#add_worksheet(options = {}) {|worksheet| ... } ⇒ Worksheet
Adds a worksheet to this workbook
107 108 109 110 111 |
# File 'lib/axlsx/workbook/workbook.rb', line 107 def add_worksheet(={}) worksheet = Worksheet.new(self, ) yield worksheet if block_given? worksheet end |
#to_xml ⇒ String
Serializes the workbook document
124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
# File 'lib/axlsx/workbook/workbook.rb', line 124 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 |