Interface DocumentRangeSemanticTokensProvider

The document range semantic tokens provider interface defines the contract between extensions and semantic tokens.

interface DocumentRangeSemanticTokensProvider {
    onDidChangeSemanticTokens?: Event<void>;
    provideDocumentRangeSemanticTokens(
        document: TextDocument,
        range: Range,
        token: CancellationToken,
    ): ProviderResult<SemanticTokens>;
}

Index

Properties

onDidChangeSemanticTokens?

Methods

provideDocumentRangeSemanticTokens

Properties

`Optional`onDidChangeSemanticTokens

onDidChangeSemanticTokens?: Event<void>

An optional event to signal that the semantic tokens from this provider have changed.

Methods

provideDocumentRangeSemanticTokens

provideDocumentRangeSemanticTokens(
    document: TextDocument,
    range: Range,
    token: CancellationToken,
): ProviderResult<SemanticTokens>
Parameters
- document: TextDocument
- range: Range
- token: CancellationToken
Returns ProviderResult<SemanticTokens>
See
provideDocumentSemanticTokens.
- Defined in packages/plugin/src/theia.d.ts:11490