Class Range

A structure containing a range of cells.

class

Range

Index

Constructor methods

Properties

Methods

Constructor methods

constructor(fromRow: number, fromCell: number, toRow?: number, toCell?: number): Range

A structure containing a range of cells.

constructor

Parameters

  • fromRow: number

    Starting row.

  • fromCell: number

    Starting cell.

  • toRow?: number optional

    Optional. Ending row. Defaults to fromRow.

  • toCell?: number optional

    Optional. Ending cell. Defaults to fromCell.

Returns

Range

Properties

public fromCell: number

property

fromCell

type

{Integer}

public fromRow: number

property

fromRow

type

{Integer}

public toCell: number

property

toCell

type

{Integer}

public toRow: number

property

toRow

type

{Integer}

Methods

public contains(row: number, cell: number): boolean

Returns whether a range contains a given cell.

method

contains

Parameters

  • row: number
  • cell: number

Returns

boolean

public isSingleCell(): boolean

Returns whether a range represents a single cell.

method

isSingleCell

Returns

boolean

public isSingleRow(): boolean

Returns whether a range represents a single row.

method

isSingleRow

Returns

boolean

public toString(): string

Returns a readable representation of a range.

method

toString

Returns

string