Class: Axlsx::Cell

Inherits:

Object

• Object
• Axlsx::Cell

show all

Defined in:

lib/axlsx/workbook/worksheet/cell.rb

Overview

Constant Summary

INLINE_STYLES =

An array of available inline styes. TODO change this to a hash where each key defines attr name and validator (and any info the validator requires) then move it out to a module so we can re-use in in other classes. needs to define bla=(v) and bla methods on the class that hook into a set_attr method that kicks the suplied validator and updates the instance_variable for the key

['value', 'type', 'font_name', 'charset',
'family', 'b', 'i', 'strike','outline',
'shadow', 'condense', 'extend', 'u',
'vertAlign', 'sz', 'color', 'scheme']

Instance Attribute Summary (collapse)

• - (Boolean) b

  The inline bold property for the cell.

• - (String) charset

  The inline charset property for the cell.

• - (Color) color

  The inline color property for the cell.

• - (Boolean) condense

  The inline condense property for the cell.

• - (Boolean) extend

  The inline extend property for the cell.

• - (String) family

  The inline family property for the cell.

• - (String) font_name

  The inline font_name property for the cell.

• - (Boolean) i

  The inline italic property for the cell.

• - (Boolean) outline

  The inline outline property for the cell.

• - (Row) row readonly

  The row this cell belongs to.

• - (Symbol) scheme

  The inline scheme property for the cell this must be one of [:none, major, minor].

• - (Boolean) shadow

  The inline shadow property for the cell.

• - (Integer) ssti readonly

  The Shared Strings Table index for this cell.

• - (Boolean) strike

  The inline strike property for the cell.

• - (Integer) style

  The index of the cellXfs item to be applied to this cell.

• - (Boolean) sz

  The inline sz property for the cell.

• - (Symbol) type

  The cell's data type.

• - (Boolean) u

  The inline underline property for the cell.

• - (String, ...) value

  The value of this cell.

• - (Symbol) vertAlign

  The inline vertical alignment property for the cell this must be one of [:baseline, :subscript, :superscript].

Instance Method Summary (collapse)

• - (Integer) index

  The index of the cell in the containing row.

• - (Cell) initialize(row, value = "", options = {}) constructor

  A new instance of Cell.

• - (Boolean) is_text_run?

  Indicates that the cell has one or more of the custom cell styles applied.

• - (Object) merge(target)

  Merges all the cells in a range created between this cell and the cell or string name for a cell provided.

• - (Boolean) plain_string?

  Indicates if the cell is good for shared string table.

• - (Array) pos

  Of x/y coordinates in the cheet for this cell.

• - (String) r

  The alpha(column)numeric(row) reference for this sell.

• - (String) r_abs

  The absolute alpha(column)numeric(row) reference for this sell.

• - (String) run_xml_string(str = '')

  builds an xml text run based on this cells attributes.

• - (String) to_xml_string(r_index, c_index, str = '')

  Serializes the cell.

196
197
198
199
200
201
202
203
204
205
206
207
208

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 196

def initialize(row, value="", options={})
  self.row=row
  @font_name = @charset = @family = @b = @i = @strike = @outline = @shadow = nil
  @condense = @u = @vertAlign = @sz = @color = @scheme = @extend = @ssti = nil
  @styles = row.worksheet.workbook.styles
  @row.cells << self
  options.each do |o|
    self.send("#{o[0]}=", o[1]) if self.respond_to? "#{o[0]}="
  end
  @style ||= 0
  @type ||= cell_type_from_value(value)
  @value = cast_value(value)
end

96
97
98

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

def b
  @b
end

84
85
86

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 84

def charset
  @charset
end

144
145
146

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 144

def color
  @color
end

126
127
128

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 126

def condense
  @condense
end

132
133
134

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 132

def extend
  @extend
end

90
91
92

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 90

def family
  @family
end

78
79
80

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 78

def font_name
  @font_name
end

102
103
104

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 102

def i
  @i
end

114
115
116

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

def outline
  @outline
end

30
31
32

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 30

def row
  @row
end

170
171
172

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 170

def scheme
  @scheme
end

120
121
122

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 120

def shadow
  @shadow
end

212
213
214

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 212

def ssti
  @ssti
end

108
109
110

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

def strike
  @strike
end

26
27
28

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 26

def style
  @style
end

153
154
155

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 153

def sz
  @sz
end

:string to :integer or :float, type conversions always return 0 or 0.0
:string, :integer, or :float to :time conversions always return the original value as a string and set the cells type to :string.

43
44
45

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 43

def type
  @type
end

138
139
140

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 138

def u
  @u
end

54
55
56

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 54

def value
  @value
end

160
161
162

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 160

def vertAlign
  @vertAlign
end

215
216
217

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 215

def index
  @row.cells.index(self)
end

63
64
65

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 63

def is_text_run?
  @is_text_run ||= false
end

250
251
252
253
254
255
256
257

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 250

def merge(target)
  range_end = if target.is_a?(String)
                target
              elsif(target.is_a?(Cell))
                target.r
              end
  self.row.worksheet.merge_cells "#{self.r}:#{range_end}" unless range_end.nil?
end

68
69
70
71
72
73
74

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 68

def plain_string?
  @type == :string &&         # String typed
    !is_text_run? &&          # No inline styles
    !@value.nil? &&           # Not nil
    !@value.empty? &&         # Not empty
    !@value.start_with?('=')  # Not a formula
end

243
244
245

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 243

def pos
  [index, row.index]
end

ws.rows.first.cells.first.r #=> "A1"

222
223
224

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 222

def r
  Axlsx::cell_r index, @row.index
end

ws.rows.first.cells.first.r #=> "$A$1"

229
230
231

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 229

def r_abs
  "$#{r.match(%r{([A-Z]+)([0-9]+)})[1,2].join('$')}"
end

262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 262

def run_xml_string(str = '')
  if is_text_run?
    data = self.instance_values.reject{|key, value| value == nil }
    keys = data.keys & INLINE_STYLES
    keys.delete ['value', 'type']
    str << "<r><rPr>"
    keys.each do |key|
      case key
      when 'font_name'
        str << "<rFont val='"<< @font_name << "'/>"
      when 'color'
        str << data[key].to_xml_string
      else
        "<" << key.to_s << " val='" << data[key].to_s << "'/>"
      end
    end
    str << "</rPr>" << "<t>" << value.to_s << "</t></r>"
  else
    str << "<t>" << value.to_s << "</t>"
  end
  str
end

290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319

# File 'lib/axlsx/workbook/worksheet/cell.rb', line 290

def to_xml_string(r_index, c_index, str = '')
  str << '<c r="' << Axlsx::cell_r(c_index, r_index) << '" s="' << @style.to_s << '" '
  return str << '/>' if @value.nil?

  case @type

  when :string
    #parse formula
    if @value.start_with?('=')
      str  << 't="str"><f>' << @value.to_s.sub('=', '') << '</f>'
    else
      #parse shared
      if @ssti
        str << 't="s"><v>' << @ssti.to_s << '</v>'
      else
        str << 't="inlineStr"><is>' << run_xml_string << '</is>'
      end
    end
  when :date
    # TODO: See if this is subject to the same restriction as Time below
    str << '><v>' << DateTimeConverter::date_to_serial(@value).to_s << '</v>'
  when :time
    str << '><v>' << DateTimeConverter::time_to_serial(@value).to_s << '</v>'
  when :boolean
    str << 't="b"><v>' << @value.to_s << '</v>'
  else
    str << '><v>' << @value.to_s << '</v>'
  end
  str << '</c>'
end