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 collapse

@@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

#initialize(options = {}) {|_self| ... } ⇒ Workbook

Creates a new Workbook The recomended way to work with workbooks is via Package#workbook

Parameters:

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

    a customizable set of options

Options Hash (options):

  • date1904. (Boolean) —

    If this is not specified, date1904 is set to false. Office 2011 for Mac defaults to false.

Yields:

  • (_self)

Yield Parameters:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/axlsx/workbook/workbook.rb', line 140

def initialize(options={})
  @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= !options[:date1904].nil? && options[:date1904]
  yield self if block_given?
end

Instance Attribute Details

#charts ⇒ SimpleTypedList (readonly)

Note:

The recommended way to manage charts is Worksheet#add_chart

A colllection of charts associated with this workbook

Returns:

  • (SimpleTypedList)

See Also:



77
78
79
 
# File 'lib/axlsx/workbook/workbook.rb', line 77

def charts
  @charts
end

#drawings ⇒ SimpleTypedList (readonly)

Note:

The recommended way to manage drawings is Worksheet#add_chart

A colllection of drawings associated with this workbook

Returns:

  • (SimpleTypedList)

See Also:



91
92
93
 
# File 'lib/axlsx/workbook/workbook.rb', line 91

def drawings
  @drawings
end

#images ⇒ SimpleTypedList (readonly)

Note:

The recommended way to manage images is Worksheet#add_image

A colllection of images associated with this workbook

Returns:

  • (SimpleTypedList)

See Also:



84
85
86
 
# File 'lib/axlsx/workbook/workbook.rb', line 84

def images
  @images
end

#tables ⇒ SimpleTypedList (readonly)

Note:

The recommended way to manage drawings is Worksheet#add_table

A colllection of tables associated with this workbook

Returns:

  • (SimpleTypedList)

See Also:



101
102
103
 
# File 'lib/axlsx/workbook/workbook.rb', line 101

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.

Returns:

  • (Boolean) 


56
57
58
 
# File 'lib/axlsx/workbook/workbook.rb', line 56

def use_shared_strings
  @use_shared_strings
end

#worksheets ⇒ SimpleTypedList (readonly)

Note:

The recommended way to manage worksheets is add_worksheet

Returns:

  • (SimpleTypedList)

See Also:



70
71
72
 
# File 'lib/axlsx/workbook/workbook.rb', line 70

def worksheets
  @worksheets
end

Class Method Details

.date1904 ⇒ Boolean

retrieves the date1904 attribute

Returns:

  • (Boolean) 


171
 
# File 'lib/axlsx/workbook/workbook.rb', line 171

def self.date1904() @@date1904; end

.date1904=(v) ⇒ Boolean

Sets the date1904 attribute to the provided boolean

Returns:

  • (Boolean) 


167
 
# File 'lib/axlsx/workbook/workbook.rb', line 167

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.

Parameters:

  • cell_def (String) —

    The excel style reference defining the worksheet and cells. The range must specify the sheet to

Returns:

Raises:

  • (ArgumentError) 


218
219
220
221
222
223
 
# File 'lib/axlsx/workbook/workbook.rb', line 218

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_worksheet(options = {}) {|worksheet| ... } ⇒ 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.

  • page_margins (Hash) —

    The page margins for the worksheet.

Yields:

  • (worksheet)

Returns:

See Also:



188
189
190
191
192
 
# File 'lib/axlsx/workbook/workbook.rb', line 188

def add_worksheet(options={})
  worksheet = Worksheet.new(self, options)
  yield worksheet if block_given?
  worksheet
end

#comments ⇒ Comments

Note:

The recommended way to manage comments is Worksheet#add_comment

A colllection of comments associated with this workbook

Returns:

See Also:



109
110
111
 
# File 'lib/axlsx/workbook/workbook.rb', line 109

def comments
  self.worksheets.map { |ws| ws.comments }.compact
end

#date1904 ⇒ Boolean

Instance level access to the class variable 1904

Returns:

  • (Boolean) 


160
 
# File 'lib/axlsx/workbook/workbook.rb', line 160

def date1904() @@date1904; end

#date1904=(v) ⇒ Object

see @date1904



163
 
# File 'lib/axlsx/workbook/workbook.rb', line 163

def date1904=(v) Axlsx::validate_boolean v; @@date1904 = v; end

#relationships ⇒ Relationships

The workbook relationships. This is managed automatically by the workbook

Returns:



196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/axlsx/workbook/workbook.rb', line 196

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.

Returns:

  • (SharedStringTable) 


210
211
212
 
# File 'lib/axlsx/workbook/workbook.rb', line 210

def shared_strings
  SharedStringsTable.new(worksheets.collect { |ws| ws.cells })
end

#styles {|@styles| ... } ⇒ Styles

Note:

The recommended way to manage styles is Styles#add_style

The styles associated with this workbook

Yields:

Returns:

See Also:

  • Style#add_style
  • Style


118
119
120
121
 
# File 'lib/axlsx/workbook/workbook.rb', line 118

def styles
  yield @styles if block_given?
  @styles
end

#to_xml_string(str = '') ⇒ String

Serialize the workbook

Parameters:

  • str (String) (defaults to: '')

Returns:

  • (String) 


228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/axlsx/workbook/workbook.rb', line 228

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 << '"/>'
  end
  str << '</sheets>'
  str << '<definedNames>'
  @worksheets.each_with_index do |sheet, index|
    if sheet.auto_filter
      str << '<definedName name="_xlnm._FilterDatabase" localSheetId="' << index.to_s << '" hidden="1">'
      str << sheet.abs_auto_filter << '</definedName>'
    end
  end
  str << '</definedNames>'
  str << '</workbook>'
end

#use_autowidth ⇒ Boolean

Note:

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.

Returns:

  • (Boolean) 


178
 
# File 'lib/axlsx/workbook/workbook.rb', line 178

def use_autowidth() @use_autowidth; end

#use_autowidth=(v = true) ⇒ Object

see @use_autowidth



181
 
# File 'lib/axlsx/workbook/workbook.rb', line 181

def use_autowidth=(v=true) Axlsx::validate_boolean v; @use_autowidth = v; end