Class: RubyXL::Worksheet

Inherits:
OOXMLTopLevelObject show all
Includes:
LegacyWorksheet, RelationshipSupport
Defined in:
lib/rubyXL/objects/worksheet.rb

Overview

www.schemacentral.com/sc/ooxml/e-ssml_worksheet.html

Constant Summary collapse

CONTENT_TYPE = 
'application/vnd.openxmlformats-officedocument.spreadsheetml.worksheet+xml'
REL_TYPE = 
'http://schemas.openxmlformats.org/officeDocument/2006/relationships/worksheet'

Instance Attribute Summary collapse

Attributes included from RelationshipSupport

#generic_storage, #relationship_container

Class Method Summary collapse

Instance Method Summary collapse

Methods included from LegacyWorksheet

#[], #add_cell, #add_row, #change_column_bold, #change_column_border_bottom, #change_column_border_diagonal, #change_column_border_left, #change_column_border_right, #change_column_border_top, #change_column_fill, #change_column_font_color, #change_column_font_name, #change_column_font_size, #change_column_horizontal_alignment, #change_column_italics, #change_column_strikethrough, #change_column_underline, #change_column_vertical_alignment, #change_column_width, #change_column_width_raw, #change_row_bold, #change_row_border_bottom, #change_row_border_diagonal, #change_row_border_left, #change_row_border_right, #change_row_border_top, #change_row_fill, #change_row_font_color, #change_row_font_name, #change_row_font_size, #change_row_height, #change_row_horizontal_alignment, #change_row_italics, #change_row_strikethrough, #change_row_underline, #change_row_vertical_alignment, #delete_cell, #delete_column, #delete_row, #each, #extract_data, #get_column_border_bottom, #get_column_border_diagonal, #get_column_border_left, #get_column_border_right, #get_column_border_top, #get_column_fill, #get_column_font_color, #get_column_font_name, #get_column_font_size, #get_column_horizontal_alignment, #get_column_vertical_alignment, #get_column_width, #get_column_width_raw, #get_row_border_bottom, #get_row_border_diagonal, #get_row_border_left, #get_row_border_right, #get_row_border_top, #get_row_fill, #get_row_font_color, #get_row_font_name, #get_row_font_size, #get_row_height, #get_row_horizontal_alignment, #get_row_vertical_alignment, #get_table, #initialize, #insert_cell, #insert_column, #insert_row, #is_column_bolded, #is_column_italicized, #is_column_struckthrough, #is_column_underlined, #is_row_bolded, #is_row_italicized, #is_row_struckthrough, #is_row_underlined, #merge_cells

Methods included from RelationshipSupport

#collect_related_objects, #load_relationships, #store_relationship

Methods inherited from OOXMLTopLevelObject

#add_to_zip, #file_index, parse_file, save_order, set_namespaces

Methods included from OOXMLObjectClassMethods

#define_attribute, #define_child_node, #define_element_name, #obtain_class_variable, #parse, #set_countable

Methods included from OOXMLObjectInstanceMethods

#dup, #index_in_collection, #initialize, #write_xml

Instance Attribute Details

#comments ⇒ Object

Returns the value of attribute comments.



655
656
657
 
# File 'lib/rubyXL/objects/worksheet.rb', line 655

def comments
  @comments
end

#printer_settings ⇒ Object

Returns the value of attribute printer_settings.



655
656
657
 
# File 'lib/rubyXL/objects/worksheet.rb', line 655

def printer_settings
  @printer_settings
end

#rels ⇒ Object

Returns the value of attribute rels.



655
656
657
 
# File 'lib/rubyXL/objects/worksheet.rb', line 655

def rels
  @rels
end

#sheet_id ⇒ Object

Returns the value of attribute sheet_id.



655
656
657
 
# File 'lib/rubyXL/objects/worksheet.rb', line 655

def sheet_id
  @sheet_id
end

#sheet_name ⇒ Object

Returns the value of attribute sheet_name.



655
656
657
 
# File 'lib/rubyXL/objects/worksheet.rb', line 655

def sheet_name
  @sheet_name
end

#state ⇒ Object

Returns the value of attribute state.



655
656
657
 
# File 'lib/rubyXL/objects/worksheet.rb', line 655

def state
  @state
end

#workbook ⇒ Object

Returns the value of attribute workbook.



655
656
657
 
# File 'lib/rubyXL/objects/worksheet.rb', line 655

def workbook
  @workbook
end

Class Method Details

.parse(param) ⇒ Object 



733
734
735
736
737
738
739
740
741
 
# File 'lib/rubyXL/objects/worksheet.rb', line 733

def self.parse(param)
  sheet_obj = super
  sheet_obj.sheet_data.rows.each { |r|
    next if r.nil?
    r.worksheet = sheet_obj
    r.cells.each { |c| c.worksheet = sheet_obj unless c.nil? }
  }
  sheet_obj
end

Instance Method Details

#attach_relationship(rid, rf) ⇒ Object 



715
716
717
718
719
720
721
722
723
724
725
726
727
728
 
# File 'lib/rubyXL/objects/worksheet.rb', line 715

def attach_relationship(rid, rf)
  case rf
  when RubyXL::PrinterSettingsFile   then printer_settings << rf
  when RubyXL::CommentsFile          then comments << rf
  when RubyXL::VMLDrawingFile        then store_relationship(rf) # TODO
  when RubyXL::DrawingFile           then store_relationship(rf) # TODO
  when RubyXL::BinaryImageFile       then store_relationship(rf) # TODO
  when RubyXL::PivotTableFile        then store_relationship(rf) # TODO
  when RubyXL::TableFile             then store_relationship(rf) # TODO
  when RubyXL::ControlPropertiesFile then store_relationship(rf) # TODO
  when RubyXL::SlicerFile            then store_relationship(rf) # TODO
  else store_relationship(rf, :unknown)
  end
end

#before_write_xml ⇒ Object

This method may need to be moved higher in the hierarchy



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
 
# File 'lib/rubyXL/objects/worksheet.rb', line 660

def before_write_xml # This method may need to be moved higher in the hierarchy
  first_nonempty_row = nil
  last_nonempty_row = 0
  first_nonempty_column = nil
  last_nonempty_column = 0

  if sheet_data then
    sheet_data.rows.each_with_index { |row, row_index|
      next if row.nil? || row.cells.empty?

      first_nonempty_cell = nil
      last_nonempty_cell = 0

      row.cells.each_with_index { |cell, col_index|
        next if cell.nil?
        cell.r = RubyXL::Reference.new(row_index, col_index)

        first_nonempty_cell ||= col_index
        last_nonempty_cell = col_index
      }

      if first_nonempty_cell then # If there's nothing in this row, then +first_nonempty_cell+ will be +nil+.
        last_nonempty_row = row_index
        first_nonempty_row ||= row_index

        first_nonempty_column ||= first_nonempty_cell
        last_nonempty_column = last_nonempty_cell if last_nonempty_cell > last_nonempty_column
      end

      row.r = row_index + 1
      row.spans = "#{first_nonempty_cell + 1}:#{last_nonempty_cell + 1}" unless first_nonempty_cell.nil?
      row.custom_format = (row.style_index.to_i != 0)
    }

    if first_nonempty_row then
      self.dimension ||= RubyXL::WorksheetDimensions.new
      self.dimension.ref = RubyXL::Reference.new(first_nonempty_row, last_nonempty_row,
                                                 first_nonempty_column, last_nonempty_column)
    end

  end

  true
end

#related_objects ⇒ Object 



707
708
709
 
# File 'lib/rubyXL/objects/worksheet.rb', line 707

def related_objects
  comments + printer_settings
end

#relationship_file_class ⇒ Object 



711
712
713
 
# File 'lib/rubyXL/objects/worksheet.rb', line 711

def relationship_file_class
  RubyXL::SheetRelationshipsFile
end

#xlsx_path ⇒ Object 



730
731
732
 
# File 'lib/rubyXL/objects/worksheet.rb', line 730

def xlsx_path
  File.join('xl', 'worksheets', "sheet#{file_index}.xml")
end