Interface NamedItemsOptions

interface NamedItemsOptions {
    addRangeListener?: ((address, listener, options?) => RemoveListener);
    decodeAddress: ((address) => SheetCellRangeCoords[]);
    encodeAddress: ((addresses) => string);
    initialJSON?: NamedItemsJSON;
    transactionStore?: TransactionStore;
    workbook?: IWorkbookModel;
}

Index

Properties

addRangeListener? decodeAddress encodeAddress initialJSON? transactionStore? workbook?

Properties

`Optional` addRangeListener

addRangeListener?: ((address, listener, options?) => RemoveListener)

If provided then the named ranges will update when the ranges update.

Type declaration

- (address, listener, options?): RemoveListener
- Parameters
  - address: SheetCellRangeCoordsAddress
  - listener: IWorkbookRangeListener
  - Optional options: RangeListenerOptions
  Returns RemoveListener

decodeAddress

decodeAddress: ((address) => SheetCellRangeCoords[])

Required for resolving ranges.

Type declaration

- (address): SheetCellRangeCoords[]
- Parameters
  - address: SheetCellRangeCoordsAddresses
  Returns SheetCellRangeCoords[]

encodeAddress

encodeAddress: ((addresses) => string)

Required for resolving ranges.

Type declaration

- (addresses): string
- Parameters
  - addresses: SheetCellRangeCoords
  Returns string

`Optional` initialJSON

initialJSON?: NamedItemsJSON

`Optional` transactionStore

transactionStore?: TransactionStore

A transaction store that can be used to undo/redo changes to the namedRanges.

`Optional` workbook

workbook?: IWorkbookModel