Range

A range represents an ordered pair of two positions. It is guaranteed that start.isBeforeOrEqual(end)

Range objects are immutable. Use the with, intersection, or union methods to derive new ranges from an existing range.

Online Documentation

Inheritors

Selection

Constructors

Range

constructor(start: Position, end: Position)

Create a new range from two positions. If start is not before or equal to end, the values will be swapped.

constructor(startLine: Int, startCharacter: Int, endLine: Int, endCharacter: Int)

Create a new range from number coordinates. It is a shorter equivalent of using new Range(new Position(startLine, startCharacter), new Position(endLine, endCharacter))

Types

WithChange

interface WithChange

Properties

end

val end: Position

The end position. It is after or equal to start.

isEmpty

var isEmpty: Boolean

true if start and end are equal.

isSingleLine

var isSingleLine: Boolean

true if start.line and end.line are equal.

start

val start: Position

The start position. It is before or equal to end.

Functions

contains

fun contains(positionOrRange: Position): Boolean

Check if a position or a range is contained in this range.

fun contains(positionOrRange: Range): Boolean

intersection

fun intersection(range: Range): Range?

Intersect range with this range and returns a new range or undefined if the ranges have no overlap.

isEqual

fun isEqual(other: Range): Boolean

Check if other equals this range.

union

fun union(other: Range): Range

Compute the union of other with this range.

with

fun with(change: Range.WithChange): Range

fun with(start: Position = definedExternally, end: Position = definedExternally): Range

Derived a new range from this range.