Class: RubyXL::Cell

Inherits:
OOXMLObject show all
Includes:
LegacyCell
Defined in:
lib/rubyXL/objects/sheet_data.rb

Overview

Constant Summary collapse

NUMBER_REGEXP =
/\A-?\d+((?:\.\d+)?(?:e[+-]?\d+)?)?\Z/i

Instance Attribute Summary collapse

Attributes included from OOXMLObjectInstanceMethods

#local_namespaces

Instance Method Summary collapse

Methods included from LegacyCell

#workbook

Methods included from OOXMLObjectInstanceMethods

#==, #before_write_xml, included, #initialize, #write_xml

Instance Attribute Details

#worksheetObject

Returns the value of attribute worksheet.


46
47
48
# File 'lib/rubyXL/objects/sheet_data.rb', line 46

def worksheet
  @worksheet
end

Instance Method Details

#columnObject


60
61
62
# File 'lib/rubyXL/objects/sheet_data.rb', line 60

def column
  r && r.first_col
end

#column=(v) ⇒ Object


64
65
66
# File 'lib/rubyXL/objects/sheet_data.rb', line 64

def column=(v)
  self.r = RubyXL::Reference.new(row || 0, v)
end

#get_cell_borderObject


85
86
87
# File 'lib/rubyXL/objects/sheet_data.rb', line 85

def get_cell_border
  workbook.stylesheet.borders[get_cell_xf.border_id]
end

#get_cell_fontObject


81
82
83
# File 'lib/rubyXL/objects/sheet_data.rb', line 81

def get_cell_font
  workbook.stylesheet.fonts[get_cell_xf.font_id]
end

#get_cell_xfObject


77
78
79
# File 'lib/rubyXL/objects/sheet_data.rb', line 77

def get_cell_xf
  workbook.stylesheet.cell_xfs[self.style_index || 0]
end

#index_in_collectionObject


48
49
50
# File 'lib/rubyXL/objects/sheet_data.rb', line 48

def index_in_collection
  r.col_range.begin
end

#inspectObject


126
127
128
129
130
131
# File 'lib/rubyXL/objects/sheet_data.rb', line 126

def inspect
  str = "#<#{self.class}(#{row},#{column}): #{raw_value.inspect}"
  str << " =#{self.formula.expression}" if self.formula
  str << ", datatype=#{self.datatype.inspect}, style_index=#{self.style_index.inspect}>"
  return str
end

#is_date?Boolean

Returns:

  • (Boolean)

93
94
95
96
97
98
99
100
101
102
103
# File 'lib/rubyXL/objects/sheet_data.rb', line 93

def is_date?
  return false unless # Only fully numeric values can be dates
    case raw_value
    when Numeric then true
    when String  then raw_value =~ NUMBER_REGEXP
    else false
    end

  num_fmt = self.number_format
  num_fmt && num_fmt.is_date_format?
end

#number_formatObject


89
90
91
# File 'lib/rubyXL/objects/sheet_data.rb', line 89

def number_format
  workbook.stylesheet.get_number_format_by_id(get_cell_xf.num_fmt_id)
end

#raw_valueObject


68
69
70
# File 'lib/rubyXL/objects/sheet_data.rb', line 68

def raw_value
  value_container && value_container.value
end

#raw_value=(v) ⇒ Object


72
73
74
75
# File 'lib/rubyXL/objects/sheet_data.rb', line 72

def raw_value=(v)
  self.value_container ||= RubyXL::CellValue.new
  value_container.value = v
end

#rowObject


52
53
54
# File 'lib/rubyXL/objects/sheet_data.rb', line 52

def row
  r && r.first_row
end

#row=(v) ⇒ Object


56
57
58
# File 'lib/rubyXL/objects/sheet_data.rb', line 56

def row=(v)
  self.r = RubyXL::Reference.new(v, column || 0)
end

#value(args = {}) ⇒ Object

Gets massaged value of the cell, converting datatypes to those known to Ruby (that includes stripping any special formatting from RichText).


107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
# File 'lib/rubyXL/objects/sheet_data.rb', line 107

def value(args = {})
  r = self.raw_value

  case datatype
  when RubyXL::DataType::SHARED_STRING then workbook.shared_strings_container[r.to_i].to_s
  when RubyXL::DataType::INLINE_STRING then is.to_s
  when RubyXL::DataType::RAW_STRING    then raw_value
  else
    if is then is.to_s
    elsif is_date? then workbook.num_to_date(r.to_f)
    elsif r.is_a?(String) && (r =~ NUMBER_REGEXP) then # Numeric
      if Regexp.last_match(1) != '' then r.to_f
      else r.to_i
      end
    else r
    end
  end
end