SheetXL - v1.0.2
    Preparing search index...

    Interface GetFlattenOptions

    interface GetFlattenOptions {
        axes?: AxisSelection;
        features?: ICellRange.Feature | readonly ICellRange.Feature[];
        ignoreHidden?: boolean | Axis;
        ignoreSpilled?: boolean;
    }

    Hierarchy (View Summary)

    Index
    axes?: AxisSelection

    Returns a set of ranges with overlaps removed and attempts to merge adjacent ranges into larger ranges.

    The overlap detection and initial merge axis.

    A new ICellRanges object with non-overlapping, and where possible, merged ranges.

    IRange.AxisSelection.Both.

    features?: ICellRange.Feature | readonly ICellRange.Feature[]

    The features reads through this range resolve and report.

    all features
    

    The lens for every feature-aware read: iteration visits only cells that exist through a listed feature, ICellRange.getCounts / ICellRange.isContentful / ICellRange.getRegions report on that selection, and ICellRange.getUsedRange measures its extent.

    An empty list is the raw-value fast path — no feature state is resolved at all.

    ICellRange.getValues and ICellRange.values are deliberately exempt — a value is a value regardless of the lens.

    ignoreHidden?: boolean | Axis

    Skip cells hidden via headers.

    false
    

    Honored by every read that walks cells — iteration (ICellRange.forEach, ICellRange.entries), the aggregates (ICellRange.getCounts, ICellRange.getCount, ICellRange.isContentful), ICellRange.getMerges and ICellRange.getRegions.

    Optionally an IRange.Axis to skip on one axis only — sorting skips hidden rows while leaving hidden columns in place.

    ignoreSpilled?: boolean

    Skip cells that only hold a spilled value - the members of a dynamic array's spill.

    false
    

    A spilled value is not a cell's own content: it belongs to the formula at the spill's anchor, which is NOT skipped. Writing over a spilled cell loses nothing - the spill is blocked and its anchor reports #SPILL! - so this is the lens for "would writing here overwrite anything?". A blocked spill occupies only its anchor, so the cells it would have taken are never skipped.

    Honored by the aggregates: ICellRange.isContentful and ICellRange.getCounts.