Options
All
  • Public
  • Public/Protected
  • All
Menu

Class 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.

Hierarchy

索引

Constructors

Properties

Methods

Constructors

constructor

  • new Range(start: Position, end: Position): Range
  • new Range(startLine: number, startCharacter: number, endLine: number, endCharacter: number): Range

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

    Parameters

    Returns Range

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

    Parameters

    • startLine: number

      A zero-based line value.

    • startCharacter: number

      A zero-based character value.

    • endLine: number

      A zero-based line value.

    • endCharacter: number

      A zero-based character value.

    Returns Range

Properties

Readonly start

start: Position

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

Readonly end

end: Position

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

isEmpty

isEmpty: boolean

true if start and end are equal.

isSingleLine

isSingleLine: boolean

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

Methods

contains

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

    Parameters

    Returns boolean

    true if the position or range is inside or equal to this range.

isEqual

  • isEqual(other: Range): boolean

  • Check if other equals this range.

    Parameters

    Returns boolean

    true when start and end are equal to start and end of this range.

intersection

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

    Parameters

    Returns undefined | Range

    A range of the greater start and smaller end positions. Will return undefined when there is no overlap.

union

  • Compute the union of other with this range.

    Parameters

    Returns Range

    A range of smaller start position and the greater end position.

with

  • Derived a new range from this range.

    Parameters

    • Optional start: Position

      A position that should be used as start. The default value is the current start.

    • Optional end: Position

      A position that should be used as end. The default value is the current end.

    Returns Range

    A range derived from this range with the given start and end position. If start and end are not different this range will be returned.

  • Derived a new range from this range.

    Parameters

    Returns Range

    A range that reflects the given change. Will return this range if the change is not changing anything.

Generated by TypeDoc