xsheetjs/docbits/53_wsobject.md

23 lines
1.0 KiB
Markdown
Raw Normal View History

2017-03-31 21:46:02 +00:00
### Sheet Objects
Each key that does not start with `!` maps to a cell (using `A-1` notation)
2017-03-31 21:46:02 +00:00
`sheet[address]` returns the cell object for the specified address.
2017-03-31 21:46:02 +00:00
Special sheet keys (accessible as `sheet[key]`, each starting with `!`):
2017-03-31 21:46:02 +00:00
- `sheet['!ref']`: A-1 based range representing the sheet range. Functions that
work with sheets should use this parameter to determine the range. Cells that
are assigned outside of the range are not processed. In particular, when
2017-03-31 21:46:02 +00:00
writing a sheet by hand, cells outside of the range are not included
2017-03-31 21:46:02 +00:00
Functions that handle sheets should test for the presence of `!ref` field.
If the `!ref` is omitted or is not a valid range, functions are free to treat
the sheet as empty or attempt to guess the range. The standard utilities that
ship with this library treat sheets as empty (for example, the CSV output is
empty string).
When reading a worksheet with the `sheetRows` property set, the ref parameter
will use the restricted range. The original range is set at `ws['!fullref']`