# OpenSheetOptions

**Kind**: interface | **Module**: [Excel](https://docs.interop.io/adapters/reference/javascript/excel/index.md)

**Source**: https://docs.interop.io/adapters/reference/javascript/excel/opensheetoptions/index.html

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

## Properties

- **`buttonRange`** (`string`, optional) default: `"A1"`
  The trigger button is placed over a range of cells.
- **`buttonText`** (`string`, optional)
  The caption to use for a trigger button.
- **`chunkSize`** (`number`, optional) default: `1000`
  The maximum number of rows of changes to send in each invocation of the validation method.
- **`clearGrid`** (`boolean`, optional) default: `true`
  Remove all existing rows before applying the new data.
- **`dataRangeName`** (`string`, optional)
  ExcelPad will create an Excel Named Range that defines the extent of the data written to the worksheet.
- **`inhibitLocalSave`** (`boolean`, optional)
  Set to true to prevent the user from saving the temporary workbook.
- **`response`** (`"image" | "delta"`, optional) default: `"delta"`
  The `"delta"` response will return only the delta change and `"image"` will return the current data after the change.
- **`sendBeforeAndAfter`** (`boolean`, optional) default: `true`
  If `true`, send before and after images of each row as it's sent for validation.
- **`templateWorkbook`** (`string`, optional)
  Name of a template workbook to use when creating new workbooks.
- **`templateWorksheet`** (`string`, optional)
  Name of the worksheet to display; ignored if there is no template.
- **`timeoutMs`** (`number`, optional)
  How long to wait for success response from Excel when opening sheet.
- **`topLeft`** (`string`, optional) default: `"A1"`
  The top-left address of the data in the dataWorksheet.
- **`updateTrigger`** (`TriggerType[]`, optional) default: `["save"]`
  Trigger conditions that tell ExcelPad when to invoke the validation method.
- **`window`** (`"hide" | "show" | "normal" | "restore" | "max" | "min" | "top" | "bottom"`, optional)
  Excel window activation/state options.
- **`workbook`** (`string`, optional)
  Name of the workbook to reuse; otherwise a new temporary workbook will be created.
- **`worksheet`** (`string`, optional)
  Name of the sheet to receive the data; else uses the first sheet in the workbook.

## Related types

- [TriggerType](https://docs.interop.io/adapters/reference/javascript/excel/triggertype/index.md)