Class: Axlsx::Workbook

Inherits:

Object

• Object
• Axlsx::Workbook

show all

Defined in:

lib/axlsx/workbook/workbook.rb

Overview

  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

@@date1904 =

Indicates if the epoc date for serialization should be 1904. If false, 1900 is used.

false

Instance Attribute Summary (collapse)

• - (SimpleTypedList) charts readonly

  A colllection of charts associated with this workbook.

• - (SimpleTypedList) drawings readonly

  A colllection of drawings associated with this workbook.

• - (SimpleTypedList) images readonly

  A colllection of images associated with this workbook.

• - (SimpleTypedList) worksheets readonly

  A collection of worksheets associated with this workbook.

Class Method Summary (collapse)

• + (Boolean) date1904

  retrieves the date1904 attribute.

• + (Boolean) date1904=(v)

  Sets the date1904 attribute to the provided boolean.

Instance Method Summary (collapse)

• - (Worksheet) add_worksheet(options = {}) {|worksheet| ... }

  Adds a worksheet to this workbook.

• - (Boolean) date1904

  Instance level access to the class variable 1904.

• - (Object) date1904=(v)

  see @date1904.

• - (Workbook) initialize(options = {}) {|_self| ... } constructor

  Creates a new Workbook.

• - (Relationships) relationships

  The workbook relationships.

• - (Styles) styles {|@styles| ... }

  The styles associated with this workbook.

• - (String) to_xml

  Serializes the workbook document.

77
78
79
80
81
82
83
84
85

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

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] unless options[:date1904].nil?
  yield self if block_given?      
end

45
46
47

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

def charts
  @charts
end

59
60
61

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

def drawings
  @drawings
end

52
53
54

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

def images
  @images
end

38
39
40

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

def worksheets
  @worksheets
end

100

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

def self.date1904() @@date1904; end

96

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

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

106
107
108
109
110

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

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

89

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

def date1904() @@date1904; end

92

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

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

114
115
116
117
118
119
120
121

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

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

66
67
68
69

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

def styles
  yield @styles if block_given?
  @styles
end

125
126
127
128
129
130
131
132
133
134
135
136
137
138

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

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