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

Parameters:

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

    a customizable set of options

Options Hash (options):

  • date1904. (Boolean) —

    If this is not specified, we try to determine if the platform is bsd/darwin and set date1904 to true automatically.

Yields:

  • (_self)

Yield Parameters:



88
89
90
91
92
93
94
95
96
 
# File 'lib/axlsx/workbook/workbook.rb', line 88

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? ? is_bsd? : 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:



45
46
47
 
# File 'lib/axlsx/workbook/workbook.rb', line 45

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:



59
60
61
 
# File 'lib/axlsx/workbook/workbook.rb', line 59

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:



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

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



38
39
40
 
# File 'lib/axlsx/workbook/workbook.rb', line 38

def worksheets
  @worksheets
end

Class Method Details

.date1904 ⇒ Boolean

retrieves the date1904 attribute

Returns:

  • (Boolean) 


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

def self.date1904() @@date1904; end

.date1904=(v) ⇒ Boolean

Sets the date1904 attribute to the provided boolean

Returns:

  • (Boolean) 


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

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) 


146
147
148
149
150
151
 
# File 'lib/axlsx/workbook/workbook.rb', line 146

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.

Yields:

  • (worksheet)

Returns:

See Also:



125
126
127
128
129
 
# File 'lib/axlsx/workbook/workbook.rb', line 125

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) 


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

def date1904() @@date1904; end

#date1904=(v) ⇒ Object

see @date1904



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

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

#is_bsd? ⇒ Boolean

Uses RUBY_PLATFORM constant to determine if the OS is freebsd or darwin based on this value we attempt to set date1904.

Returns:

  • (Boolean) 


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

def is_bsd?
  platform = RUBY_PLATFORM.downcase
  platform.include?('freebsd') || platform.include?('darwin')
end

#relationships ⇒ Relationships

The workbook relationships. This is managed automatically by the workbook

Returns:



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

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

#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


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

def styles
  yield @styles if block_given?
  @styles
end

#to_xml ⇒ String

Serializes the workbook document

Returns:

  • (String) 


155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/axlsx/workbook/workbook.rb', line 155

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(:save_with => 0)
end