class RubyXL::Workbook
Constants
- APPLICATION
- APPVERSION
- CONTENT_TYPE
- CONTENT_TYPE_TEMPLATE
- CONTENT_TYPE_TEMPLATE_WITH_MACROS
- CONTENT_TYPE_WITH_MACROS
- DATE1899
Subtracting one day to accomodate for erroneous 1900 leap year compatibility only for 1900 based dates
- DATE1904
- MARCH_1_1900
- REL_TYPE
- SHEET_NAME_FORBIDDEN_CHARS
www.accountingweb.com/technology/excel/seven-characters-you-cant-use-in-worksheet-names
- SHEET_NAME_TEMPLATE
Attributes
is_template[RW]
worksheets[RW]
Public Class Methods
new(worksheets = [], src_file_path = nil, creator = nil, modifier = nil, created_at = nil, company = '', application = APPLICATION, appversion = APPVERSION, date1904 = 0, is_template = false)
click to toggle source
Calls superclass method
RubyXL::OOXMLObjectInstanceMethods::new
# File lib/rubyXL/objects/workbook.rb, line 446 def initialize(worksheets = [], src_file_path = nil, creator = nil, modifier = nil, created_at = nil, company = '', application = APPLICATION, appversion = APPVERSION, date1904 = 0, is_template = false) super() # Order of sheets in the +worksheets+ array corresponds to the order of pages in Excel UI. # SheetId's, rId's, etc. are completely unrelated to ordering. @worksheets = worksheets add_worksheet if @worksheets.empty? @theme = RubyXL::Theme.default @shared_strings_container = RubyXL::SharedStringsTable.new @stylesheet = RubyXL::Stylesheet.default @relationship_container = RubyXL::OOXMLRelationshipsFile.new @root = RubyXL::WorkbookRoot.default @root.workbook = self @root.source_file_path = src_file_path creation_time = DateTime.parse(created_at) rescue DateTime.now self.created_at = creation_time self.modified_at = creation_time self.company = company self.application = application self.appversion = appversion self.creator = creator self.modifier = modifier self.date1904 = date1904 > 0 self.is_template = is_template end
Public Instance Methods
[](ind)
click to toggle source
Finds worksheet by its name or numerical index
# File lib/rubyXL/objects/workbook.rb, line 479 def [](ind) case ind when Integer then worksheets[ind] when String then worksheets.find { |ws| ws.sheet_name == ind } end end
add_worksheet(name = nil)
click to toggle source
Create new simple worksheet and add it to the workbook worksheets
@param [String] The name for the new worksheet
# File lib/rubyXL/objects/workbook.rb, line 489 def add_worksheet(name = nil) if name.nil? then n = 0 begin name = SHEET_NAME_TEMPLATE % (n += 1) end until self[name].nil? end new_worksheet = Worksheet.new(:workbook => self, :sheet_name => name) worksheets << new_worksheet new_worksheet end
application()
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 528 def application root.document_properties.application && root.document_properties.application.value end
application=(v)
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 532 def application=(v) root.document_properties.application ||= StringNode.new root.document_properties.application.value = v end
appversion()
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 537 def appversion root.document_properties.app_version && root.document_properties.app_version.value end
appversion=(v)
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 541 def appversion=(v) root.document_properties.app_version ||= StringNode.new root.document_properties.app_version.value = v end
before_write_xml()
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 369 def before_write_xml max_sheet_id = worksheets.collect(&:sheet_id).compact.max || 0 self.sheets = RubyXL::Sheets.new worksheets.each { |sheet, i| rel = relationship_container.find_by_target(sheet.xlsx_path) raise "Worksheet name '#{sheet.sheet_name}' contains forbidden characters" if sheet.sheet_name =~ SHEET_NAME_FORBIDDEN_CHARS sheets << RubyXL::Sheet.new(:name => sheet.sheet_name[0..30], # Max sheet name length is 31 char :sheet_id => sheet.sheet_id || (max_sheet_id += 1), :state => sheet.state, :r_id => rel.id) } true end
company()
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 519 def company root.document_properties.company && root.document_properties.company.value end
company=(v)
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 523 def company=(v) root.document_properties.company ||= StringNode.new root.document_properties.company.value = v end
content_type()
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 313 def content_type content_type_name = 'CONTENT_TYPE' content_type_name << '_TEMPLATE' if is_template content_type_name << '_WITH_MACROS' if macros self.class.const_get(content_type_name) end
created_at()
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 503 def created_at root.core_properties.created_at end
created_at=(v)
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 507 def created_at=(v) root.core_properties.created_at = v end
creator()
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 546 def creator root.core_properties.creator end
creator=(v)
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 550 def creator=(v) root.core_properties.creator = v end
date1904()
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 562 def date1904 workbook_properties && workbook_properties.date1904 end
date1904=(v)
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 566 def date1904=(v) self.workbook_properties ||= RubyXL::WorkbookProperties.new workbook_properties.date1904 = v end
date_to_num(date)
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 422 def date_to_num(date) case date when Date, DateTime then (date.ajd - base_date().ajd).to_f when Time then ((date.to_r - base_date().to_time.to_r) / 86400).to_f end end
modified_at()
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 511 def modified_at root.core_properties.modified_at end
modified_at=(v)
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 515 def modified_at=(v) root.core_properties.modified_at = v end
modifier()
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 554 def modifier root.core_properties.modifier end
modifier=(v)
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 558 def modifier=(v) root.core_properties.modifier = v end
num_to_date(num)
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 429 def num_to_date(num) return nil if num.nil? # Bug-for-bug Excel compatibility (https://support.microsoft.com/kb/214058/) if num < MARCH_1_1900 then num += 1 unless workbook_properties && workbook_properties.date1904 end dateparts = num.divmod(1) base_date + (dateparts[0] + (dateparts[1] * 86400).round(6) / 86400) end
save(dst_file_path = nil)
click to toggle source
Save the resulting XLSX file to the specified location
# File lib/rubyXL/objects/workbook.rb, line 398 def save(dst_file_path = nil) dst_file_path ||= root.source_file_path extension = File.extname(dst_file_path) unless %w{.xlsx .xlsm .xltx .xltm}.include?(extension.downcase) raise "Unsupported extension: #{extension} (only .xlsx, .xlsm, .xltx and .xltm files are supported)." end File.open(dst_file_path, "wb") { |output_file| FileUtils.copy_stream(root.stream, output_file) } return dst_file_path end
Also aliased as: write
stream()
click to toggle source
Return the resulting XLSX file in a stream (useful for sending over HTTP)
# File lib/rubyXL/objects/workbook.rb, line 393 def stream root.stream end
xlsx_path()
click to toggle source
# File lib/rubyXL/objects/workbook.rb, line 388 def xlsx_path ROOT.join('xl', 'workbook.xml') end