SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface useRangeListenerOptions

    interface useRangeListenerOptions {
        fireOnAddressChange: boolean;
        ignoreAddressChanges?: boolean;
        ignoreDataChanges?: boolean;
        once?: boolean;
        transactional?: boolean;
        weakly?: boolean;
    }

    Hierarchy

    • ListenerOptions
      • useRangeListenerOptions
    Index
    fireOnAddressChange: boolean
    ignoreAddressChanges?: boolean

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

    false
    
    ignoreDataChanges?: boolean

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

    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