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

    Interface ICellRegion

    One member of an ICellRegions partition: a rectangle whose cells agree on every feature the call requested.

    A region answers where. It carries geometry — the facts that are true of it no matter which features produced it — and two bridges to the objects that answer everything else: getCell and getRange.

    It is deliberately NOT an ICellRange. A range's reads are honest about a range; on a region they would be honest only for the features that were requested, and the type cannot see that list. So the hop is explicit: you ask for a range, and then you read. The anchor cell's read is the region's payload — getCell() is the short way to say that.

    interface ICellRegion {
        isICellRegion: true;
        getAddress(r1c1?: boolean): string;
        getCell(): ICell;
        getColumnCount(): number;
        getCoords(): Readonly<IRange.Coords>;
        getFeatures(): readonly ICellRange.Feature[];
        getRange(): ICellRange;
        getRowCount(): number;
        isClipped(): boolean;
        toString(): string;
    }
    Index
    isICellRegion: true

    For runtime type checking.

    • Returns the coords as a string address (e.g., 'A1' or 'A1:E5').

      Parameters

      • Optionalr1c1: boolean

        If unspecified returns the environment's default.

      Returns string

    • The region's anchor (top-left) cell — the read that IS the region's payload.

      Returns ICell

      A region is uniform in the requested features, so the anchor's read describes every cell in it: the fill of a Fill region, the authored formula of a Formula region. It says nothing about features that were not requested — for those, the anchor is just a cell.

      Unlike ICellRange.getCell this takes no address: reading into the block is a range question, so it goes through getRange.

    • Returns the number of columns of the range.

      Returns number

    • The IRange.Coords.

      Returns Readonly<IRange.Coords>

    • The region as a readable range — the one explicit hop from where to what.

      Returns ICellRange

    • Returns the number of rows of the range.

      Returns number

    • Whether this region was cut short by the query extent — the block continues past the range that was partitioned.

      Returns boolean

      The default containment: 'intersects' includes straddling blocks clipped to the queried range, which is the right default: 'fullyContained' would answer a constrained query with silence whenever the block is bigger than the constraint, and silence reads as "no data here". The cost of that default is that a member's address can be an artifact of the query boundary, and every fact derived from it — a row count, a profile, a stats read — then describes a fragment while presenting as a block. This is the flag that makes the clip visible instead of silent.

      false for 'fullyContained' partitions by construction, and for any region whose edges sit inside the extent.

      Exact for ICellRange.Feature.Contentful, whose blocks are occupancy and therefore continue or do not. For a payload-identity feature (Fill, Formula) it answers the feature continues past this edge — the neighbouring block may carry a different color or a different authored formula and so be a genuinely separate region. Conservative in that direction on purpose: a spurious "check the edge" costs a glance, a missed clip costs a wrong answer.

    • Returns the address as a string.

      Returns string