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:



103
104
105
106
107
108
109
110
111
 
# File 'lib/axlsx/workbook/workbook.rb', line 103

def initialize(options={})
  @styles = Styles.new
  @worksheets = SimpleTypedList.new Worksheet
  @drawings = SimpleTypedList.new Drawing
  @charts = SimpleTypedList.new Chart
  @images = SimpleTypedList.new Pic
  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:



61
62
63
 
# File 'lib/axlsx/workbook/workbook.rb', line 61

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:



75
76
77
 
# File 'lib/axlsx/workbook/workbook.rb', line 75

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:



68
69
70
 
# File 'lib/axlsx/workbook/workbook.rb', line 68

def images
  @images
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) 


40
41
42
 
# File 'lib/axlsx/workbook/workbook.rb', line 40

def use_shared_strings
  @use_shared_strings
end

#worksheets ⇒ SimpleTypedList (readonly)

Note:

The recommended way to manage worksheets is add_worksheet

A collection of worksheets associated with this workbook.

Returns:

  • (SimpleTypedList)

See Also:



54
55
56
 
# File 'lib/axlsx/workbook/workbook.rb', line 54

def worksheets
  @worksheets
end

Class Method Details

.date1904 ⇒ Boolean

retrieves the date1904 attribute

Returns:

  • (Boolean) 


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

def self.date1904() @@date1904; end

.date1904=(v) ⇒ Boolean

Sets the date1904 attribute to the provided boolean

Returns:

  • (Boolean) 


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

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) 


163
164
165
166
167
168
 
# File 'lib/axlsx/workbook/workbook.rb', line 163

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:



133
134
135
136
137
 
# File 'lib/axlsx/workbook/workbook.rb', line 133

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

#date1904 ⇒ Boolean

Instance level access to the class variable 1904

Returns:

  • (Boolean) 


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

def date1904() @@date1904; end

#date1904=(v) ⇒ Object

see @date1904



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

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

#relationships ⇒ Relationships

The workbook relationships. This is managed automatically by the workbook

Returns:



141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/axlsx/workbook/workbook.rb', line 141

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) 


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

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


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

def styles
  yield @styles if block_given?
  @styles
end

#to_xml ⇒ String

Serializes the workbook document

Returns:

  • (String) 


172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/axlsx/workbook/workbook.rb', line 172

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" />
      # Required to support rubyXL parsing as it requires sheetView, which requires this.
      # and removed because it seems to cause some odd [Grouped] behaviour in excel.
      # xml.bookViews {
      #    xml.workbookView :activeTab=>0
      # }
      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(:save_with => 0)
end