SheetXL - v0.3.20
    Preparing search index...

    Interface ListenerOptions

    Options to control which events trigger a listener. By default, all event types will trigger the listener. Setting any of these options to true will prevent the listener from being called for that event type.

    interface ListenerOptions {
        ignoreAddressChanges?: boolean;
        ignoreDataChanges?: boolean;
        ignoreShifts?: boolean;
        once?: boolean;
        transactional?: boolean;
        weakly?: boolean;
    }
    Index

    Properties

    ignoreAddressChanges? ignoreDataChanges? ignoreShifts? once? transactional? weakly?

    Properties

    ignoreAddressChanges?: boolean

    If true, the listener will not be called when the range's address changes (due to row/column insert/delete, or moves)

    false
    ignoreDataChanges?: boolean

    If true, the listener will not be called when the data within the range changes.

    false
    ignoreShifts?: boolean

    The actual range can also change due to insert/removes or delete of a sheet. Setting absoluteCoords to true will ignore shifts in the range.

    false
    once?: boolean

    If true then will auto deregister once fired.

    transactional?: boolean

    If true, the listener will be treated as transactional. This has a few implications:

    1. Synchronous Execution: The listener will be called synchronously as part of the same transaction that triggered the event. Any side-effects of the listener will be included in the transaction's commit history.
    2. No 'restore' Events: Transactional listeners will never receive 'restore' events. They are only concerned with changes within the current transaction.

    If false (the default), the listener will be called asynchronously after the transaction is complete. The listener's side-effects will not be part of the transaction's commit history.

    false
    weakly?: boolean

    If true then the listener will be weakly and will be auto removed it the listener is gc'ed.

    false

    Settings

    Member Visibility

    On This Page

    Properties