@interopio/office API Reference

Options for controlling how a sheet is opened and how data is exchanged with Excel.

Properties (16)

Property Type Default Required Description
buttonRange⚓︎ string "A1" x

The trigger button is placed over a range of cells.
buttonText⚓︎ string x x

The caption to use for a trigger button.
chunkSize⚓︎ number 1000 x

The maximum number of rows of changes to send in each invocation of the validation method.
clearGrid⚓︎ boolean true x

Remove all existing rows before applying the new data.
dataRangeName⚓︎ string x x

ExcelPad will create an Excel Named Range that defines the extent of the data written to the worksheet.
inhibitLocalSave⚓︎ boolean x x

Set to true to prevent the user from saving the temporary workbook.
response⚓︎ "image" | "delta" "delta" x

The "delta" response will return only the delta change and "image" will return the current data after the change.
sendBeforeAndAfter⚓︎ boolean true x

If true, send before and after images of each row as it's sent for validation.
templateWorkbook⚓︎ string x x

Name of a template workbook to use when creating new workbooks.
templateWorksheet⚓︎ string x x

Name of the worksheet to display; ignored if there is no template.
timeoutMs⚓︎ number x x

How long to wait for success response from Excel when opening sheet.
topLeft⚓︎ string "A1" x

The top-left address of the data in the dataWorksheet.
updateTrigger⚓︎ TriggerType[] ["save"] x

Trigger conditions that tell ExcelPad when to invoke the validation method.
window⚓︎ "hide" | "show" | "normal" | "restore" | "max" | "min" | "top" | "bottom" x x

Excel window activation/state options.
workbook⚓︎ string x x

Name of the workbook to reuse; otherwise a new temporary workbook will be created.
worksheet⚓︎ string x x

Name of the sheet to receive the data; else uses the first sheet in the workbook.