Class Range

A structure containing a range of cells. Range

Param: fromRow

{Integer} Starting row.

Param: fromCell

{Integer} Starting cell.

Param: toRow

{Integer} Optional. Ending row. Defaults to fromRow.

Param: toCell

{Integer} Optional. Ending cell. Defaults to fromCell.

Constructors

constructor

Properties

contains fromCell fromRow isSingleCell isSingleRow toCell toRow toString

Constructors

constructor

  • new Range(
        fromRow: Integer,
        fromCell: Integer,
        toRow: Integer,
        toCell: Integer,
    ): Range

  • A structure containing a range of cells. Range

    Parameters

    • fromRow: Integer

      {Integer} Starting row.

    • fromCell: Integer

      {Integer} Starting cell.

    • toRow: Integer

      {Integer} Optional. Ending row. Defaults to fromRow.

    • toCell: Integer

      {Integer} Optional. Ending cell. Defaults to fromCell.

    Returns Range

Properties

contains

contains: (row: Integer, cell: Integer) => boolean

Returns whether a range contains a given cell.

Type declaration

    • (row: Integer, cell: Integer): boolean

    • Parameters

      • row: Integer

        {Integer}

      • cell: Integer

        {Integer}

      Returns boolean

fromCell

fromCell: Integer

fromRow

fromRow: Integer

isSingleCell

isSingleCell: () => boolean

Returns whether a range represents a single cell.

Type declaration

    • (): boolean

    • Returns boolean

isSingleRow

isSingleRow: () => boolean

Returns whether a range represents a single row.

Type declaration

    • (): boolean

    • Returns boolean

toCell

toCell: Integer

toRow

toRow: Integer

toString

toString: () => string

Returns a readable representation of a range.

Type declaration

    • (): string

    • Returns string

Settings

Member Visibility

On This Page

Constructors
Properties