sheetjs_sheetjs/docbits/54_shobject.md
SheetJS 95a377c0e4 more format parity
- XLS/XLSX/XLSB/XML/ODS cellFormula option + test
- XLS/XLSX/XLSB/XML/ODS cellText option + test
- XML document property order
- XML write margins + protection
- removed gitbook search
2017-04-25 22:27:12 -04:00

2.8 KiB

Worksheet Object

In addition to the base sheet keys, worksheets also add:

  • ws['!cols']: array of column properties objects. Column widths are actually stored in files in a normalized manner, measured in terms of the "Maximum Digit Width" (the largest width of the rendered digits 0-9, in pixels). When parsed, the column objects store the pixel width in the wpx field, character width in the wch field, and the maximum digit width in the MDW field.

  • ws['!merges']: array of range objects corresponding to the merged cells in the worksheet. Plaintext utilities are unaware of merge cells. CSV export will write all cells in the merge range if they exist, so be sure that only the first cell (upper-left) in the range is set.

  • ws['protect']: object of write sheet protection properties. The password key specifies the password for formats that support password-protected sheets (XLSX/XLSB/XLS). The writer uses the XOR obfuscation method. The following keys control the sheet protection (same as ECMA-376 18.3.1.85):

key functionality disabled if value is true
selectLockedCells Select locked cells
selectUnlockedCells Select unlocked cells
formatCells Format cells
formatColumns Format columns
formatRows Format rows
insertColumns Insert columns
insertRows Insert rows
insertHyperlinks Insert hyperlinks
deleteColumns Delete columns
deleteRows Delete rows
sort Sort
autoFilter Filter
pivotTables Use PivotTable reports
objects Edit objects
scenarios Edit scenarios
  • ws['!autofilter']: AutoFilter object following the schema:
type AutoFilter = {
  ref:string; // A-1 based range representing the AutoFilter table range
}

Chartsheet Object

Chartsheets are represented as standard sheets. They are distinguished with the !type property set to "chart".

The underlying data and !ref refer to the cached data in the chartsheet. The first row of the chartsheet is the underlying header.