Class Selection

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

Hierarchy

Range
- Selection

Constructors

constructor

new Selection(selectionStartLineNumber: number, selectionStartColumn: number, positionLineNumber: number, positionColumn: number): Selection
Parameters
- selectionStartLineNumber: number
- selectionStartColumn: number
- positionLineNumber: number
- positionColumn: number
Returns Selection
Overrides Range.constructor
- Defined in editor.api.d.ts:799

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` positionColumn

positionColumn: number

The column on positionLineNumber where the selection has ended.

`Readonly` positionLineNumber

positionLineNumber: number

The line number on which the selection has ended.

`Readonly` selectionStartColumn

selectionStartColumn: number

The column on selectionStartLineNumber where the selection has started.

`Readonly` selectionStartLineNumber

selectionStartLineNumber: number

The line number on which the selection has started.

`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

collapseToStart

collapseToStart(): Range
Create a new empty range using this range's start position.

Returns Range
Inherited from Range.collapseToStart
- Defined in editor.api.d.ts:710

containsPosition

containsPosition(position: IPosition): boolean
Test if position is in this range. If the position is at the edges, will return true.
Parameters
- position: IPosition
Returns boolean
Inherited from Range.containsPosition
- Defined in editor.api.d.ts:632

containsRange

containsRange(range: IRange): boolean
Test if range is in this range. If the range is equal to this range, will return true.
Parameters
- range: IRange
Returns boolean
Inherited from Range.containsRange
- Defined in editor.api.d.ts:640

delta

delta(lineCount: number): Range
Moves the range by the given amount of lines.
Parameters
- lineCount: number
Returns Range
Inherited from Range.delta
- Defined in editor.api.d.ts:714

equalsRange

equalsRange(other: IRange): boolean
Test if this range equals other.
Parameters
- other: IRange
Returns boolean
Inherited from Range.equalsRange
- Defined in editor.api.d.ts:674

equalsSelection

equalsSelection(other: ISelection): boolean
Test if equals other selection.
Parameters
- other: ISelection
Returns boolean
- Defined in editor.api.d.ts:807

getDirection

getDirection(): SelectionDirection
Get directions (LTR or RTL).

Returns SelectionDirection
- Defined in editor.api.d.ts:815

getEndPosition

getEndPosition(): Position
Return the end position (which will be after or equal to the start position)

Returns Position
Inherited from Range.getEndPosition
- Defined in editor.api.d.ts:682

getPosition

getPosition(): Position
Get the position at positionLineNumber and positionColumn.

Returns Position
- Defined in editor.api.d.ts:823

getSelectionStart

getSelectionStart(): Position
Get the position at the start of the selection.

Returns Position
- Defined in editor.api.d.ts:827

getStartPosition

getStartPosition(): Position
Return the start position (which will be before or equal to the end position)

Returns Position
Inherited from Range.getStartPosition
- Defined in editor.api.d.ts:690

intersectRanges

intersectRanges(range: IRange): Range
A intersection of the two ranges.
Parameters
- range: IRange
Returns Range
Inherited from Range.intersectRanges
- Defined in editor.api.d.ts:666

isEmpty

isEmpty(): boolean
Test if this range is empty.

Returns boolean
Inherited from Range.isEmpty
- Defined in editor.api.d.ts:624

plusRange

plusRange(range: IRange): Range
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
Inherited from Range.plusRange
- Defined in editor.api.d.ts:657

setEndPosition

setEndPosition(endLineNumber: number, endColumn: number): Selection
Create a new selection with a different positionLineNumber and positionColumn.
Parameters
- endLineNumber: number
- endColumn: number
Returns Selection
Overrides Range.setEndPosition
- Defined in editor.api.d.ts:819

setStartPosition

setStartPosition(startLineNumber: number, startColumn: number): Selection
Create a new selection with a different selectionStartLineNumber and selectionStartColumn.
Parameters
- startLineNumber: number
- startColumn: number
Returns Selection
Overrides Range.setStartPosition
- Defined in editor.api.d.ts:831

strictContainsRange

strictContainsRange(range: IRange): boolean
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
Inherited from Range.strictContainsRange
- Defined in editor.api.d.ts:648

toJSON

toJSON(): IRange
Returns IRange
Inherited from Range.toJSON
- Defined in editor.api.d.ts:752

toString

toString(): string
Transform to a human-readable representation.

Returns string
Overrides Range.toString
- Defined in editor.api.d.ts:803

`Static` areIntersecting

areIntersecting(a: IRange, b: IRange): boolean
Test if the two ranges are intersecting. If the ranges are touching it returns true.
Parameters
- a: IRange
- b: IRange
Returns boolean
Inherited from Range.areIntersecting
- Defined in editor.api.d.ts:737

`Static` areIntersectingOrTouching

areIntersectingOrTouching(a: IRange, b: IRange): boolean
Test if the two ranges are touching in any way.
Parameters
- a: IRange
- b: IRange
Returns boolean
Inherited from Range.areIntersectingOrTouching
- Defined in editor.api.d.ts:733

`Static` collapseToStart

collapseToStart(range: IRange): Range
Create a new empty range using this range's start position.
Parameters
- range: IRange
Returns Range
Inherited from Range.collapseToStart
- Defined in editor.api.d.ts:718

`Static` compareRangesUsingEnds

compareRangesUsingEnds(a: IRange, b: IRange): number
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
Inherited from Range.compareRangesUsingEnds
- Defined in editor.api.d.ts:747

`Static` compareRangesUsingStarts

compareRangesUsingStarts(a: IRange, b: IRange): number
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
Inherited from Range.compareRangesUsingStarts
- Defined in editor.api.d.ts:742

`Static` containsPosition

containsPosition(range: IRange, position: IPosition): boolean
Test if position is in range. If the position is at the edges, will return true.
Parameters
- range: IRange
- position: IPosition
Returns boolean
Inherited from Range.containsPosition
- Defined in editor.api.d.ts:636

`Static` containsRange

containsRange(range: IRange, otherRange: IRange): boolean
Test if otherRange is in range. If the ranges are equal, will return true.
Parameters
- range: IRange
- otherRange: IRange
Returns boolean
Inherited from Range.containsRange
- Defined in editor.api.d.ts:644

`Static` createWithDirection

createWithDirection(startLineNumber: number, startColumn: number, endLineNumber: number, endColumn: number, direction: SelectionDirection): Selection
Create with a direction.
Parameters
- startLineNumber: number
- startColumn: number
- endLineNumber: number
- endColumn: number
- direction: SelectionDirection
Returns Selection
- Defined in editor.api.d.ts:855

`Static` equalsRange

equalsRange(a: IRange, b: IRange): boolean
Test if range a equals b.
Parameters
- a: IRange
- b: IRange
Returns boolean
Inherited from Range.equalsRange
- Defined in editor.api.d.ts:678

`Static` fromPositions

fromPositions(start: IPosition, end?: IPosition): Selection
Create a Selection from one or two positions
Parameters
- start: IPosition
- Optional end: IPosition
Returns Selection
Overrides Range.fromPositions
- Defined in editor.api.d.ts:835

`Static` fromRange

fromRange(range: Range, direction: SelectionDirection): Selection
Creates a Selection from a range, given a direction.
Parameters
- range: Range
- direction: SelectionDirection
Returns Selection
- Defined in editor.api.d.ts:839

`Static` getEndPosition

getEndPosition(range: IRange): Position
Return the end position (which will be after or equal to the start position)
Parameters
- range: IRange
Returns Position
Inherited from Range.getEndPosition
- Defined in editor.api.d.ts:686

`Static` getStartPosition

getStartPosition(range: IRange): Position
Return the start position (which will be before or equal to the end position)
Parameters
- range: IRange
Returns Position
Inherited from Range.getStartPosition
- Defined in editor.api.d.ts:694

`Static` intersectRanges

intersectRanges(a: IRange, b: IRange): Range
A intersection of the two ranges.
Parameters
- a: IRange
- b: IRange
Returns Range
Inherited from Range.intersectRanges
- Defined in editor.api.d.ts:670

`Static` isEmpty

isEmpty(range: IRange): boolean
Test if range is empty.
Parameters
- range: IRange
Returns boolean
Inherited from Range.isEmpty
- Defined in editor.api.d.ts:628

`Static` isIRange

isIRange(obj: any): obj is IRange
Test if obj is an IRange.
Parameters
- obj: any
Returns obj is IRange
Inherited from Range.isIRange
- Defined in editor.api.d.ts:729

`Static` isISelection

isISelection(obj: any): obj is ISelection
Test if obj is an ISelection.
Parameters
- obj: any
Returns obj is ISelection
- Defined in editor.api.d.ts:851

`Static` lift

lift(range: null): null
Create a Range from an IRange.
Parameters
- range: null
Returns null
Inherited from Range.lift
- Defined in editor.api.d.ts:723
lift(range: IRange): Range
Parameters
- range: IRange
Returns Range
Inherited from Range.lift
- Defined in editor.api.d.ts:724
lift(range: IRange): Range
Parameters
- range: IRange
Returns Range
Inherited from Range.lift
- Defined in editor.api.d.ts:725

`Static` liftSelection

liftSelection(sel: ISelection): Selection
Create a Selection from an ISelection.
Parameters
- sel: ISelection
Returns Selection
- Defined in editor.api.d.ts:843

`Static` plusRange

plusRange(a: IRange, b: IRange): Range
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
Inherited from Range.plusRange
- Defined in editor.api.d.ts:662

`Static` selectionsArrEqual

selectionsArrEqual(a: ISelection[], b: ISelection[]): boolean
a equals b.
Parameters
- a: ISelection[]
- b: ISelection[]
Returns boolean
- Defined in editor.api.d.ts:847

`Static` selectionsEqual

selectionsEqual(a: ISelection, b: ISelection): boolean
Test if the two selections are equal.
Parameters
- a: ISelection
- b: ISelection
Returns boolean
- Defined in editor.api.d.ts:811

`Static` spansMultipleLines

spansMultipleLines(range: IRange): boolean
Test if the range spans multiple lines.
Parameters
- range: IRange
Returns boolean
Inherited from Range.spansMultipleLines
- Defined in editor.api.d.ts:751

`Static` strictContainsRange

strictContainsRange(range: IRange, otherRange: IRange): boolean
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
Inherited from Range.strictContainsRange
- Defined in editor.api.d.ts:652

Class Selection

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

selectionStartLineNumber: number

selectionStartColumn: number

positionLineNumber: number

positionColumn: number

Returns Selection

Properties

Readonly endColumn

Readonly endLineNumber

Readonly positionColumn

Readonly positionLineNumber

Readonly selectionStartColumn

Readonly selectionStartLineNumber

Readonly startColumn

Readonly startLineNumber

Methods

collapseToStart

Returns Range

containsPosition

Parameters

position: IPosition

Returns boolean

containsRange

Parameters

range: IRange

Returns boolean

delta

Parameters

lineCount: number

Returns Range

equalsRange

Parameters

other: IRange

Returns boolean

equalsSelection

Parameters

other: ISelection

Returns boolean

getDirection

Returns SelectionDirection

getEndPosition

Returns Position

getPosition

Returns Position

getSelectionStart

Returns Position

getStartPosition

Returns Position

intersectRanges

Parameters

range: IRange

Returns Range

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

`Readonly` endColumn

`Readonly` endLineNumber

`Readonly` positionColumn

`Readonly` positionLineNumber

`Readonly` selectionStartColumn

`Readonly` selectionStartLineNumber

`Readonly` startColumn

`Readonly` startLineNumber

`Static` areIntersecting

`Static` areIntersectingOrTouching

`Static` collapseToStart

`Static` compareRangesUsingEnds

`Static` compareRangesUsingStarts

`Static` containsPosition

`Static` containsRange

`Static` createWithDirection

`Static` equalsRange

`Static` fromPositions

`Optional` end: IPosition

`Static` fromRange

`Static` getEndPosition

`Static` getStartPosition

`Static` intersectRanges