xsheetjs/docbits/56_wbprops.md
2017-09-24 19:40:09 -04:00

1.3 KiB

Workbook File Properties

The various file formats use different internal names for file properties. The workbook Props object normalizes the names:

File Properties (click to show)
JS Name Excel Description
Title Summary tab "Title"
Subject Summary tab "Subject"
Author Summary tab "Author"
Manager Summary tab "Manager"
Company Summary tab "Company"
Category Summary tab "Category"
Keywords Summary tab "Keywords"
Comments Summary tab "Comments"
LastAuthor Statistics tab "Last saved by"
CreatedDate Statistics tab "Created"

For example, to set the workbook title property:

if(!wb.Props) wb.Props = {};
wb.Props.Title = "Insert Title Here";

Custom properties are added in the workbook Custprops object:

if(!wb.Custprops) wb.Custprops = {};
wb.Custprops["Custom Property"] = "Custom Value";

Writers will process the Props key of the options object:

/* force the Author to be "SheetJS" */
XLSX.write(wb, {Props:{Author:"SheetJS"}});