From 2d0ac967e94c5944ccccf9adad8da5a9d082df29 Mon Sep 17 00:00:00 2001 From: Randy Morgan Date: Sun, 20 Nov 2011 23:44:58 +0900 Subject: pushing docs --- doc/Axlsx/Worksheet.html | 1864 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 1864 insertions(+) create mode 100644 doc/Axlsx/Worksheet.html (limited to 'doc/Axlsx/Worksheet.html') diff --git a/doc/Axlsx/Worksheet.html b/doc/Axlsx/Worksheet.html new file mode 100644 index 00000000..36a5798c --- /dev/null +++ b/doc/Axlsx/Worksheet.html @@ -0,0 +1,1864 @@ + + + + + + Class: Axlsx::Worksheet + + — Documentation by YARD 0.7.3 + + + + + + + + + + + + + + + + + + + + + + +

Class: Axlsx::Worksheet + + + +

+ +
+ +
Inherits:
+
+ Object + +
    +
  • Object
    • + + + +
+ show all + +
+ + + + + + + + + +
Defined in:
+
lib/axlsx/workbook/worksheet/worksheet.rb
+ +
+
+ +

Overview

+
+

+The Worksheet class represents a worksheet in the workbook. +

+ + +
+
+
+ + +
+ +

Instance Attribute Summary (collapse)

+ + + + + + +

+ Instance Method Summary + (collapse) +

+ + + + +
+

Constructor Details

+ +
+

+ + - (Worksheet) initialize(wb, options = {}) + + + +

+
+ +
+ Note: +

+the recommended way to manage worksheets is Workbook#add_worksheet +

+
+
+ +

+Creates a new worksheet. +

+ + +
+
+
+

Parameters:

+
    + +
  • + + options + + + (Hash) + + + (defaults to: {}) + + + — +

    +a customizable set of options +

    +
    + +
    • + +
+ + + + + + +

Options Hash (options):

+
    + +
  • + name + (String) + + + + —

    +The name of this sheet. +

    +
    +
    • + +
+ + + +

See Also:

+ + +
+ + + + +
+ 
+
+
+59
+60
+61
+62
+63
+64
+65
+66
+ 		+ 
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 59
+
+def initialize(wb, options={})
+  @rows = SimpleTypedList.new Row
+  self.workbook = wb
+  @workbook.worksheets << self
+  @auto_fit_data = []
+  self.name = options[:name] || "Sheet" + (index+1).to_s
+  @magick_draw = Magick::Draw.new
+end
+
+
+
+ +
+ +
+

Instance Attribute Details

+ + + + +
+

+ + - (Array) auto_fit_data (readonly) + + + +

+
+ +
+ Note: +

+a single auto fit data item is a hash with :longest => [String] and +:sz=> [Integer] members. +

+
+
+ +

+An array of content based calculated column widths. +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Array) + + + + — +

    +of Hash +

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+34
+35
+36
+ 		+ 
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 34
+
+def auto_fit_data
+  @auto_fit_data
+end
+
+
+
+ + + + +
+

+ + - (Drawing) drawing (readonly) + + + +

+
+ +
+ Note: +

+the recommended way to work with drawings and charts is Worksheet#add_chart +

+
+
+ +

+The drawing associated with this worksheet. +

+ + +
+
+
+ +

Returns:

+ + +

See Also:

+ + +
+ + + + +
+ 
+
+
+29
+30
+31
+ 		+ 
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 29
+
+def drawing
+  @drawing || @drawing = Axlsx::Drawing.new(self)
+end
+
+
+
+ + + + +
+

+ + - (Integer) index (readonly) + + + +

+
+

+The index of this worksheet in the owning Workbook’s worksheets list. +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (Integer) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+50
+51
+52
+ 		+ 
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 50
+
+def index
+  @workbook.worksheets.index(self)
+end
+
+
+
+ + + + +
+

+ + - (String) name + + + +

+
+

+The name of the worksheet +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+9
+10
+11
+ 		+ 
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 9
+
+def name
+  @name
+end
+
+
+
+ + + + +
+

+ + - (String) pn (readonly) + + + +

+
+

+The part name of this worksheet +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+38
+39
+40
+ 		+ 
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 38
+
+def pn
+  "#{WORKSHEET_PN % (index+1)}"
+end
+
+
+
+ + + + +
+

+ + - (Object) relationships (readonly) + + + +

+
+

+The worksheet’s relationships. +

+ + +
+
+
+ + +
+ + + + +
+ 
+
+
+17
+18
+19
+20
+21
+ 		+ 
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 17
+
+def relationships
+    r = Relationships.new
+    r << Relationship.new(DRAWING_R, "../#{@drawing.pn}") if @drawing
+    r
+end
+
+
+
+ + + + +
+

+ + - (String) rels_pn (readonly) + + + +

+
+

+The relationship part name of this worksheet +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+42
+43
+44
+ 		+ 
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 42
+
+def rels_pn
+  "#{WORKSHEET_RELS_PN % (index+1)}"
+end
+
+
+
+ + + + +
+

+ + - (String) rId (readonly) + + + +

+
+

+The relationship Id of thiw worksheet +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+46
+47
+48
+ 		+ 
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 46
+
+def rId
+  "rId#{index+1}"
+end
+
+
+
+ + + + +
+

+ + - (SimpleTypedList) rows (readonly) + + + +

+
+ +
+ Note: +

+The recommended way to manage rows is Worksheet#add_row +

+
+
+ +

+The rows in this worksheet +

+ + +
+
+
+ +

Returns:

+ + +

See Also:

+ + +
+ + + + +
+ 
+
+
+23
+24
+25
+ 		+ 
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 23
+
+def rows
+  @rows
+end
+
+
+
+ + + + +
+

+ + - (Workbook) workbook + + + +

+
+

+The workbook that owns this worksheet +

+ + +
+
+
+ +

Returns:

+ + +
+ + + + +
+ 
+
+
+13
+14
+15
+ 		+ 
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 13
+
+def workbook
+  @workbook
+end
+
+
+
+ +
+ + +
+

Instance Method Details

+ + +
+

+ + - (Object) add_chart(chart_type, options = {}) {|chart| ... } + + + +

+
+

+Adds a chart to this worksheets drawing. +

+ + +
+
+
+

Parameters:

+
    + +
  • + + chart_type + + + (Class) + + + +
    • + +
  • + + options + + + (Hash) + + + (defaults to: {}) + + + — +

    +a customizable set of options +

    +
    + +
    • + +
+ + + + + + +

Options Hash (options):

+
    + +
  • + start_at + (Array) + + + + +
    • + +
  • + end_at + (Array) + + + + +
    • + +
  • + title + (Cell, String) + + + + +
    • + +
+ + +

Yields:

+
    + +
  • + + + (chart) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+108
+109
+110
+111
+112
+ 		+ 
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 108
+
+def add_chart(chart_type, options={})
+  chart = drawing.add_chart(chart_type, options)
+  yield chart if block_given?
+  chart
+end
+
+
+
+ +
+

+ + - (Row) add_row(values = [], options = {}) {|@rows.last| ... } + + + +

+
+

+Adds a row to the worksheet and updates auto fit data +

+ + +
+
+
+

Parameters:

+
    + +
  • + + options + + + (Hash) + + + (defaults to: {}) + + + — +

    +a customizable set of options +

    +
    + +
    • + +
+ + + + + + +

Options Hash (options):

+
    + +
  • + values + (Array) + + + + +
    • + +
  • + types + (Array, Symbol) + + + + +
    • + +
  • + style + (Array, Integer) + + + + +
    • + +
+ + +

Yields:

+
    + +
  • + + + (@rows.last) + + + +
    • + +
+

Returns:

+
    + +
  • + + + (Row) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+96
+97
+98
+99
+100
+101
+ 		+ 
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 96
+
+def add_row(values=[], options={})
+  Row.new(self, values, options)
+  update_auto_fit_data @rows.last.cells
+  yield @rows.last if block_given?
+  @rows.last
+end
+
+
+
+ +
+

+ + - (Float) auto_width(col) + + + +

+
+ +
+ Note: +

+From ECMA docs +

+
+ Column width measured as the number of characters of the maximum digit width of the numbers 0 .. 9 as
+ rendered in the normal style's font. There are 4 pixels of margin padding (two on each side), plus 1 pixel padding for the gridlines.
+ width = Truncate([{Number of Characters} * {Maximum Digit Width} + {5 pixel padding}]/{Maximum Digit Width}*256)/256
+
+
+
+ +

+Determines the proper width for a column based on content. +

+ + +
+
+
+

Parameters:

+
    + +
  • + + A + + + (Hash) + + + + — +

    +hash of auto_fit_data +

    +
    + +
    • + +
+ +

Returns:

+
    + +
  • + + + (Float) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+182
+183
+184
+185
+186
+187
+188
+189
+190
+191
+ 		+ 
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 182
+
+def auto_width(col)
+  mdw = 6.0 # maximum digit with is always 6.0 in testable fonts so instead of beating RMagick every time, I am hardcoding it here.
+  mdw_count = 0 
+  best_guess = 1.5  #direct testing shows the results of the documented formula to be a bit too small. This is a best guess scaling
+  font_scale = col[:sz].to_f / (self.workbook.styles.fonts[0].sz.to_f || 11.0)
+  col[:longest].scan(/./mu).each do |i|
+    mdw_count +=1 if @magick_draw.get_type_metrics(i).width >= mdw 
+  end
+  ((mdw_count * mdw + 5) / mdw * 256) / 256.0 * best_guess * font_scale      
+end
+
+
+
+ +
+

+ + - (String) to_xml + + + +

+
+

+Serializes the worksheet document +

+ + +
+
+
+ +

Returns:

+
    + +
  • + + + (String) + + + +
    • + +
+ +
+ + + + +
+ 
+
+
+116
+117
+118
+119
+120
+121
+122
+123
+124
+125
+126
+127
+128
+129
+130
+131
+132
+133
+134
+135
+136
+ 		+ 
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 116
+
+def to_xml
+  builder = Nokogiri::XML::Builder.new(:encoding => ENCODING) do |xml|
+    xml.worksheet(:xmlns => XML_NS, :'xmlns:r' => XML_NS_R) {
+      if @auto_fit_data.size > 0
+        xml.cols {
+          @auto_fit_data.each_with_index do |col, index|
+            min_max = index+1
+            xml.col(:min=>min_max, :max=>min_max, :width => auto_width(col), :customWidth=>"true")
+          end
+        }
+      end
+      xml.sheetData {
+        @rows.each do |row|
+          row.to_xml(xml)
+        end
+      }
+      xml.drawing :"r:id"=>"rId1" if @drawing          
+    }
+  end
+  builder.to_xml(:indent=>0, :save_with=>0)
+end
+
+
+
+ +
+

+ + - (Array) update_auto_fit_data(cells) + + + +

+
+

+Updates auto fit data. Autofit data attempts to determine the cell in a +column that has the greatest width by comparing the length of the text +multiplied by the size of the font. +

+ + +
+
+
+

Parameters:

+
    + +
  • + + cells + + + (Array) + + + + — +

    +an array of cells +

    +
    + +
    • + +
+ +

Returns:

+
    + +
  • + + + (Array) + + + + — +

    +of Cell objects +

    +
    + +
    • + +
+ +
+ + + + +
+ 
+
+
+154
+155
+156
+157
+158
+159
+160
+161
+162
+163
+164
+165
+166
+167
+168
+169
+170
+171
+172
+ 		+ 
# File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 154
+
+def update_auto_fit_data(cells)
+  styles = self.workbook.styles
+  cellXfs, fonts = styles.cellXfs, styles.fonts
+  sz = fonts[0].sz
+
+  cells.each_with_index do |item, index|
+    col = @auto_fit_data[index] || {:longest=>"", :sz=>sz} 
+    cell_xf = cellXfs[item.style]
+    font = fonts[cell_xf.fontId || 0]
+    sz = font.sz || sz
+
+    if (col[:longest].scan(/./mu).size * col[:sz]) < (item.value.to_s.scan(/./mu).size * sz)
+      col[:sz] =  sz
+      col[:longest] = item.value.to_s
+    end
+    @auto_fit_data[index] = col
+  end
+  cells
+end
+
+
+
+ +
+ +
+ + + + + \ No newline at end of file -- cgit v1.2.3