Interface IDiffEditor

A rich diff editor.

interface IDiffEditor {
    onDidChangeModel: IEvent<void>;
    onDidUpdateDiff: IEvent<void>;
    accessibleDiffViewerNext(): void;
    accessibleDiffViewerPrev(): void;
    createDecorationsCollection(decorations?): IEditorDecorationsCollection;
    createViewModel(model): IDiffEditorViewModel;
    dispose(): void;
    focus(): void;
    getContainerDomNode(): HTMLElement;
    getEditorType(): string;
    getId(): string;
    getLineChanges(): ILineChange[];
    getModel(): IDiffEditorModel;
    getModifiedEditor(): ICodeEditor;
    getOriginalEditor(): ICodeEditor;
    getPosition(): Position;
    getSelection(): Selection;
    getSelections(): Selection[];
    getSupportedActions(): IEditorAction[];
    getVisibleColumnFromPosition(position): number;
    goToDiff(target): void;
    handleInitialized(): void;
    hasTextFocus(): boolean;
    layout(dimension?, postponeRendering?): void;
    onDidDispose(listener): IDisposable;
    restoreViewState(state): void;
    revealFirstDiff(): unknown;
    revealLine(lineNumber, scrollType?): void;
    revealLineInCenter(lineNumber, scrollType?): void;
    revealLineInCenterIfOutsideViewport(lineNumber, scrollType?): void;
    revealLineNearTop(lineNumber, scrollType?): void;
    revealLines(startLineNumber, endLineNumber, scrollType?): void;
    revealLinesInCenter(lineNumber, endLineNumber, scrollType?): void;
    revealLinesInCenterIfOutsideViewport(lineNumber, endLineNumber, scrollType?): void;
    revealLinesNearTop(lineNumber, endLineNumber, scrollType?): void;
    revealPosition(position, scrollType?): void;
    revealPositionInCenter(position, scrollType?): void;
    revealPositionInCenterIfOutsideViewport(position, scrollType?): void;
    revealPositionNearTop(position, scrollType?): void;
    revealRange(range, scrollType?): void;
    revealRangeAtTop(range, scrollType?): void;
    revealRangeInCenter(range, scrollType?): void;
    revealRangeInCenterIfOutsideViewport(range, scrollType?): void;
    revealRangeNearTop(range, scrollType?): void;
    revealRangeNearTopIfOutsideViewport(range, scrollType?): void;
    saveViewState(): IDiffEditorViewState;
    setModel(model): void;
    setPosition(position, source?): void;
    setSelection(selection, source?): void;
    setSelection(selection, source?): void;
    setSelection(selection, source?): void;
    setSelection(selection, source?): void;
    setSelections(selections, source?): void;
    trigger(source, handlerId, payload): void;
    updateOptions(newOptions): void;
}

Hierarchy (view full)

Methods

accessibleDiffViewerNext accessibleDiffViewerPrev createDecorationsCollection createViewModel dispose focus getContainerDomNode getEditorType getId getLineChanges getModel getModifiedEditor getOriginalEditor getPosition getSelection getSelections getSupportedActions getVisibleColumnFromPosition goToDiff handleInitialized hasTextFocus layout restoreViewState revealFirstDiff revealLine revealLineInCenter revealLineInCenterIfOutsideViewport revealLineNearTop revealLines revealLinesInCenter revealLinesInCenterIfOutsideViewport revealLinesNearTop revealPosition revealPositionInCenter revealPositionInCenterIfOutsideViewport revealPositionNearTop revealRange revealRangeAtTop revealRangeInCenter revealRangeInCenterIfOutsideViewport revealRangeNearTop revealRangeNearTopIfOutsideViewport saveViewState setModel setPosition setSelection setSelections trigger updateOptions

Events

onDidChangeModel onDidUpdateDiff onDidDispose

Methods

accessibleDiffViewerNext

  • accessibleDiffViewerNext(): void

  • Returns void

accessibleDiffViewerPrev

  • accessibleDiffViewerPrev(): void

  • Returns void

createDecorationsCollection

createViewModel

dispose

  • dispose(): void

  • Dispose the editor.

    Returns void

focus

  • focus(): void

  • Brings browser focus to the editor text

    Returns void

getContainerDomNode

getEditorType

  • getEditorType(): string

  • Get the editor type. Please see EditorType. This is to avoid an instanceof check

    Returns string

getId

  • getId(): string

  • Get a unique id for this editor instance.

    Returns string

getLineChanges

  • getLineChanges(): ILineChange[]

  • Get the computed diff information.

    Returns ILineChange[]

getModel

getModifiedEditor

getOriginalEditor

getPosition

getSelection

getSelections

getSupportedActions

getVisibleColumnFromPosition

  • getVisibleColumnFromPosition(position): number

  • Given a position, returns a column number that takes tab-widths into account.

    Parameters

    Returns number

goToDiff

  • goToDiff(target): void

  • Jumps to the next or previous diff.

    Parameters

    • target: "next" | "previous"

    Returns void

handleInitialized

  • handleInitialized(): void

  • Returns void

hasTextFocus

  • hasTextFocus(): boolean

  • Returns true if the text inside this editor is focused (i.e. cursor is blinking).

    Returns boolean

layout

  • layout(dimension?, postponeRendering?): void

  • Instructs the editor to remeasure its container. This method should be called when the container of the editor gets resized.

    If a dimension is passed in, the passed in value will be used.

    By default, this will also render the editor immediately. If you prefer to delay rendering to the next animation frame, use postponeRendering == true.

    Parameters

    • Optional dimension: IDimension
    • Optional postponeRendering: boolean

    Returns void

restoreViewState

  • restoreViewState(state): void

  • Restores the view state of the editor from a serializable object generated by saveViewState.

    Parameters

    Returns void

revealFirstDiff

  • revealFirstDiff(): unknown

  • Scrolls to the first diff. (Waits until the diff computation finished.)

    Returns unknown

revealLine

  • revealLine(lineNumber, scrollType?): void

  • Scroll vertically as necessary and reveal a line.

    Parameters

    Returns void

revealLineInCenter

  • revealLineInCenter(lineNumber, scrollType?): void

  • Scroll vertically as necessary and reveal a line centered vertically.

    Parameters

    Returns void

revealLineInCenterIfOutsideViewport

  • revealLineInCenterIfOutsideViewport(lineNumber, scrollType?): void

  • Scroll vertically as necessary and reveal a line centered vertically only if it lies outside the viewport.

    Parameters

    Returns void

revealLineNearTop

  • revealLineNearTop(lineNumber, scrollType?): void

  • Scroll vertically as necessary and reveal a line close to the top of the viewport, optimized for viewing a code definition.

    Parameters

    Returns void

revealLines

  • revealLines(startLineNumber, endLineNumber, scrollType?): void

  • Scroll vertically as necessary and reveal lines.

    Parameters

    • startLineNumber: number
    • endLineNumber: number
    • Optional scrollType: ScrollType

    Returns void

revealLinesInCenter

  • revealLinesInCenter(lineNumber, endLineNumber, scrollType?): void

  • Scroll vertically as necessary and reveal lines centered vertically.

    Parameters

    • lineNumber: number
    • endLineNumber: number
    • Optional scrollType: ScrollType

    Returns void

revealLinesInCenterIfOutsideViewport

  • revealLinesInCenterIfOutsideViewport(lineNumber, endLineNumber, scrollType?): void

  • Scroll vertically as necessary and reveal lines centered vertically only if it lies outside the viewport.

    Parameters

    • lineNumber: number
    • endLineNumber: number
    • Optional scrollType: ScrollType

    Returns void

revealLinesNearTop

  • revealLinesNearTop(lineNumber, endLineNumber, scrollType?): void

  • Scroll vertically as necessary and reveal lines close to the top of the viewport, optimized for viewing a code definition.

    Parameters

    • lineNumber: number
    • endLineNumber: number
    • Optional scrollType: ScrollType

    Returns void

revealPosition

  • revealPosition(position, scrollType?): void

  • Scroll vertically or horizontally as necessary and reveal a position.

    Parameters

    Returns void

revealPositionInCenter

  • revealPositionInCenter(position, scrollType?): void

  • Scroll vertically or horizontally as necessary and reveal a position centered vertically.

    Parameters

    Returns void

revealPositionInCenterIfOutsideViewport

  • revealPositionInCenterIfOutsideViewport(position, scrollType?): void

  • Scroll vertically or horizontally as necessary and reveal a position centered vertically only if it lies outside the viewport.

    Parameters

    Returns void

revealPositionNearTop

  • revealPositionNearTop(position, scrollType?): void

  • Scroll vertically or horizontally as necessary and reveal a position close to the top of the viewport, optimized for viewing a code definition.

    Parameters

    Returns void

revealRange

  • revealRange(range, scrollType?): void

  • Scroll vertically or horizontally as necessary and reveal a range.

    Parameters

    Returns void

revealRangeAtTop

  • revealRangeAtTop(range, scrollType?): void

  • Scroll vertically or horizontally as necessary and reveal a range at the top of the viewport.

    Parameters

    Returns void

revealRangeInCenter

  • revealRangeInCenter(range, scrollType?): void

  • Scroll vertically or horizontally as necessary and reveal a range centered vertically.

    Parameters

    Returns void

revealRangeInCenterIfOutsideViewport

  • revealRangeInCenterIfOutsideViewport(range, scrollType?): void

  • Scroll vertically or horizontally as necessary and reveal a range centered vertically only if it lies outside the viewport.

    Parameters

    Returns void

revealRangeNearTop

  • revealRangeNearTop(range, scrollType?): void

  • Scroll vertically or horizontally as necessary and reveal a range close to the top of the viewport, optimized for viewing a code definition.

    Parameters

    Returns void

revealRangeNearTopIfOutsideViewport

  • revealRangeNearTopIfOutsideViewport(range, scrollType?): void

  • Scroll vertically or horizontally as necessary and reveal a range close to the top of the viewport, optimized for viewing a code definition. Only if it lies outside the viewport.

    Parameters

    Returns void

saveViewState

setModel

  • setModel(model): void

  • Sets the current model attached to this editor. If the previous model was created by the editor via the value key in the options literal object, it will be destroyed. Otherwise, if the previous model was set via setModel, or the model key in the options literal object, the previous model will not be destroyed. It is safe to call setModel(null) to simply detach the current model from the editor.

    Parameters

    Returns void

setPosition

  • setPosition(position, source?): void

  • Set the primary position of the cursor. This will remove any secondary cursors.

    Parameters

    • position: IPosition

      New primary cursor's position

    • Optional source: string

      Source of the call that caused the position

    Returns void

setSelection

  • setSelection(selection, source?): void

  • Set the primary selection of the editor. This will remove any secondary cursors.

    Parameters

    • selection: IRange

      The new selection

    • Optional source: string

      Source of the call that caused the selection

    Returns void

  • setSelection(selection, source?): void

  • Set the primary selection of the editor. This will remove any secondary cursors.

    Parameters

    • selection: Range

      The new selection

    • Optional source: string

      Source of the call that caused the selection

    Returns void

  • setSelection(selection, source?): void

  • Set the primary selection of the editor. This will remove any secondary cursors.

    Parameters

    • selection: ISelection

      The new selection

    • Optional source: string

      Source of the call that caused the selection

    Returns void

  • setSelection(selection, source?): void

  • Set the primary selection of the editor. This will remove any secondary cursors.

    Parameters

    • selection: Selection

      The new selection

    • Optional source: string

      Source of the call that caused the selection

    Returns void

setSelections

  • setSelections(selections, source?): void

  • Set the selections for all the cursors of the editor. Cursors will be removed or added, as necessary.

    Parameters

    • selections: readonly ISelection[]

      The new selection

    • Optional source: string

      Source of the call that caused the selection

    Returns void

trigger

  • trigger(source, handlerId, payload): void

  • Directly trigger a handler or an editor action.

    Parameters

    • source: string

      The source of the call.

    • handlerId: string

      The id of the handler or the id of a contribution.

    • payload: unknown

      Extra data to be sent to the handler.

    Returns void

updateOptions

  • updateOptions(newOptions): void

  • Update the editor's options after the editor has been created.

    Parameters

    Returns void

Events

Readonly onDidChangeModel

onDidChangeModel: IEvent<void>

An event emitted when the diff model is changed (i.e. the diff editor shows new content).

Readonly onDidUpdateDiff

onDidUpdateDiff: IEvent<void>

An event emitted when the diff information computed by this diff editor has been updated.

onDidDispose

  • onDidDispose(listener): IDisposable

  • An event emitted when the editor has been disposed.

    Parameters

    • listener: (() => void)
        • (): void

        • Returns void

    Returns IDisposable

Settings

Member Visibility

Theme

On This Page

accessibleDiffViewerNextaccessibleDiffViewerPrevcreateDecorationsCollectioncreateViewModeldisposefocusgetContainerDomNodegetEditorTypegetIdgetLineChangesgetModelgetModifiedEditorgetOriginalEditorgetPositiongetSelectiongetSelectionsgetSupportedActionsgetVisibleColumnFromPositiongoToDiffhandleInitializedhasTextFocuslayoutrestoreViewStaterevealFirstDiffrevealLinerevealLineInCenterrevealLineInCenterIfOutsideViewportrevealLineNearToprevealLinesrevealLinesInCenterrevealLinesInCenterIfOutsideViewportrevealLinesNearToprevealPositionrevealPositionInCenterrevealPositionInCenterIfOutsideViewportrevealPositionNearToprevealRangerevealRangeAtToprevealRangeInCenterrevealRangeInCenterIfOutsideViewportrevealRangeNearToprevealRangeNearTopIfOutsideViewportsaveViewStatesetModelsetPositionsetSelectionsetSelectionstriggerupdateOptionsonDidChangeModelonDidUpdateDiffonDidDispose