SheetXL - v1.0.2
    Preparing search index...

    Interface IteratorOptions

    interface IteratorOptions {
        axis?: RangeAxis;
        byCell?: boolean;
        reuseIterator?: boolean | IteratorResult<Intersection, any>;
        reverse?: boolean;
    }
    Index
    axis? byCell? reuseIterator? reverse?
    axis?: RangeAxis

    The direction of the scan.

    RangeAxis.Row
    byCell?: boolean

    Set iterator to increment by cells within an intersection.

    false

    Depending on the range intersect it is possible that some scan lines will be duplicated. This is desired as it makes merging ranges easier/possible.

    reuseIterator?: boolean | IteratorResult<Intersection, any>

    If provided then iterator results will reuse the return results.

    undefined (Creates new instances for each iterator)

    • Performance: Removes the per-step allocations (the result, range, cell, and overlaps objects are mutated in place), which matters for large sweeps.
    • Safety: A returned intersection is only valid until the next call to next — copy anything that is retained. Pass an IteratorResult to supply the reused buffer yourself.
    reverse?: boolean

    Iterate in reverse order.

    false

    Settings
    Member Visibility

    On This Page
    Properties