Class Range

A range in the editor. (startLineNumber,startColumn) is <= (endLineNumber,endColumn)

Hierarchy

Range
- Selection

Constructors

constructor

new Range(startLineNumber: number, startColumn: number, endLineNumber: number, endColumn: number): Range

- Defined in website/typedoc/monaco.d.ts:622
Parameters
- startLineNumber: number
- startColumn: number
- endLineNumber: number
- endColumn: number
Returns Range

Properties

Readonly endColumn

endColumn: number

Column on which the range ends in line endLineNumber.

Readonly endLineNumber

endLineNumber: number

Line number on which the range ends.

Readonly startColumn

startColumn: number

Column on which the range starts in line startLineNumber (starts at 1).

Readonly startLineNumber

startLineNumber: number

Line number on which the range starts (starts at 1).

Methods

collapseToEnd

collapseToEnd(): Range

- Defined in website/typedoc/monaco.d.ts:720
Create a new empty range using this range's end position.

Returns Range

collapseToStart

collapseToStart(): Range

- Defined in website/typedoc/monaco.d.ts:712
Create a new empty range using this range's start position.

Returns Range

containsPosition

containsPosition(position: IPosition): boolean

- Defined in website/typedoc/monaco.d.ts:634
Test if position is in this range. If the position is at the edges, will return true.

Parameters
- position: IPosition
Returns boolean

containsRange

containsRange(range: IRange): boolean

- Defined in website/typedoc/monaco.d.ts:642
Test if range is in this range. If the range is equal to this range, will return true.

Parameters
- range: IRange
Returns boolean

delta

delta(lineCount: number): Range

- Defined in website/typedoc/monaco.d.ts:728
Moves the range by the given amount of lines.

Parameters
- lineCount: number
Returns Range

equalsRange

equalsRange(other: IRange): boolean

- Defined in website/typedoc/monaco.d.ts:676
Test if this range equals other.

Parameters
- other: IRange
Returns boolean

getEndPosition

getEndPosition(): Position

- Defined in website/typedoc/monaco.d.ts:684
Return the end position (which will be after or equal to the start position)

Returns Position

getStartPosition

getStartPosition(): Position

- Defined in website/typedoc/monaco.d.ts:692
Return the start position (which will be before or equal to the end position)

Returns Position

intersectRanges

intersectRanges(range: IRange): Range

- Defined in website/typedoc/monaco.d.ts:668
A intersection of the two ranges.

Parameters
- range: IRange
Returns Range

isEmpty

isEmpty(): boolean

- Defined in website/typedoc/monaco.d.ts:626
Test if this range is empty.

Returns boolean

plusRange

plusRange(range: IRange): Range

- Defined in website/typedoc/monaco.d.ts:659
A reunion of the two ranges. The smallest position will be used as the start point, and the largest one as the end point.

Parameters
- range: IRange
Returns Range

setEndPosition

setEndPosition(endLineNumber: number, endColumn: number): Range

- Defined in website/typedoc/monaco.d.ts:704
Create a new range using this range's start position, and using endLineNumber and endColumn as the end position.

Parameters
- endLineNumber: number
- endColumn: number
Returns Range

setStartPosition

setStartPosition(startLineNumber: number, startColumn: number): Range

- Defined in website/typedoc/monaco.d.ts:708
Create a new range using this range's end position, and using startLineNumber and startColumn as the start position.

Parameters
- startLineNumber: number
- startColumn: number
Returns Range

strictContainsRange

strictContainsRange(range: IRange): boolean

- Defined in website/typedoc/monaco.d.ts:650
Test if range is strictly in this range. range must start after and end before this range for the result to be true.

Parameters
- range: IRange
Returns boolean

toJSON

toJSON(): IRange

- Defined in website/typedoc/monaco.d.ts:762
Returns IRange

toString

toString(): string

- Defined in website/typedoc/monaco.d.ts:700
Transform to a user presentable string representation.

Returns string

Static areIntersecting

areIntersecting(a: IRange, b: IRange): boolean

- Defined in website/typedoc/monaco.d.ts:747
Test if the two ranges are intersecting. If the ranges are touching it returns true.

Parameters
- a: IRange
- b: IRange
Returns boolean

Static areIntersectingOrTouching

areIntersectingOrTouching(a: IRange, b: IRange): boolean

- Defined in website/typedoc/monaco.d.ts:743
Test if the two ranges are touching in any way.

Parameters
- a: IRange
- b: IRange
Returns boolean

Static collapseToEnd

collapseToEnd(range: IRange): Range

- Defined in website/typedoc/monaco.d.ts:724
Create a new empty range using this range's end position.

Parameters
- range: IRange
Returns Range

Static collapseToStart

collapseToStart(range: IRange): Range

- Defined in website/typedoc/monaco.d.ts:716
Create a new empty range using this range's start position.

Parameters
- range: IRange
Returns Range

Static compareRangesUsingEnds

compareRangesUsingEnds(a: IRange, b: IRange): number

- Defined in website/typedoc/monaco.d.ts:757
A function that compares ranges, useful for sorting ranges It will first compare ranges on the endPosition and then on the startPosition

Parameters
- a: IRange
- b: IRange
Returns number

Static compareRangesUsingStarts

compareRangesUsingStarts(a: IRange, b: IRange): number

- Defined in website/typedoc/monaco.d.ts:752
A function that compares ranges, useful for sorting ranges It will first compare ranges on the startPosition and then on the endPosition

Parameters
- a: IRange
- b: IRange
Returns number

Static containsPosition

containsPosition(range: IRange, position: IPosition): boolean

- Defined in website/typedoc/monaco.d.ts:638
Test if position is in range. If the position is at the edges, will return true.

Parameters
- range: IRange
- position: IPosition
Returns boolean

Static containsRange

containsRange(range: IRange, otherRange: IRange): boolean

- Defined in website/typedoc/monaco.d.ts:646
Test if otherRange is in range. If the ranges are equal, will return true.

Parameters
- range: IRange
- otherRange: IRange
Returns boolean

Static equalsRange

equalsRange(a: IRange, b: IRange): boolean

- Defined in website/typedoc/monaco.d.ts:680
Test if range a equals b.

Parameters
- a: IRange
- b: IRange
Returns boolean

Static fromPositions

fromPositions(start: IPosition, end?: IPosition): Range

- Defined in website/typedoc/monaco.d.ts:729
Parameters
- start: IPosition
- Optional end: IPosition
Returns Range

Static getEndPosition

getEndPosition(range: IRange): Position

- Defined in website/typedoc/monaco.d.ts:688
Return the end position (which will be after or equal to the start position)

Parameters
- range: IRange
Returns Position

Static getStartPosition

getStartPosition(range: IRange): Position

- Defined in website/typedoc/monaco.d.ts:696
Return the start position (which will be before or equal to the end position)

Parameters
- range: IRange
Returns Position

Static intersectRanges

intersectRanges(a: IRange, b: IRange): Range

- Defined in website/typedoc/monaco.d.ts:672
A intersection of the two ranges.

Parameters
- a: IRange
- b: IRange
Returns Range

Static isEmpty

isEmpty(range: IRange): boolean

- Defined in website/typedoc/monaco.d.ts:630
Test if range is empty.

Parameters
- range: IRange
Returns boolean

Static isIRange

isIRange(obj: any): obj is IRange

- Defined in website/typedoc/monaco.d.ts:739
Test if obj is an IRange.

Parameters
- obj: any
Returns obj is IRange

Static lift

lift(range: null): null
lift(range: IRange): Range
lift(range: IRange): Range

- Defined in website/typedoc/monaco.d.ts:733
Create a Range from an IRange.

Parameters
- range: null
Returns null
- Defined in website/typedoc/monaco.d.ts:734
Parameters
- range: IRange
Returns Range
- Defined in website/typedoc/monaco.d.ts:735
Parameters
- range: IRange
Returns Range

Static plusRange

plusRange(a: IRange, b: IRange): Range

- Defined in website/typedoc/monaco.d.ts:664
A reunion of the two ranges. The smallest position will be used as the start point, and the largest one as the end point.

Parameters
- a: IRange
- b: IRange
Returns Range

Static spansMultipleLines

spansMultipleLines(range: IRange): boolean

- Defined in website/typedoc/monaco.d.ts:761
Test if the range spans multiple lines.

Parameters
- range: IRange
Returns boolean

Static strictContainsRange

strictContainsRange(range: IRange, otherRange: IRange): boolean

- Defined in website/typedoc/monaco.d.ts:654
Test if otherRange is strictly in range (must start after, and end before). If the ranges are equal, will return false.

Parameters
- range: IRange
- otherRange: IRange
Returns boolean