Sheet

The Sheet object holds a lot of settings and values. It contains the data in form of rows, columns and/or cells and many format and display options.

Content and Structure of an Excel Sheet. ‘Columns’, ‘Rows’ and ‘Cells’ will be processed in this very order.

Examples

"sheet": {
    "name": "Example-1",
    "rows": [
        {
            "values": [ "Title", "Firstname", "Surname"]
        },
        {
            "path": "desktop/examples/data-blocks/data-file.xlsx",
            "fields": [ "Title", "GivenName", "Surname"]
        }
    ],
    "display": {
        "hideGrid": true
    }
}

Implementations

Workbook

Properties

name	type	description
columnWidth	integer	Set default Column Width for the sheet. Set auto width to match the cells' content: -1 Unit: character minimum:-1
defaultColumn	object
defaultColumn.minWidth	integer	Default column minimum width. Unit: character
defaultColumn.maxWidth	integer	Default column maximium width. Unit: character
filters	object	Sets sheet filters
filters.autoFilter	boolean	Sets columns auto filter for sheet, based on contents of the columns
name	string	Optional sheet name. default: "Sheet1"
columns	array	Array of Columns minItems:1 ArrayItems   Column
rows	array	Array of Rows, starting from top if not specified by Position. Data Rows are repeated regarding to their input. ArrayItems   Row
cells	array	Array of Cells. ArrayItems   Cell
display	object	Set display options
display.hideGrid	boolean	Hides the grid on the entire spreadsheet.
display.zoom	integer	Set the zoom to a value between 25 and 400 percent.
display.freeze	boolean	Freeze panes at column 0 : row 1
	array	Freeze at custom position ArrayItems:   column integer - default: 0   row integer - default: 1
print	object	Option defining the print settings. Print
format	object	Format Options Format
formatRef	string	Reference to a named format.