Interface Event

interface Event {
    isDataChange?: boolean;
    isUndo?: boolean;
    timeStamp: number;
    trigger: string;
    trigger2?: "address" | "data" | "restore";
    getFrom(): ICellRanges;
    getSource<T = ICellRanges | ICellRange>(): T;
    getTo?(): ICellRange;
    getTransactionId(): string | null;
    toString(): string;
}

Index

Properties

isDataChange? isUndo? timeStamp trigger trigger2?

Methods

getFrom getSource getTo? getTransactionId toString

Properties

`Optional` `Readonly`isDataChange

isDataChange?: boolean

Indicates if the event is being fired due to a cell value change.

See

ListenerOptions.ignoreDataChanges

`Optional` `Readonly`isUndo

isUndo?: boolean

Indicates if the event is being fired from an undo event.

`Readonly`timeStamp

timeStamp: number

The timestamp of the event.

`Readonly`trigger

trigger: string

`Optional` `Readonly`trigger2

trigger2?: "address" | "data" | "restore"

Indicates the type of change that triggered the event.

Remarks

'data': Data within the range has changed. The range's address and dimensions remain the same.
'address': The range's address or dimensions have changed. This occurs due to row/column insertions, deletions, or move operations — and, for a sheet-qualified range (one from IWorkbook.getRange, or a sheet's range naming another sheet), when the sheet it names is renamed. A bare range on its own sheet has no qualifier, so a rename is not a change to it.
'restore': The range has been restored to a different revision (undo/redo). The 'restore' trigger is not available for transactional listeners.

Methods

getFrom

getFrom(): ICellRanges

This is the range of data that has been changed.

Returns ICellRanges

Remarks
This is different than the source range as that is the entire range area that was listened to.

getSource

getSource<T = ICellRanges | ICellRange>(): T
The source of the event. This will be a readonly range.
Type Parameters
- T = ICellRanges | ICellRange
Returns T

Remarks
This may change shape due to insert/delete/move of cells or sheets.

`Optional`getTo

getTo?(): ICellRange

Used for moves. Represents the new location of the data that has changed.

Returns ICellRange

getTransactionId

getTransactionId(): string | null

Returns the transaction Id if the event is occurring in a transaction otherwise null.

Returns string | null

See
ListenerOptions.getTransactionId

toString

toString(): string

To string the event.

Returns string