Class Range

constructor

• new Range(startRow?, startColumn?, endRow?, endColumn?): Range

• Creates a new Range object with the given starting and ending rows and columns.

  Parameters

  • Optional startRow: number

    The starting row

  • Optional startColumn: number

    The starting column

  • Optional endRow: number

    The ending row

  • Optional endColumn: number

    The ending column

  Returns Range

Optional cursor

end

Optional id

Optional isBackwards

start

clipRows

• clipRows(firstRow, lastRow): Range

• Returns the part of the current Range that occurs within the boundaries of firstRow and lastRow as a new Range object.

  Parameters

  • firstRow: number

    The starting row

  • lastRow: number

    The ending row

  Returns Range

clone

• clone(): Range

• Returns a duplicate of the calling range.

  Returns Range

collapseRows

• collapseRows(): Range

• Returns a range containing the starting and ending rows of the original range, but with a column value of 0.

  Returns Range

compare

• compare(row, column): number

• Compares the row and column with the starting and ending [[Point]]'s of the calling range.

  Parameters

  • row: number

    A row to compare with

  • column: number

    A column to compare with

  Returns number

  This method returns one of the following numbers:

  • 1 if row is greater than the calling range
  • -1 if row is less then the calling range
  • 0 otherwise

  If the starting row of the calling range is equal to row, and:

  • column is greater than or equal to the calling range's starting column, this returns 0
  • Otherwise, it returns -1

  If the ending row of the calling range is equal to row, and:

  • column is less than or equal to the calling range's ending column, this returns 0
  • Otherwise, it returns 1

compareEnd

• compareEnd(row, column): number

• Compares the row and column with the starting and ending [[Point]]'s of the calling range.

  Parameters

  • row: number

    A row to compare with

  • column: number

    A column to compare with

  Returns number

  This method returns one of the following numbers:

  • 1 if calling range's ending column and calling range's ending row are equal row and column.
  • Otherwise, it returns the value after calling [[Range.compare compare()]].

compareInside

• compareInside(row, column): number

• Compares the row and column with the start and end [[Point]]'s of the calling range.

  Parameters

  • row: number

    A row to compare with

  • column: number

    A column to compare with

  Returns number

  This method returns one of the following numbers:

  • 1 if the ending row of the calling range is equal to row, and the ending column of the calling range is equal to column
  • -1 if the starting row of the calling range is equal to row, and the starting column of the calling range is equal to column
  • Otherwise, it returns the value after calling [[Range.compare compare()]].

comparePoint

• comparePoint(p): number

• Compares the row and column of p with the starting and ending [[Point]]'s of the calling range (by calling [[Range.compare]]).

  Parameters

  • p: Ace.Point

    A point to compare with

  Returns number

  Related

  [[Range.compare]]

compareRange

• compareRange(range): number

• Compares this range (A) with another range (B).

  Parameters

  • range: Ace.IRange

    A range to compare with

  Returns number

  This method returns one of the following numbers:

  • -2: (B) is in front of (A), and doesn't intersect with (A)
  • -1: (B) begins before (A) but ends inside of (A)
  • 0: (B) is completely inside of (A)
  • +1: (B) begins inside of (A) but ends outside of (A)
  • +2: (B) is after (A) and doesn't intersect with (A)
  • 42: FTW state: (B) ends in (A) but starts outside of (A)

  Related

  [[Range.compare]]

compareStart

• compareStart(row, column): number

• Compares the row and column with the starting and ending [[Point]]'s of the calling range.

  Parameters

  • row: number

    A row to compare with

  • column: number

    A column to compare with

  Returns number

  This method returns one of the following numbers:

  • -1 if calling range's starting column and calling range's starting row are equal row and column
  • Otherwise, it returns the value after calling [[Range.compare compare()]].

contains

• contains(row, column): boolean

• Returns true if the row and column provided are within the given range. This can better be expressed as returning true if:

     this.start.row <= row <= this.end.row &&
     this.start.column <= column <= this.end.column
  Copy

  Parameters

  • row: number

    A row to check for

  • column: number

    A column to check for

  Returns boolean

  Related

  [[Range.compare]]

containsRange

• containsRange(range): boolean

• Checks the start and end [[Point]]'s of range and compares them to the calling range. Returns true if the range is contained within the caller's range.

  Parameters

  • range: Ace.IRange

    A range to compare with

  Returns boolean

  Related

  [[Range.comparePoint]]

extend

• extend(row, column): Range

• Changes the row and column for the calling range for both the starting and ending [[Point]]'s.

  Parameters

  • row: number

    A new row to extend to

  • column: number

    A new column to extend to

  Returns Range

  The original range with the new row

inside

• inside(row, column): boolean

• Returns true if the row and column are within the given range.

  Parameters

  • row: number

    A row to compare with

  • column: number

    A column to compare with

  Returns boolean

  Related

  [[Range.compare]]

insideEnd

• insideEnd(row, column): boolean

• Returns true if the row and column are within the given range's ending [[Point]].

  Parameters

  • row: number

    A row to compare with

  • column: number

    A column to compare with

  Returns boolean

  Related

  [[Range.compare]]

insideStart

• insideStart(row, column): boolean

• Returns true if the row and column are within the given range's starting [[Point]].

  Parameters

  • row: number

    A row to compare with

  • column: number

    A column to compare with

  Returns boolean

  Related

  [[Range.compare]]

intersects

• intersects(range): boolean

• Returns true if passed in range intersects with the one calling this method.

  Parameters

  • range: Ace.IRange

    A range to compare with

  Returns boolean

isEmpty

• isEmpty(): boolean

• Returns true if the calling range is empty (starting [[Point]] == ending [[Point]]).

  Returns boolean

isEnd

• isEnd(row, column): boolean

• Returns true if the caller's ending row is the same as row, and if the caller's ending column is the same as column.

  Parameters

  • row: number

    A row to compare with

  • column: number

    A column to compare with

  Returns boolean

isEqual

• isEqual(range): boolean

• Returns true if and only if the starting row and column, and ending row and column, are equivalent to those given by range.

  Parameters

  • range: Ace.IRange

    A range to check against

  Returns boolean

isMultiLine

• isMultiLine(): boolean

• Returns true if the range spans across multiple lines.

  Returns boolean

isStart

• isStart(row, column): boolean

• Returns true if the caller's starting row is the same as row, and if the caller's starting column is the same as column.

  Parameters

  • row: number

    A row to compare with

  • column: number

    A column to compare with

  Returns boolean

moveBy

• moveBy(row, column): void
• Experimental

  Shift the calling range by row and column values.

  Parameters

  • row: number

  • column: number

  Returns void

setEnd

• setEnd(row, column?): void

• Sets the starting row and column for the range.

  Parameters

  • row: number | Ace.Point

    A row to set

  • Optional column: number

    A column to set

  Returns void

setStart

• setStart(row, column?): void

• Sets the starting row and column for the range.

  Parameters

  • row: number | Ace.Point

    A row to set

  • Optional column: number

    A column to set

  Returns void

toScreenRange

• toScreenRange(session): Range

• Given the current Range, this function converts those starting and ending [[Point]]'s into screen positions, and then returns a new Range object.

  Parameters

  • session: EditSession

    The EditSession to retrieve coordinates from

  Returns Range

toString

• toString(): string

• Returns a string containing the range's row and column information, given like this:

     [start.row/start.column] -> [end.row/end.column]
  Copy

  Returns string