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.
-
#tables ⇒ SimpleTypedList
readonly
A colllection of tables associated with this workbook.
-
#use_shared_strings ⇒ Boolean
When true, the Package will be generated with a shared string table.
- #worksheets ⇒ SimpleTypedList readonly
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_defined_name(formula, options) ⇒ DefinedName
Adds a defined name to this workbook.
-
#add_worksheet(options = {}) {|worksheet| ... } ⇒ Worksheet
Adds a worksheet to this workbook.
-
#comments ⇒ Comments
A collection of comments associated with this workbook.
-
#date1904 ⇒ Boolean
Instance level access to the class variable 1904.
-
#date1904=(v) ⇒ Object
see @date1904.
-
#defined_names ⇒ DefinedNames
A collection of defined names for this workbook.
-
#initialize(options = {}) {|_self| ... } ⇒ Workbook
constructor
Creates a new Workbook The recomended way to work with workbooks is via Package#workbook.
-
#relationships ⇒ Relationships
The workbook relationships.
-
#shared_strings ⇒ SharedStringTable
generates a shared string object against all cells in all worksheets.
-
#styles {|@styles| ... } ⇒ Styles
The styles associated with this workbook.
-
#to_xml_string(str = '') ⇒ String
Serialize the workbook.
-
#use_autowidth ⇒ Boolean
Indicates if the workbook should use autowidths or not.
-
#use_autowidth=(v = true) ⇒ Object
see @use_autowidth.
Constructor Details
#initialize(options = {}) {|_self| ... } ⇒ Workbook
Creates a new Workbook The recomended way to work with workbooks is via Package#workbook
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 |
# File 'lib/axlsx/workbook/workbook.rb', line 167 def initialize(={}) @styles = Styles.new @worksheets = SimpleTypedList.new Worksheet @drawings = SimpleTypedList.new Drawing @charts = SimpleTypedList.new Chart @images = SimpleTypedList.new Pic # Are these even used????? Check package serialization parts @tables = SimpleTypedList.new Table @comments = SimpleTypedList.new Comments @use_autowidth = true self.date1904= ![:date1904].nil? && [:date1904] 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
96 97 98 |
# File 'lib/axlsx/workbook/workbook.rb', line 96 def charts @charts end |
#drawings ⇒ SimpleTypedList (readonly)
The recommended way to manage drawings is Worksheet#add_chart
A colllection of drawings associated with this workbook
110 111 112 |
# File 'lib/axlsx/workbook/workbook.rb', line 110 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
103 104 105 |
# File 'lib/axlsx/workbook/workbook.rb', line 103 def images @images end |
#tables ⇒ SimpleTypedList (readonly)
The recommended way to manage drawings is Worksheet#add_table
A colllection of tables associated with this workbook
120 121 122 |
# File 'lib/axlsx/workbook/workbook.rb', line 120 def tables @tables end |
#use_shared_strings ⇒ Boolean
When true, the Package will be generated with a shared string table. This may be required by some OOXML processors that do not adhere to the ECMA specification that dictates string may be inline in the sheet. Using this option will increase the time required to serialize the document as every string in every cell must be analzed and referenced.
75 76 77 |
# File 'lib/axlsx/workbook/workbook.rb', line 75 def use_shared_strings @use_shared_strings end |
#worksheets ⇒ SimpleTypedList (readonly)
The recommended way to manage worksheets is add_worksheet
89 90 91 |
# File 'lib/axlsx/workbook/workbook.rb', line 89 def worksheets @worksheets end |
Class Method Details
.date1904 ⇒ Boolean
retrieves the date1904 attribute
197 |
# File 'lib/axlsx/workbook/workbook.rb', line 197 def self.date1904() @@date1904; end |
.date1904=(v) ⇒ Boolean
Sets the date1904 attribute to the provided boolean
193 |
# File 'lib/axlsx/workbook/workbook.rb', line 193 def self.date1904=(v) Axlsx::validate_boolean v; @@date1904 = v; end |
Instance Method Details
#[](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.
252 253 254 255 256 257 |
# File 'lib/axlsx/workbook/workbook.rb', line 252 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 |
#add_defined_name(formula, options) ⇒ DefinedName
Adds a defined name to this workbook
224 225 226 |
# File 'lib/axlsx/workbook/workbook.rb', line 224 def add_defined_name(formula, ) defined_names << DefinedName.new(formula, ) end |
#add_worksheet(options = {}) {|worksheet| ... } ⇒ Worksheet
Adds a worksheet to this workbook
214 215 216 217 218 |
# File 'lib/axlsx/workbook/workbook.rb', line 214 def add_worksheet(={}) worksheet = Worksheet.new(self, ) yield worksheet if block_given? worksheet end |
#comments ⇒ Comments
The recommended way to manage comments is WOrksheet#add_comment
A collection of comments associated with this workbook
136 137 138 |
# File 'lib/axlsx/workbook/workbook.rb', line 136 def comments worksheets.map { |sheet| sheet.comments }.compact end |
#date1904 ⇒ Boolean
Instance level access to the class variable 1904
186 |
# File 'lib/axlsx/workbook/workbook.rb', line 186 def date1904() @@date1904; end |
#date1904=(v) ⇒ Object
see @date1904
189 |
# File 'lib/axlsx/workbook/workbook.rb', line 189 def date1904=(v) Axlsx::validate_boolean v; @@date1904 = v; end |
#defined_names ⇒ DefinedNames
The recommended way to manage defined names is Workbook#add_defined_name
A collection of defined names for this workbook
127 128 129 |
# File 'lib/axlsx/workbook/workbook.rb', line 127 def defined_names @defined_names ||= DefinedNames.new end |
#relationships ⇒ Relationships
The workbook relationships. This is managed automatically by the workbook
230 231 232 233 234 235 236 237 238 239 240 |
# File 'lib/axlsx/workbook/workbook.rb', line 230 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) if use_shared_strings r << Relationship.new(SHARED_STRINGS_R, SHARED_STRINGS_PN) end r end |
#shared_strings ⇒ SharedStringTable
generates a shared string object against all cells in all worksheets.
244 245 246 |
# File 'lib/axlsx/workbook/workbook.rb', line 244 def shared_strings SharedStringsTable.new(worksheets.collect { |ws| ws.cells }) end |
#styles {|@styles| ... } ⇒ Styles
The recommended way to manage styles is Styles#add_style
The styles associated with this workbook
145 146 147 148 |
# File 'lib/axlsx/workbook/workbook.rb', line 145 def styles yield @styles if block_given? @styles end |
#to_xml_string(str = '') ⇒ String
Serialize the workbook
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
# File 'lib/axlsx/workbook/workbook.rb', line 262 def to_xml_string(str='') add_worksheet unless worksheets.size > 0 str << '<?xml version="1.0" encoding="UTF-8"?>' str << '<workbook xmlns="' << XML_NS << '" xmlns:r="' << XML_NS_R << '">' str << '<workbookPr date1904="' << @@date1904.to_s << '"/>' str << '<sheets>' @worksheets.each_with_index do |sheet, index| str << '<sheet name="' << sheet.name << '" sheetId="' << (index+1).to_s << '" r:id="' << sheet.rId << '"/>' if defined_name = sheet.auto_filter.defined_name add_defined_name defined_name, :name => '_xlnm._FilterDatabase', :local_sheet_id => index, :hidden => 1 end end str << '</sheets>' defined_names.to_xml_string(str) str << '</workbook>' end |
#use_autowidth ⇒ Boolean
This gem no longer depends on RMagick for autowidth calculation. Thus the performance benefits of turning this off are marginal unless you are creating a very large sheet.
Indicates if the workbook should use autowidths or not.
204 |
# File 'lib/axlsx/workbook/workbook.rb', line 204 def use_autowidth() @use_autowidth; end |
#use_autowidth=(v = true) ⇒ Object
see @use_autowidth
207 |
# File 'lib/axlsx/workbook/workbook.rb', line 207 def use_autowidth=(v=true) Axlsx::validate_boolean v; @use_autowidth = v; end |