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.
-
#drawings ⇒ SimpleTypedList
readonly
A colllection of drawings associated with this workbook.
-
#images ⇒ SimpleTypedList
readonly
A colllection of images 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
-
#[](cell_def) ⇒ Cell, Array
returns a range of cells in a worksheet retrieve the cells from.
-
#add_worksheet(options = {}) {|worksheet| ... } ⇒ Worksheet
Adds a worksheet to this workbook.
-
#date1904 ⇒ Boolean
Instance level access to the class variable 1904.
-
#date1904=(v) ⇒ Object
see @date1904.
-
#initialize(options = {}) {|_self| ... } ⇒ Workbook
constructor
Creates a new Workbook.
-
#relationships ⇒ Relationships
The workbook relationships.
-
#styles {|@styles| ... } ⇒ Styles
The styles associated with this workbook.
-
#to_xml ⇒ String
Serializes the workbook document.
Constructor Details
permalink #initialize(options = {}) {|_self| ... } ⇒ Workbook
Creates a new Workbook
86 87 88 89 90 91 92 93 94 |
# File 'lib/axlsx/workbook/workbook.rb', line 86 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
permalink #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 |
permalink #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 |
permalink #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 |
permalink #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
permalink .date1904 ⇒ Boolean
retrieves the date1904 attribute
109 |
# File 'lib/axlsx/workbook/workbook.rb', line 109 def self.date1904() @@date1904; end |
permalink .date1904=(v) ⇒ Boolean
Sets the date1904 attribute to the provided boolean
105 |
# File 'lib/axlsx/workbook/workbook.rb', line 105 def self.date1904=(v) Axlsx::validate_boolean v; @@date1904 = v; end |
Instance Method Details
permalink #[](cell_def) ⇒ Cell, Array
returns a range of cells in a worksheet retrieve the cells from. e.g. range(‘Sheet1!A1:B2’) will return an array of four cells [A1, A2, B1, B2] while range(‘Sheet1!A1’) will return a single Cell.
136 137 138 139 140 141 |
# File 'lib/axlsx/workbook/workbook.rb', line 136 def [](cell_def) sheet_name = cell_def.split('!')[0] if cell_def.match('!') worksheet = self.worksheets.select { |s| s.name == sheet_name }.first raise ArgumentError, 'Unknown Sheet' unless sheet_name && worksheet.is_a?(Worksheet) worksheet[cell_def.gsub(/.+!/,"")] end |
permalink #add_worksheet(options = {}) {|worksheet| ... } ⇒ Worksheet
Adds a worksheet to this workbook
115 116 117 118 119 |
# File 'lib/axlsx/workbook/workbook.rb', line 115 def add_worksheet(={}) worksheet = Worksheet.new(self, ) yield worksheet if block_given? worksheet end |
permalink #date1904 ⇒ Boolean
Instance level access to the class variable 1904
98 |
# File 'lib/axlsx/workbook/workbook.rb', line 98 def date1904() @@date1904; end |
permalink #date1904=(v) ⇒ Object
see @date1904
101 |
# File 'lib/axlsx/workbook/workbook.rb', line 101 def date1904=(v) Axlsx::validate_boolean v; @@date1904 = v; end |
permalink #relationships ⇒ Relationships
The workbook relationships. This is managed automatically by the workbook
123 124 125 126 127 128 129 130 |
# File 'lib/axlsx/workbook/workbook.rb', line 123 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 |
permalink #styles {|@styles| ... } ⇒ Styles
The recommended way to manage styles is Styles#add_style
The styles associated with this workbook
66 67 68 69 |
# File 'lib/axlsx/workbook/workbook.rb', line 66 def styles yield @styles if block_given? @styles end |
permalink #to_xml ⇒ String
Serializes the workbook document
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
# File 'lib/axlsx/workbook/workbook.rb', line 145 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) #<x:workbookProtection workbookPassword="xsd:hexBinary data" lockStructure="1" lockWindows="1" /> 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 |