Ace API - range

This object is used in various places to indicate a region within the editor. To better visualize how this works, imagine a rectangle. Each quadrant of the rectangle is analogus to a range, as ranges contain a starting row and starting column, and an ending row, and ending column.

- new Range(Number startRow, Number startColumn, Number endRow, Number endColumn)

Creates a new Range object with the given starting and ending row and column points. ...

Creates a new Range object with the given starting and ending row and column points.

Arguments

startRow	Number	Required. The starting row
startColumn	Number	Required. The starting column
endRow	Number	Required. The ending row
endColumn	Number	Required. The ending column

- Range.clipRows(Number firstRow, Number lastRow)
- - Range

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

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

Arguments

firstRow	Number	Required. The starting row
lastRow	Number	Required. The ending row

- Range.clone()
- - Range

Returns a duplicate of the calling range. ...

Returns a duplicate of the calling range.

- Range.collapseRows()
- - Range

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

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

- Range.compare(Number row, Number column)
- - Number

Checks the row and column points with the row and column points of the calling range. ...

Checks the row and column points with the row and column points of the calling range.

Arguments

row	Number	Required. A row point to compare with
column	Number	Required. A column point to compare with

Returns

Number	This method returns one of the following numbers: `0` if the two points are exactly equal `-1` if `p.row` is less then the calling range `1` if `p.row` is greater than the calling range If the starting row of the calling range is equal to `p.row`, and: `p.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 `p.row`, and: `p.column` is less than or equal to the calling range's ending column, this returns `0` Otherwise, it returns 1

- Range.compareEnd(Number row, Number column)
- - Number

Checks the row and column points with the row and column points of the calling range. ...

Checks the row and column points with the row and column points of the calling range.

Arguments

row	Number	Required. A row point to compare with
column	Number	Required. A column point to compare with

Returns

Number	This method returns one of the following numbers: `0` if the two points are exactly equal `-1` if `p.row` is less then the calling range `1` if `p.row` is greater than the calling range, or if `isEnd` is `true.<br/> <br/> If the starting row of the calling range is equal to` p.row`, and:<br/>` p.column `is greater than or equal to the calling range's starting column, this returns` 0`<br/> Otherwise, it returns -1<br/> <br/> If the ending row of the calling range is equal to` p.row`, and:<br/>` p.column `is less than or equal to the calling range's ending column, this returns` 0` Otherwise, it returns 1

- Range.compareInside(Number row, Number column)
- - Number

Checks the row and column points with the row and column points of the calling range. ...

Checks the row and column points with the row and column points of the calling range.

Arguments

row	Number	Required. A row point to compare with
column	Number	Required. A column point 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 compare.

- Range.comparePoint(Range p)
- - Number
- Related to Range.compare

Checks the row and column points of p with the row and column points of the calling range. ...

Checks the row and column points of p with the row and column points of the calling range.

Arguments

p	Range	Required. A point to compare with

Returns

Number	This method returns one of the following numbers: `0` if the two points are exactly equal `-1` if `p.row` is less then the calling range `1` if `p.row` is greater than the calling range If the starting row of the calling range is equal to `p.row`, and: `p.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 `p.row`, and: `p.column` is less than or equal to the calling range's ending column, this returns `0` Otherwise, it returns 1

- Range.compareRange(Range range)
- - Number
- Related to Range.compare

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

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

Arguments

range	Range	Required. 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) OR (A) is completely inside of (B) `+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)

- Range.compareStart(Number row, Number column)
- - Number

Checks the row and column points with the row and column points of the calling range. ...

Checks the row and column points with the row and column points of the calling range.

Arguments

row	Number	Required. A row point to compare with
column	Number	Required. A column point to compare with

Returns

Number	This method returns one of the following numbers: `0` if the two points are exactly equal `-1` if `p.row` is less then the calling range `1` if `p.row` is greater than the calling range, or if `isStart` is `true`. If the starting row of the calling range is equal to `p.row`, and: `p.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 `p.row`, and: `p.column` is less than or equal to the calling range's ending column, this returns `0` Otherwise, it returns 1

- Range.contains(Number row, Number column)
- - Boolean
- Related to Range.compare

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

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

Arguments

row	Number	Required. A row to check for
column	Number	Required. A column to check for

- Range.containsRange(Range range)
- - Boolean
- Related to Range.comparePoint

Checks the start and end points of range and compares them to the calling range. Returns true if the range is ...

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

Arguments

range	Range	Required. A range to compare with

- Range.extend(Number row, Number column)
- - Range

Changes the row and column points for the calling range for both the starting and ending points. This method returns...

Changes the row and column points for the calling range for both the starting and ending points. This method returns that range with a new row.

Arguments

row	Number	Required. A new row to extend to
column	Number	Required. A new column to extend to

- Range.fromPoints(Range start, Range end)
- - Range

Creates and returns a new Range based on the row and column of the given parameters. ...

Creates and returns a new Range based on the row and column of the given parameters.

Arguments

start	Range	Required. A starting point to use
end	Range	Required. An ending point to use

- Range.inside(Number row, Number column)
- - Boolean
- Related to Range.compare

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

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

Arguments

row	Number	Required. A row point to compare with
column	Number	Required. A column point to compare with

- Range.insideEnd(Number row, Number column)
- - Boolean
- Related to Range.compare

Returns true if the row and column are within the given range's ending points. ...

Returns true if the row and column are within the given range's ending points.

Arguments

row	Number	Required. A row point to compare with
column	Number	Required. A column point to compare with

- Range.insideStart(Number row, Number column)
- - Boolean
- Related to Range.compare

Returns true if the row and column are within the given range's starting points. ...

Returns true if the row and column are within the given range's starting points.

Arguments

row	Number	Required. A row point to compare with
column	Number	Required. A column point to compare with

- Range.intersects(Range range)
- - Boolean

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

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

Arguments

range	Range	Required. A range to compare with

- Range.isEnd(Number row, Number column)
- - Boolean

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

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

Arguments

row	Number	Required. A row point to compare with
column	Number	Required. A column point to compare with

- Range.isEqual(Range range)
- - Boolean

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

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

Arguments

range	Range	Required. A range to check against

- Range.isMultiLine()
- - Boolean

Returns true if the range spans across multiple lines. ...

Returns true if the range spans across multiple lines.

- Range.isStart(Number row, Number column)
- - Boolean

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

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

Arguments

row	Number	Required. A row point to compare with
column	Number	Required. A column point to compare with

- Range.setEnd(Number row, Number column)

Sets the starting row and column for the range. ...

Sets the starting row and column for the range.

Arguments

row	Number	Required. A row point to set
column	Number	Required. A column point to set

- Range.setStart(Number row, Number column)

Sets the starting row and column for the range. ...

Sets the starting row and column for the range.

Arguments

row	Number	Required. A row point to set
column	Number	Required. A column point to set

- Range.toScreenRange(EditSession session)
- - Range

Given the current Range, this function converts those starting and ending points into screen positions, and then r...

Given the current Range, this function converts those starting and ending points into screen positions, and then returns a new Range object.

Arguments

session	EditSession	Required. The `EditSession` to retrieve coordinates from

- Range.toString()
- - String

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

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

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

Ace Reference

Range[edit]

Constructors

Arguments

Methods

Arguments

Arguments

Returns

Arguments

Returns

Arguments

Returns

Arguments

Returns

Arguments

Returns

Arguments

Returns

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments

Arguments