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

    Interface GetRegionsOptions

    Options for ICellRange.getRegions.

    The traversal keys are the standard ICellRange.IteratorOptions ones, meaning what they mean everywhere else. features is the same list as the positional argument — for a partition, the features resolved and the features partitioned on are necessarily one list — so the argument is simply its shorthand.

    Pick, not Omit, and deliberately. A partition is not a cell visitation, so the rest of IteratorOptions has nothing to act on: includeEmpty (regions come from the feature indexes, and the blank side of the partition is not yielded at all), reuseContext and includeMergeOverflow (there is no per-cell IteratorContext to reuse or overflow into), injectReferences (which ignores features by its own contract), and address (the queried range IS the bounds — a second one would be ambiguous). Widening to Omit would advertise five options that silently do nothing, and a feature that silently reports nothing is worse than a missing one.

    interface GetRegionsOptions {
        axis?: Axis;
        containment?: "fullyContained" | "intersects";
        features?: ICellRange.Feature | readonly ICellRange.Feature[];
        ignoreHidden?: boolean | Axis;
        reverse?: boolean;
    }

    Hierarchy

    • Pick<
          ICellRange.IteratorOptions,
          "features"
          | "axis"
          | "reverse"
          | "ignoreHidden",
      >
      • GetRegionsOptions
    Index
    axis?: Axis

    The direction of the scan.

    IRange.Axis.Row

    containment?: "fullyContained" | "intersects"

    How a stored feature block must relate to the queried range to be included.

    'intersects' — blocks straddling the boundary are included, clipped to the range. 'fullyContained' yields only blocks entirely inside it.

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

    The features the iteration resolves and visits.

    all features
    

    Two effects, both wins for a caller that does not need everything:

    • The iterator only materializes the requested features' state onto the context — an excluded feature is never even looked up.
    • Cells that exist only through an excluded feature are not visited at all. A fill-only cell does not appear in a features scan that excludes Fill — the render path that only paints content stops receiving cells with nothing to paint.

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

    ignoreHidden?: boolean | Axis

    When scanning skip cells that are hidden via headers.

    false
    

    Optionally a header axis for skipping case be passed in. An example of this is for sorting where the sort direction (row) skips hidden rows but the column direction does not.

    reverse?: boolean

    Iterate in reverse order.

    false