Sha256: 7bf00751620823b9d2a9c6413f409d7ec9dc443d8337bacdb06953ff21fe9835

Contents?: true

Size: 1.43 KB

Versions: 2

Compression:

Stored size: 1.43 KB

Contents

## Guide to basic functionality
### Opening the file

You can open ODS file like this
````ruby
@workbook = Rspreadsheet.open('./test.ods')
````
and access its first sheet like this
````ruby
@sheet = @workbook.worksheets(1)
````
### Accessing cells

you can get and set contents of cells using "verbatim" syntax like
````ruby
@sheet.rows(5).cells(4).value 
@sheet.rows(5).cells(4).value = 10
````
or using "brief" syntax like
````ruby
@sheet[5,4]
@sheet[5,4] = 10
````

You can mix these two at will, for example like this
````ruby
@row = @sheet.rows(5)
@row[4] = 10
````

## Examples

  * [basic functionality](https://gist.github.com/gorn/42e33d086d9b4fda10ec) 
  * [extended examples](https://gist.github.com/gorn/b432e6a69e82628349e6) of lots of alternative syntax

## Conventions
  * **all indexes are 1-based**. This applies to rows, cells cordinates, and all array like structures like list od  worksheets etc. Spreadsheet world is 1-based, ruby is 0-based do I had to make a decision. I intend to make an global option for this, but in early stage I need to keep things simple. 
  * with numeric coordinates row always comes before col as in  (row,col)
  * with alphanumerical col always comes before row as in F12
  * Shorter syntax worksheet[x,y] returns value, longer syntax worksheet.cells(x,y) return cell objects. This allows to work conviniently with values using short syntax and access the cell object if needed (to access formatting for example).

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
rspreadsheet-0.2.12 GUIDE.md
rspreadsheet-0.2.11 GUIDE.md