DiffPlugin
DiffPlugin =
EditorPlugin&object
Type Declaration
Section titled “Type Declaration”getExpandedRegions()
Section titled “getExpandedRegions()”getExpandedRegions():
ReadonlySet<string>
§C5. Hosts must not mirror this.
Returns
Section titled “Returns”ReadonlySet<string>
getRows()
Section titled “getRows()”getRows(): readonly
DiffRenderRow[]
Returns
Section titled “Returns”readonly DiffRenderRow[]
getStackedRows()
Section titled “getStackedRows()”getStackedRows(): readonly
DiffRenderRow[]
Both sides in row order. Cached until the file or expansion state changes.
Returns
Section titled “Returns”readonly DiffRenderRow[]
getTokens()
Section titled “getTokens()”getTokens(): readonly
EditorToken[]
Returns
Section titled “Returns”readonly EditorToken[]
isSyntaxReady()
Section titled “isSyntaxReady()”isSyntaxReady():
boolean
Projected syntax tokens for the current rows. The host passes them with the rows’ text,
setText(text, { tokens }), or an expansion toggle repaints uncoloured (§C10).
Returns
Section titled “Returns”boolean
onDidChangeRows()
Section titled “onDidChangeRows()”onDidChangeRows(
listener):EditorDisposable
Parameters
Section titled “Parameters”listener
Section titled “listener”() => void
Returns
Section titled “Returns”EditorDisposable
onDidChangeTokens()
Section titled “onDidChangeTokens()”onDidChangeTokens(
listener):EditorDisposable
Parameters
Section titled “Parameters”listener
Section titled “listener”() => void
Returns
Section titled “Returns”EditorDisposable
releaseSyntax()
Section titled “releaseSyntax()”releaseSyntax():
void
Releases syntax interests while retaining this pane’s rows and shared expansion.
Returns
Section titled “Returns”void
setBaseFile()
Section titled “setBaseFile()”setBaseFile(
file):void
overlay mode: the buffer the live editor text is diffed against.
Parameters
Section titled “Parameters”DiffTextFile | null
Returns
Section titled “Returns”void
setEnabled()
Section titled “setEnabled()”setEnabled(
enabled):void
Parameters
Section titled “Parameters”enabled
Section titled “enabled”boolean
Returns
Section titled “Returns”void
setFile()
Section titled “setFile()”setFile(
file,prepared?):void
document mode: the file to project. The host owns the editor’s text — §C3. prepared
streams from prepareDiffSyntax for this file paint with the first rows, and a preparation
still running is awaited in place of a second parse. The plugin disposes each reader interest.
Parameters
Section titled “Parameters”DiffFile | null
prepared?
Section titled “prepared?”Returns
Section titled “Returns”void
toggleRegion()
Section titled “toggleRegion()”toggleRegion(
key):void
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void