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

    Interface ICellRanged<P, U>

    Represents an interface for ranged items with customizable properties, supporting operations such as retrieving properties at a given coordinate, cloning with updates, splitting, and merging.

    The type representing the JSON-serializable representation of the range.

    interface ICellRanged<P, U = IProperties.ResolvableProperties<P>> {
        cloneWithUpdate?(updates: U): this;
        getCoords(): Readonly<IRange.Coords>;
        getPropertiesAt(
            rowIndex: number,
            colIndex: number,
            value: Scalar,
        ): Readonly<P>;
    }

    Type Parameters

    • P

      The type representing the properties associated with the range.

    • U = IProperties.ResolvableProperties<P>

      The type accepted by updates. This need not be P widened - a property bag may accept convenience keys that are folded onto canonical ones and never appear in P (see IStyledFont.Modifiers). Defaults to IProperties.ResolvableProperties of P.

    Hierarchy (View Summary)

    Index
    cloneWithUpdate? getCoords getPropertiesAt

    • Creates a new instance of the range with specified updates applied.

      Parameters

      • updates: U

        The updates to apply to the range's properties.

      Returns this

      A new ICellRanged instance with the applied updates.

    • Retrieves the coordinates for the range.

      Returns Readonly<IRange.Coords>

      The range's coordinates.

      The coordinates are not the coordinates where this is contained but the coordinates for access getPropertiesAt.

    • Retrieves the properties associated with a specified cell within the range.

      Parameters

      • rowIndex: number

        The row index within the range.

      • colIndex: number

        The column index within the range.

      • value: Scalar

        The value at the coordinates.

      Returns Readonly<P>

      The properties associated with the specified cell as a read-only object.

    Settings
    Member Visibility

    On This Page
    Methods