DocumentDescriptor

Represents the configuration of a Spreadsheet document.

NameTypeDefaultDescription

activeSheet?

string

The name of the currently active sheet. Must exactly match one of the sheet names.

columns?

number

50

The number of columns in the document.

columnWidth?

number

64

The default column width in pixels.

defaultCellStyle?

CellDefaultStyle

The default cell styles that will be applied to the sheet cells.

headerHeight?

number

20

The height of the header row in pixels.

headerWidth?

number

32

The width of the header column in pixels.

images?

{[name: string]: string}

An object containing any images used in the Spreadsheet. The keys should be image ID-s (they are referenced by this ID in sheets.drawings) and the values should be image URLs. The image URLs can be either data URLs, in which case the images are fully contained by the JSON, or can be external URLs. Note that when external URLs are used, they should reside on the same domain, or the server must be configured with the proper CORS headers, for the Spreadsheet to be able to fetch binary image data using a XMLHttpRequest. If it cannot fetch the image, export to Excel or PDF might not work.

names?

{ localName: string; name: string; sheet: string; value: string; }[]

An array which holds the names of the sheets.

rowHeight?

number

20

The default row height in pixels.

rows?

number

200

The number of rows in the document.

sheets?

SheetDescriptor[]

An array which defines the document sheets and their content.