Interface LocationLink

Represents the connection of two locations. Provides additional metadata over normal locations, including an origin range.

interface LocationLink {
    originSelectionRange?: Range;
    targetRange: Range;
    targetSelectionRange: Range;
    targetUri: string;
}

Properties

originSelectionRange?: Range

Span of the origin of this link.

Used as the underlined span for mouse interaction. Defaults to the word range at the definition position.

targetRange: Range

The full target range of this link. If the target for example is a symbol then target range is the range enclosing this symbol not including leading/trailing whitespace but everything else like comments. This information is typically used to highlight the range in the editor.

targetSelectionRange: Range

The range that should be selected and revealed when this link is being followed, e.g the name of a function. Must be contained by the targetRange. See also DocumentSymbol#range

targetUri: string

The target resource identifier of this link.