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:



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/axlsx/workbook/workbook.rb', line 136

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:



73
74
75
 
# File 'lib/axlsx/workbook/workbook.rb', line 73

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:



87
88
89
 
# File 'lib/axlsx/workbook/workbook.rb', line 87

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:



80
81
82
 
# File 'lib/axlsx/workbook/workbook.rb', line 80

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:



97
98
99
 
# File 'lib/axlsx/workbook/workbook.rb', line 97

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) 


52
53
54
 
# File 'lib/axlsx/workbook/workbook.rb', line 52

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:



66
67
68
 
# File 'lib/axlsx/workbook/workbook.rb', line 66

def worksheets
  @worksheets
end

Class Method Details

.date1904 ⇒ Boolean

retrieves the date1904 attribute

Returns:

  • (Boolean) 


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

def self.date1904() @@date1904; end

.date1904=(v) ⇒ Boolean

Sets the date1904 attribute to the provided boolean

Returns:

  • (Boolean) 


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

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) 


212
213
214
215
216
217
 
# File 'lib/axlsx/workbook/workbook.rb', line 212

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:



182
183
184
185
186
 
# File 'lib/axlsx/workbook/workbook.rb', line 182

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:



105
106
107
 
# File 'lib/axlsx/workbook/workbook.rb', line 105

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

#date1904 ⇒ Boolean

Instance level access to the class variable 1904

Returns:

  • (Boolean) 


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

def date1904() @@date1904; end

#date1904=(v) ⇒ Object

see @date1904



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

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

#relationships ⇒ Relationships

The workbook relationships. This is managed automatically by the workbook

Returns:



190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/axlsx/workbook/workbook.rb', line 190

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) 


204
205
206
 
# File 'lib/axlsx/workbook/workbook.rb', line 204

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


114
115
116
117
 
# File 'lib/axlsx/workbook/workbook.rb', line 114

def styles
  yield @styles if block_given?
  @styles
end

#to_xml_string(str = '') ⇒ String

Serialize the workbook

Parameters:

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

Returns:

  • (String) 


222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/axlsx/workbook/workbook.rb', line 222

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

Indicates if the workbook should use autowidths or not. this must be set before instantiating a worksheet to avoid Rmagix inclusion

Returns:

  • (Boolean) 


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

def use_autowidth() @use_autowidth; end

#use_autowidth=(v) ⇒ Object

see @use_autowidth



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

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