Selection | Monaco Editor API v0.19.0

A selection in the editor. The selection is a range that has an orientation.

Hierarchy

Range
- Selection

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Selection(selectionStartLineNumber: number, selectionStartColumn: number, positionLineNumber: number, positionColumn: number): Selection

Overwrites Range.constructor
- Defined in monaco.d.ts:732
Parameters
- selectionStartLineNumber: number
- selectionStartColumn: number
- positionLineNumber: number
- positionColumn: number
Returns Selection

Properties

endColumn

endColumn: number

Column on which the range ends in line endLineNumber.

endLineNumber

endLineNumber: number

Line number on which the range ends.

positionColumn

positionColumn: number

The column on positionLineNumber where the selection has ended.

positionLineNumber

positionLineNumber: number

The line number on which the selection has ended.

selectionStartColumn

selectionStartColumn: number

The column on selectionStartLineNumber where the selection has started.

selectionStartLineNumber

selectionStartLineNumber: number

The line number on which the selection has started.

startColumn

startColumn: number

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

startLineNumber

startLineNumber: number

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

Methods

collapseToStart

collapseToStart(): Range

Inherited from Range.collapseToStart
- Defined in monaco.d.ts:650
Create a new empty range using this range's start position.

Returns Range

containsPosition

containsPosition(position: IPosition): boolean

Inherited from Range.containsPosition
- Defined in monaco.d.ts:580
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

Inherited from Range.containsRange
- Defined in monaco.d.ts:588
Test if range is in this range. If the range is equal to this range, will return true.

Parameters
- range: IRange
Returns boolean

equalsRange

equalsRange(other: IRange | null): boolean

Inherited from Range.equalsRange
- Defined in monaco.d.ts:622
Test if this range equals other.

Parameters
- other: IRange | null
Returns boolean

equalsSelection

equalsSelection(other: ISelection): boolean

- Defined in monaco.d.ts:741
Test if equals other selection.

Parameters
- other: ISelection
Returns boolean

getDirection

getDirection(): SelectionDirection

- Defined in monaco.d.ts:749
Get directions (LTR or RTL).

Returns SelectionDirection

getEndPosition

getEndPosition(): Position

Inherited from Range.getEndPosition
- Defined in monaco.d.ts:630
Return the end position (which will be after or equal to the start position)

Returns Position

getPosition

getPosition(): Position

- Defined in monaco.d.ts:757
Get the position at positionLineNumber and positionColumn.

Returns Position

getStartPosition

getStartPosition(): Position

Inherited from Range.getStartPosition
- Defined in monaco.d.ts:634
Return the start position (which will be before or equal to the end position)

Returns Position

intersectRanges

intersectRanges(range: IRange): Range | null

Inherited from Range.intersectRanges
- Defined in monaco.d.ts:614
A intersection of the two ranges.

Parameters
- range: IRange
Returns Range | null

isEmpty

isEmpty(): boolean

Inherited from Range.isEmpty
- Defined in monaco.d.ts:572
Test if this range is empty.

Returns boolean

plusRange

plusRange(range: IRange): Range

Inherited from Range.plusRange
- Defined in monaco.d.ts:605
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): Selection

Overwrites Range.setEndPosition
- Defined in monaco.d.ts:753
Create a new selection with a different positionLineNumber and positionColumn.

Parameters
- endLineNumber: number
- endColumn: number
Returns Selection

setStartPosition

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

Overwrites Range.setStartPosition
- Defined in monaco.d.ts:761
Create a new selection with a different selectionStartLineNumber and selectionStartColumn.

Parameters
- startLineNumber: number
- startColumn: number
Returns Selection

strictContainsRange

strictContainsRange(range: IRange): boolean

Inherited from Range.strictContainsRange
- Defined in monaco.d.ts:596
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

toString

toString(): string

Overwrites Range.toString
- Defined in monaco.d.ts:737
Transform to a human-readable representation.

Returns string

Static areIntersecting

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

Inherited from Range.areIntersecting
- Defined in monaco.d.ts:672
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

Inherited from Range.areIntersectingOrTouching
- Defined in monaco.d.ts:668
Test if the two ranges are touching in any way.

Parameters
- a: IRange
- b: IRange
Returns boolean

Static collapseToStart

collapseToStart(range: IRange): Range

Inherited from Range.collapseToStart
- Defined in monaco.d.ts:654
Create a new empty range using this range's start position.

Parameters
- range: IRange
Returns Range

Static compareRangesUsingEnds

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

Inherited from Range.compareRangesUsingEnds
- Defined in monaco.d.ts:682
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 | null | undefined, b: IRange | null | undefined): number

Inherited from Range.compareRangesUsingStarts
- Defined in monaco.d.ts:677
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 | null | undefined
- b: IRange | null | undefined
Returns number

Static containsPosition

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

Inherited from Range.containsPosition
- Defined in monaco.d.ts:584
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

Inherited from Range.containsRange
- Defined in monaco.d.ts:592
Test if otherRange is in range. If the ranges are equal, will return true.

Parameters
- range: IRange
- otherRange: IRange
Returns boolean

Static createWithDirection

createWithDirection(startLineNumber: number, startColumn: number, endLineNumber: number, endColumn: number, direction: SelectionDirection): Selection

- Defined in monaco.d.ts:781
Create with a direction.

Parameters
- startLineNumber: number
- startColumn: number
- endLineNumber: number
- endColumn: number
- direction: SelectionDirection
Returns Selection

Static equalsRange

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

Inherited from Range.equalsRange
- Defined in monaco.d.ts:626
Test if range a equals b.

Parameters
- a: IRange | null
- b: IRange | null
Returns boolean

Static fromPositions

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

Overwrites Range.fromPositions
- Defined in monaco.d.ts:765
Create a Selection from one or two positions

Parameters
- start: IPosition
- Optional end: IPosition
Returns Selection

Static intersectRanges

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

Inherited from Range.intersectRanges
- Defined in monaco.d.ts:618
A intersection of the two ranges.

Parameters
- a: IRange
- b: IRange
Returns Range | null

Static isEmpty

isEmpty(range: IRange): boolean

Inherited from Range.isEmpty
- Defined in monaco.d.ts:576
Test if range is empty.

Parameters
- range: IRange
Returns boolean

Static isIRange

isIRange(obj: any): obj

Inherited from Range.isIRange
- Defined in monaco.d.ts:664
Test if obj is an IRange.

Parameters
- obj: any
Returns obj

Static isISelection

isISelection(obj: any): obj

- Defined in monaco.d.ts:777
Test if obj is an ISelection.

Parameters
- obj: any
Returns obj

Static lift

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

Inherited from Range.lift
- Defined in monaco.d.ts:659
Create a Range from an IRange.

Parameters
- range: undefined | null
Returns null
Inherited from Range.lift
- Defined in monaco.d.ts:660
Parameters
- range: IRange
Returns Range

Static liftSelection

liftSelection(sel: ISelection): Selection

- Defined in monaco.d.ts:769
Create a Selection from an ISelection.

Parameters
- sel: ISelection
Returns Selection

Static plusRange

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

Inherited from Range.plusRange
- Defined in monaco.d.ts:610
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 selectionsArrEqual

selectionsArrEqual(a: ISelection[], b: ISelection[]): boolean

- Defined in monaco.d.ts:773
a equals b.

Parameters
- a: ISelection[]
- b: ISelection[]
Returns boolean

Static selectionsEqual

selectionsEqual(a: ISelection, b: ISelection): boolean

- Defined in monaco.d.ts:745
Test if the two selections are equal.

Parameters
- a: ISelection
- b: ISelection
Returns boolean

Static spansMultipleLines

spansMultipleLines(range: IRange): boolean

Inherited from Range.spansMultipleLines
- Defined in monaco.d.ts:686
Test if the range spans multiple lines.

Parameters
- range: IRange
Returns boolean

Static strictContainsRange

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

Inherited from Range.strictContainsRange
- Defined in monaco.d.ts:600
Test if otherRange is strinctly in range (must start after, and end before). If the ranges are equal, will return false.

Parameters
- range: IRange
- otherRange: IRange
Returns boolean

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

selectionStartLineNumber: number

selectionStartColumn: number

positionLineNumber: number

positionColumn: number

Returns Selection

Properties

endColumn

endLineNumber

positionColumn

positionLineNumber

selectionStartColumn

selectionStartLineNumber

startColumn

startLineNumber

Methods

collapseToStart

Returns Range

containsPosition

Parameters

position: IPosition

Returns boolean

containsRange

Parameters

range: IRange

Returns boolean

equalsRange

Parameters

other: IRange | null

Returns boolean

equalsSelection

Parameters

other: ISelection

Returns boolean

getDirection

Returns SelectionDirection

getEndPosition

Returns Position

getPosition

Returns Position

getStartPosition

Returns Position

intersectRanges

Parameters

range: IRange

Returns Range | null

isEmpty

Returns boolean

plusRange

Parameters

range: IRange

Returns Range

setEndPosition

Parameters

endLineNumber: number

endColumn: number

Returns Selection

setStartPosition

Parameters

startLineNumber: number

startColumn: number

Returns Selection

strictContainsRange

Parameters

range: IRange

Returns boolean

toString

Returns string

Static areIntersecting

Parameters

a: IRange

b: IRange

Returns boolean