Class Selection

Represents a text selection in an editor.

Hierarchy (View Summary)

Range
- Selection

Index

Constructors

constructor

new Selection(anchor: Position, active: Position): Selection
Create a selection from two positions.
Parameters
- anchor: Position
  A position.
- active: Position
  A position.
Returns Selection
Overrides Range.constructor
- Defined in vscode.d.ts:538
new Selection(
    anchorLine: number,
    anchorCharacter: number,
    activeLine: number,
    activeCharacter: number,
): Selection
Create a selection from four coordinates.
Parameters
- anchorLine: number
  A zero-based line value.
- anchorCharacter: number
  A zero-based character value.
- activeLine: number
  A zero-based line value.
- activeCharacter: number
  A zero-based character value.
Returns Selection
Overrides Range.constructor
- Defined in vscode.d.ts:548

Properties

`Readonly`active

active: Position

The position of the cursor. This position might be before or after anchor.

`Readonly`anchor

anchor: Position

The position at which the selection starts. This position might be before or after active.

`Readonly`end

end: Position

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

isEmpty

isEmpty: boolean

true if start and end are equal.

`Readonly`isReversed

isReversed: boolean

A selection is reversed if its anchor is the end position.

isSingleLine

isSingleLine: boolean

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

`Readonly`start

start: Position

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

Methods

contains

contains(positionOrRange: Range | Position): boolean
Check if a position or a range is contained in this range.
Parameters
- positionOrRange: Range | Position
  A position or a range.
Returns boolean
true if the position or range is inside or equal to this range.
Inherited from Range.contains
- Defined in vscode.d.ts:457

intersection

intersection(range: Range): Range | undefined
Intersect range with this range and returns a new range or undefined if the ranges have no overlap.
Parameters
- range: Range
  A range.
Returns Range | undefined
A range of the greater start and smaller end positions. Will return undefined when there is no overlap.
Inherited from Range.intersection
- Defined in vscode.d.ts:476

isEqual

isEqual(other: Range): boolean
Check if other equals this range.
Parameters
- other: Range
  A range.
Returns boolean
true when start and end are equal to start and end of this range.
Inherited from Range.isEqual
- Defined in vscode.d.ts:466

union

union(other: Range): Range
Compute the union of other with this range.
Parameters
- other: Range
  A range.
Returns Range
A range of smaller start position and the greater end position.
Inherited from Range.union
- Defined in vscode.d.ts:484

with

with(start?: Position, end?: Position): Range
Derived a new range from this range.
Parameters
- Optionalstart: Position
  A position that should be used as start. The default value is the current start.
- Optionalend: 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.
Inherited from Range.with
- Defined in vscode.d.ts:494
with(change: { end?: Position; start?: Position }): Range
Derived a new range from this range.
Parameters
- change: { end?: Position; start?: Position }
  An object that describes a change to this range.
  - Optionalend?: Position
    New end position, defaults to current end
  - Optionalstart?: Position
    New start position, defaults to current start
Returns Range
A range that reflects the given change. Will return this range if the change is not changing anything.
Inherited from Range.with
- Defined in vscode.d.ts:503

Class Selection

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Selection

Parameters

Returns Selection

Properties

Readonlyactive

Readonlyanchor

Readonlyend

isEmpty

ReadonlyisReversed

isSingleLine

Readonlystart

Methods

contains

Parameters

Returns boolean

intersection

Parameters

Returns Range | undefined

isEqual

Parameters

Returns boolean

union

Parameters

Returns Range

with

Parameters

Returns Range

Parameters

Optionalend?: Position

Optionalstart?: Position

Returns Range

Settings

On This Page

`Readonly`active

`Readonly`anchor

`Readonly`end

`Readonly`isReversed

`Readonly`start

`Optional`end?: Position

`Optional`start?: Position