Class: Axlsx::Cell
- Inherits:
-
Object
- Object
- Axlsx::Cell
- Includes:
- OptionsParser
- Defined in:
- lib/axlsx/workbook/worksheet/cell.rb
Overview
The recommended way to generate cells is via Worksheet#add_row
A cell in a worksheet. Cell stores inforamation requried to serialize a single worksheet cell to xml. You must provde the Row that the cell belongs to and the cells value. The data type will automatically be determed if you do not specify the :type option. The default style will be applied if you do not supply the :style option. Changing the cell's type will recast the value to the type specified. Altering the cell's value via the property accessor will also automatically cast the provided value to the cell's type.
Constant Summary collapse
- 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
-
#b ⇒ Boolean
The inline bold property for the cell.
-
#charset ⇒ String
The inline charset property for the cell.
-
#color ⇒ Color
The inline color property for the cell.
-
#condense ⇒ Boolean
The inline condense property for the cell.
-
#extend ⇒ Boolean
The inline extend property for the cell.
-
#family ⇒ String
The inline family property for the cell.
-
#font_name ⇒ String
The inline font_name property for the cell.
-
#i ⇒ Boolean
The inline italic property for the cell.
-
#outline ⇒ Boolean
The inline outline property for the cell.
-
#row ⇒ Row
readonly
The row this cell belongs to.
-
#scheme ⇒ Symbol
The inline scheme property for the cell this must be one of [:none, major, minor].
-
#shadow ⇒ Boolean
The inline shadow property for the cell.
-
#ssti ⇒ Integer
readonly
The Shared Strings Table index for this cell.
-
#strike ⇒ Boolean
The inline strike property for the cell.
-
#style ⇒ Integer
The index of the cellXfs item to be applied to this cell.
-
#sz ⇒ Boolean
The inline sz property for the cell.
-
#type ⇒ Symbol
The cell's data type.
-
#u ⇒ Boolean
The inline underline property for the cell.
-
#value ⇒ String, ...
The value of this cell.
-
#vertAlign ⇒ Symbol
The inline vertical alignment property for the cell this must be one of [:baseline, :subscript, :superscript].
Instance Method Summary collapse
-
#autowidth ⇒ Object
This is still not perfect...
-
#index ⇒ Integer
The index of the cell in the containing row.
-
#initialize(row, value = "", options = {}) ⇒ Cell
constructor
A new instance of Cell.
- #is_formula? ⇒ Boolean
-
#is_text_run? ⇒ Boolean
Indicates that the cell has one or more of the custom cell styles applied.
-
#merge(target) ⇒ Object
Merges all the cells in a range created between this cell and the cell or string name for a cell provided.
-
#plain_string? ⇒ Boolean
Indicates if the cell is good for shared string table.
-
#pos ⇒ Array
Of x/y coordinates in the cheet for this cell.
-
#r ⇒ String
The alpha(column)numeric(row) reference for this sell.
-
#r_abs ⇒ String
The absolute alpha(column)numeric(row) reference for this sell.
-
#reference(absolute = true) ⇒ String
returns the absolute or relative string style reference for this cell.
-
#run_xml_string(str = '') ⇒ String
builds an xml text run based on this cells attributes.
-
#to_xml_string(r_index, c_index, str = '') ⇒ String
Serializes the cell.
Methods included from OptionsParser
Constructor Details
#initialize(row, value = "", options = {}) ⇒ Cell
Returns a new instance of Cell.
32 33 34 35 36 37 38 39 40 41 42 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 32 def initialize(row, value="", ={}) self.row=row @value = @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 @style ||= 0 @type ||= cell_type_from_value(value) @value = cast_value(value) end |
Instance Attribute Details
#b ⇒ Boolean
The inline bold property for the cell
128 129 130 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 128 def b @b end |
#charset ⇒ String
The inline charset property for the cell
116 117 118 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 116 def charset @charset end |
#color ⇒ Color
The inline color property for the cell
176 177 178 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 176 def color @color end |
#condense ⇒ Boolean
The inline condense property for the cell
158 159 160 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 158 def condense @condense end |
#extend ⇒ Boolean
The inline extend property for the cell
164 165 166 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 164 def extend @extend end |
#family ⇒ String
The inline family property for the cell
122 123 124 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 122 def family @family end |
#font_name ⇒ String
The inline font_name property for the cell
110 111 112 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 110 def font_name @font_name end |
#i ⇒ Boolean
The inline italic property for the cell
134 135 136 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 134 def i @i end |
#outline ⇒ Boolean
The inline outline property for the cell
146 147 148 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 146 def outline @outline end |
#row ⇒ Row
The row this cell belongs to.
62 63 64 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 62 def row @row end |
#scheme ⇒ Symbol
The inline scheme property for the cell this must be one of [:none, major, minor]
202 203 204 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 202 def scheme @scheme end |
#shadow ⇒ Boolean
The inline shadow property for the cell
152 153 154 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 152 def shadow @shadow end |
#ssti ⇒ Integer
The Shared Strings Table index for this cell
211 212 213 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 211 def ssti @ssti end |
#strike ⇒ Boolean
The inline strike property for the cell
140 141 142 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 140 def strike @strike end |
#style ⇒ Integer
The index of the cellXfs item to be applied to this cell.
58 59 60 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 58 def style @style end |
#sz ⇒ Boolean
The inline sz property for the cell
185 186 187 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 185 def sz @sz end |
#type ⇒ Symbol
If the value provided cannot be cast into the type specified, type is changed to :string and the following logic is applied. :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. No support is currently implemented for parsing time strings.
The cell's data type. Currently only six types are supported, :date, :time, :float, :integer, :string and :boolean. Changing the type for a cell will recast the value into that type. If no type option is specified in the constructor, the type is automatically determed.
75 76 77 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 75 def type @type end |
#u ⇒ Boolean
The inline underline property for the cell
170 171 172 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 170 def u @u end |
#value ⇒ String, ...
The value of this cell.
86 87 88 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 86 def value @value end |
#vertAlign ⇒ Symbol
The inline vertical alignment property for the cell this must be one of [:baseline, :subscript, :superscript]
192 193 194 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 192 def vertAlign @vertAlign end |
Instance Method Details
#autowidth ⇒ Object
This is still not perfect...
- scaling is not linear as font sizes increst
- different fonts have different mdw and char widths
326 327 328 329 330 331 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 326 def autowidth return if is_formula? || value == nil mdw = 1.78 #This is the widest width of 0..9 in arial@10px) font_scale = (font_size/10.0).to_f ((value.to_s.count(Worksheet.thin_chars) * mdw + 5) / mdw * 256) / 256.0 * font_scale end |
#index ⇒ Integer
Returns The index of the cell in the containing row.
214 215 216 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 214 def index @row.cells.index(self) end |
#is_formula? ⇒ Boolean
319 320 321 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 319 def is_formula? @type == :string && @value.to_s.start_with?('=') end |
#is_text_run? ⇒ Boolean
Indicates that the cell has one or more of the custom cell styles applied.
95 96 97 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 95 def is_text_run? @is_text_run ||= false end |
#merge(target) ⇒ Object
Merges all the cells in a range created between this cell and the cell or string name for a cell provided
249 250 251 252 253 254 255 256 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 249 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 |
#plain_string? ⇒ Boolean
Indicates if the cell is good for shared string table
100 101 102 103 104 105 106 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 100 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 |
#pos ⇒ Array
Returns of x/y coordinates in the cheet for this cell.
242 243 244 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 242 def pos [index, row.index] end |
#r ⇒ String
Returns The alpha(column)numeric(row) reference for this sell.
221 222 223 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 221 def r Axlsx::cell_r index, @row.index end |
#r_abs ⇒ String
Returns The absolute alpha(column)numeric(row) reference for this sell.
228 229 230 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 228 def r_abs "$#{r.match(%r{([A-Z]+)([0-9]+)})[1,2].join('$')}" end |
#reference(absolute = true) ⇒ String
returns the absolute or relative string style reference for this cell. returned.
338 339 340 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 338 def reference(absolute=true) absolute ? r_abs : r end |
#run_xml_string(str = '') ⇒ String
builds an xml text run based on this cells attributes.
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 261 def run_xml_string(str = '') if is_text_run? data = instance_values.reject{|key, value| value == nil || key == 'value' || key == 'type' } keys = data.keys & INLINE_STYLES 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 str << "<" << 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 |
#to_xml_string(r_index, c_index, str = '') ⇒ String
Serializes the cell
288 289 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 |
# File 'lib/axlsx/workbook/worksheet/cell.rb', line 288 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 |