Class Range

Pair of two positions.

Hierarchy

Range
- Selection

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

- Defined in packages/plugin/src/theia.d.ts:272
Create a new range from two positions. If start is not before or equal to end, the values will be swapped.

Parameters
- start: Position
  
  a position
- end: Position
  
  a position
Returns Range
- Defined in packages/plugin/src/theia.d.ts:282
Create a new position from coordinates.

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 end

End position.

isEmpty

isEmpty: boolean

true if start and end are equal

isSingleLine

isSingleLine: boolean

true if start.line and end.line are equal

Readonly start

start: Position

Start position.

Methods

contains

contains(positionOrRange: Range | Position): boolean

- Defined in packages/plugin/src/theia.d.ts:289
Check if a position or a range is in this range.

Parameters
- positionOrRange: Range | Position
  
  a position or a range
Returns boolean

intersection

intersection(range: Range): undefined | Range

- Defined in packages/plugin/src/theia.d.ts:303
Intersect range with this range and returns new range or undefined

Parameters
- range: Range
  
  a range
Returns undefined | Range

isEqual

isEqual(other: Range): boolean

- Defined in packages/plugin/src/theia.d.ts:296
Check other equals this range.

Parameters
- other: Range
  
  a range
Returns boolean

union

union(other: Range): Range

- Defined in packages/plugin/src/theia.d.ts:310
Compute the union of other with this range.

Parameters
- other: Range
  
  a range
Returns Range

with

with(start?: Position, end?: Position): Range
with(change: { end?: Position; start?: Position }): Range

- Defined in packages/plugin/src/theia.d.ts:320
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.
- Defined in packages/plugin/src/theia.d.ts:329
Derived a new range from this range.

Parameters
- change: { end?: Position; start?: Position }
  
  An object that describes a change to this range.
  - Optional end?: Position
  - Optional start?: Position
Returns Range
A range that reflects the given change. Will return this range if the change is not changing anything.