Class Selection

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

Hierarchy (view full)

Constructors

constructor

Properties

endColumn endLineNumber positionColumn positionLineNumber selectionStartColumn selectionStartLineNumber startColumn startLineNumber

Methods

collapseToEnd collapseToStart containsPosition containsRange delta equalsRange equalsSelection getDirection getEndPosition getPosition getSelectionStart getStartPosition intersectRanges isEmpty isSingleLine plusRange setEndPosition setStartPosition strictContainsRange toJSON toString areIntersecting areIntersectingOrTouching areOnlyIntersecting collapseToEnd collapseToStart compareRangesUsingEnds compareRangesUsingStarts containsPosition containsRange createWithDirection equalsRange fromPositions fromRange getEndPosition getStartPosition intersectRanges isEmpty isIRange isISelection lift liftSelection plusRange selectionsArrEqual selectionsEqual spansMultipleLines strictContainsRange

Constructors

constructor

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

  • Parameters

    • selectionStartLineNumber: number
    • selectionStartColumn: number
    • positionLineNumber: number
    • positionColumn: number

    Returns Selection

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

collapseToEnd

  • collapseToEnd(): Range

  • Create a new empty range using this range's end position.

    Returns Range

collapseToStart

  • collapseToStart(): Range

  • Create a new empty range using this range's start position.

    Returns Range

containsPosition

  • containsPosition(position): boolean

  • Test if position is in this range. If the position is at the edges, will return true.

    Parameters

    Returns boolean

containsRange

  • containsRange(range): boolean

  • Test if range is in this range. If the range is equal to this range, will return true.

    Parameters

    Returns boolean

delta

  • delta(lineCount): Range

  • Moves the range by the given amount of lines.

    Parameters

    • lineCount: number

    Returns Range

equalsRange

  • equalsRange(other): boolean

  • Test if this range equals other.

    Parameters

    Returns boolean

equalsSelection

  • equalsSelection(other): boolean

  • Test if equals other selection.

    Parameters

    Returns boolean

getDirection

getEndPosition

  • getEndPosition(): Position

  • Return the end position (which will be after or equal to the start position)

    Returns Position

getPosition

  • getPosition(): Position

  • Get the position at positionLineNumber and positionColumn.

    Returns Position

getSelectionStart

  • getSelectionStart(): Position

  • Get the position at the start of the selection.

    Returns Position

getStartPosition

  • getStartPosition(): Position

  • Return the start position (which will be before or equal to the end position)

    Returns Position

intersectRanges

isEmpty

  • isEmpty(): boolean

  • Test if this range is empty.

    Returns boolean

isSingleLine

  • isSingleLine(): boolean

  • Returns boolean

plusRange

  • plusRange(range): 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

    Returns Range

setEndPosition

  • setEndPosition(endLineNumber, endColumn): Selection

  • Create a new selection with a different positionLineNumber and positionColumn.

    Parameters

    • endLineNumber: number
    • endColumn: number

    Returns Selection

setStartPosition

  • setStartPosition(startLineNumber, startColumn): Selection

  • Create a new selection with a different selectionStartLineNumber and selectionStartColumn.

    Parameters

    • startLineNumber: number
    • startColumn: number

    Returns Selection

strictContainsRange

  • strictContainsRange(range): 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

    Returns boolean

toJSON

toString

  • toString(): string

  • Transform to a human-readable representation.

    Returns string

Static areIntersecting

  • areIntersecting(a, b): boolean

  • Test if the two ranges are intersecting. If the ranges are touching it returns true.

    Parameters

    Returns boolean

Static areIntersectingOrTouching

Static areOnlyIntersecting

  • areOnlyIntersecting(a, b): boolean

  • Test if the two ranges are intersecting, but not touching at all.

    Parameters

    Returns boolean

Static collapseToEnd

  • collapseToEnd(range): Range

  • Create a new empty range using this range's end position.

    Parameters

    Returns Range

Static collapseToStart

  • collapseToStart(range): Range

  • Create a new empty range using this range's start position.

    Parameters

    Returns Range

Static compareRangesUsingEnds

  • compareRangesUsingEnds(a, b): number

  • A function that compares ranges, useful for sorting ranges It will first compare ranges on the endPosition and then on the startPosition

    Parameters

    Returns number

Static compareRangesUsingStarts

  • compareRangesUsingStarts(a, b): number

  • A function that compares ranges, useful for sorting ranges It will first compare ranges on the startPosition and then on the endPosition

    Parameters

    Returns number

Static containsPosition

  • containsPosition(range, position): boolean

  • Test if position is in range. If the position is at the edges, will return true.

    Parameters

    Returns boolean

Static containsRange

  • containsRange(range, otherRange): boolean

  • Test if otherRange is in range. If the ranges are equal, will return true.

    Parameters

    Returns boolean

Static createWithDirection

  • createWithDirection(startLineNumber, startColumn, endLineNumber, endColumn, direction): Selection

  • Create with a direction.

    Parameters

    • startLineNumber: number
    • startColumn: number
    • endLineNumber: number
    • endColumn: number
    • direction: SelectionDirection

    Returns Selection

Static equalsRange

  • equalsRange(a, b): boolean

  • Test if range a equals b.

    Parameters

    Returns boolean

Static fromPositions

Static fromRange

Static getEndPosition

  • getEndPosition(range): Position

  • Return the end position (which will be after or equal to the start position)

    Parameters

    Returns Position

Static getStartPosition

  • getStartPosition(range): Position

  • Return the start position (which will be before or equal to the end position)

    Parameters

    Returns Position

Static intersectRanges

Static isEmpty

  • isEmpty(range): boolean

  • Test if range is empty.

    Parameters

    Returns boolean

Static isIRange

  • isIRange(obj): obj is IRange

  • Test if obj is an IRange.

    Parameters

    • obj: unknown

    Returns obj is IRange

Static isISelection

  • isISelection(obj): obj is ISelection

  • Test if obj is an ISelection.

    Parameters

    • obj: unknown

    Returns obj is ISelection

Static lift

  • lift(range): null

  • Create a Range from an IRange.

    Parameters

    • range: null

    Returns null

  • lift(range): Range

  • Parameters

    Returns Range

  • lift(range): Range

  • Parameters

    Returns Range

Static liftSelection

  • liftSelection(sel): Selection

  • Create a Selection from an ISelection.

    Parameters

    Returns Selection

Static plusRange

  • plusRange(a, b): 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

    Returns Range

Static selectionsArrEqual

  • selectionsArrEqual(a, b): boolean

  • a equals b.

    Parameters

    Returns boolean

Static selectionsEqual

  • selectionsEqual(a, b): boolean

  • Test if the two selections are equal.

    Parameters

    Returns boolean

Static spansMultipleLines

  • spansMultipleLines(range): boolean

  • Test if the range spans multiple lines.

    Parameters

    Returns boolean

Static strictContainsRange

  • strictContainsRange(range, otherRange): boolean

  • Test if otherRange is strictly in range (must start after, and end before). If the ranges are equal, will return false.

    Parameters

    Returns boolean

Settings

Member Visibility

Theme

On This Page

constructorendColumnendLineNumberpositionColumnpositionLineNumberselectionStartColumnselectionStartLineNumberstartColumnstartLineNumbercollapseToEndcollapseToStartcontainsPositioncontainsRangedeltaequalsRangeequalsSelectiongetDirectiongetEndPositiongetPositiongetSelectionStartgetStartPositionintersectRangesisEmptyisSingleLineplusRangesetEndPositionsetStartPositionstrictContainsRangetoJSONtoStringareIntersectingareIntersectingOrTouchingareOnlyIntersectingcollapseToEndcollapseToStartcompareRangesUsingEndscompareRangesUsingStartscontainsPositioncontainsRangecreateWithDirectionequalsRangefromPositionsfromRangegetEndPositiongetStartPositionintersectRangesisEmptyisIRangeisISelectionliftliftSelectionplusRangeselectionsArrEqualselectionsEqualspansMultipleLinesstrictContainsRange