From 8cf0296bbc16e8eb535e9af932eed2557d5e66d2 Mon Sep 17 00:00:00 2001 From: Randy Morgan Date: Thu, 1 Dec 2011 14:11:42 +0900 Subject: removing generated yard docs from repository --- doc/Axlsx/Row.html | 896 ----------------------------------------------------- 1 file changed, 896 deletions(-) delete mode 100644 doc/Axlsx/Row.html (limited to 'doc/Axlsx/Row.html') diff --git a/doc/Axlsx/Row.html b/doc/Axlsx/Row.html deleted file mode 100644 index 8a8639bf..00000000 --- a/doc/Axlsx/Row.html +++ /dev/null @@ -1,896 +0,0 @@ - - - - - - Class: Axlsx::Row - - — AXLSX - - - - - - - - - - - - - - - - - - - - - - -

Class: Axlsx::Row - - - -

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

Overview

-
- -
- Note: -
-

The recommended way to manage rows and cells is to use Worksheet#add_row

-
-
- - -

A Row is a single row in a worksheet.

- - -
-
-
- - -

See Also:

- - -
- -

Instance Attribute Summary (collapse)

- - - - - - -

- Instance Method Summary - (collapse) -

- - - - -
-

Constructor Details

- -
-

- - - (Row) initialize(worksheet, values = [], options = {}) - - - -

-
- -

Creates a new row. New Cell objects are created based on the values, types -and style options. A new cell is created for each item in the values array. -style and types options are applied as follows:

- -
If the types option is defined and is a symbol it is applied to all the cells created.
-If the types option is an array, cell types are applied by index for each cell
-If the types option is not set, the cell will automatically determine its type.
-If the style option is defined and is an Integer, it is applied to all cells created.
-If the style option is an array, style is applied by index for each cell.
-If the style option is not defined, the default style (0) is applied to each cell.
-
- - -
-
-
-

Parameters:

-
    - -
  • - - worksheet - - - (Worksheet) - - - -
    • - -
  • - - options - - - (Hash) - - - (defaults to: {}) - - - — -
    -

    a customizable set of options

    -
    - -
    • - -
- - - - - - - - -

Options Hash (options):

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

See Also:

- - -
- - - - -
- 
-
-
-29
-30
-31
-32
-33
-34
- 		- 
# File 'lib/axlsx/workbook/worksheet/row.rb', line 29
-
-def initialize(worksheet, values=[], options={})
-  self.worksheet = worksheet
-  @cells = SimpleTypedList.new Cell
-  @worksheet.rows << self
-  array_to_cells(values, options)
-end
-
-
-
- -
- -
-

Instance Attribute Details

- - - - -
-

- - - (SimpleTypedList) cells (readonly) - - - -

-
- -

The cells this row holds

- - -
-
-
- -

Returns:

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

- - - (Worksheet) worksheet - - - -

-
- -

The worksheet this row belongs to

- - -
-
-
- -

Returns:

- - -
- - - - -
- 
-
-
-9
-10
-11
- 		- 
# File 'lib/axlsx/workbook/worksheet/row.rb', line 9
-
-def worksheet
-  @worksheet
-end
-
-
-
- -
- - -
-

Instance Method Details

- - -
-

- - - (Cell) add_cell(value = "", options = {}) - - - -

-
- -

Adds a singel sell to the row based on the data provided and updates the -worksheet’s autofit data.

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Cell) - - - -
    • - -
- -
- - - - -
- 
-
-
-51
-52
-53
-54
-55
- 		- 
# File 'lib/axlsx/workbook/worksheet/row.rb', line 51
-
-def add_cell(value="", options={})
-  c = Cell.new(self, value, options)
-  update_auto_fit_data
-  c
-end
-
-
-
- -
-

- - - (Integer) index - - - -

-
- -

The index of this row in the worksheet

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Integer) - - - -
    • - -
- -
- - - - -
- 
-
-
-38
-39
-40
- 		- 
# File 'lib/axlsx/workbook/worksheet/row.rb', line 38
-
-def index 
-  worksheet.rows.index(self)
-end
-
-
-
- -
-

- - - (Object) style=(style) - - - -

-
- -

sets the style for every cell in this row

- - -
-
-
- - -
- - - - -
- 
-
-
-58
-59
-60
-61
-62
-63
- 		- 
# File 'lib/axlsx/workbook/worksheet/row.rb', line 58
-
-def style=(style)
-  cells.each_with_index do | cell, index |
-    s = style.is_a?(Array) ? style[index] : style
-    cell.style = s
-  end
-end
-
-
-
- -
-

- - - (Array) to_ary - - - -

-
- -

returns the cells in this row as an array This lets us transpose the rows -into columns

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Array) - - - -
    • - -
- -
- - - - -
- 
-
-
-68
-69
-70
- 		- 
# File 'lib/axlsx/workbook/worksheet/row.rb', line 68
-
-def to_ary
-  @cells.to_ary
-end
-
-
-
- -
-

- - - (String) to_xml(xml) - - - -

-
- -

Serializes the row

- - -
-
-
-

Parameters:

-
    - -
  • - - xml - - - (Nokogiri::XML::Builder) - - - - — -
    -

    The document builder instance this objects xml will be added to.

    -
    - -
    • - -
- -

Returns:

-
    - -
  • - - - (String) - - - -
    • - -
- -
- - - - -
- 
-
-
-45
-46
-47
- 		- 
# File 'lib/axlsx/workbook/worksheet/row.rb', line 45
-
-def to_xml(xml)
-  xml.row(:r => index+1) { @cells.each { |cell| cell.to_xml(xml) } }
-end
-
-
-
- -
- -
- - - - - \ No newline at end of file -- cgit v1.2.3