x4js - v2.2.49
    Preparing search index...

    A rich diff editor.

    interface IDiffEditor {
        onDidChangeModel: IEvent<void>;
        onDidUpdateDiff: IEvent<void>;
        accessibleDiffViewerNext(): void;
        accessibleDiffViewerPrev(): void;
        createDecorationsCollection(
            decorations?: IModelDeltaDecoration[],
        ): IEditorDecorationsCollection;
        createViewModel(model: IDiffEditorModel): 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: IPosition): number;
        goToDiff(target: "next" | "previous"): void;
        handleInitialized(): void;
        hasTextFocus(): boolean;
        layout(dimension?: IDimension, postponeRendering?: boolean): void;
        onDidDispose(listener: () => void): IDisposable;
        restoreViewState(state: IDiffEditorViewState): void;
        revealFirstDiff(): unknown;
        revealLine(lineNumber: number, scrollType?: ScrollType): void;
        revealLineInCenter(lineNumber: number, scrollType?: ScrollType): void;
        revealLineInCenterIfOutsideViewport(
            lineNumber: number,
            scrollType?: ScrollType,
        ): void;
        revealLineNearTop(lineNumber: number, scrollType?: ScrollType): void;
        revealLines(
            startLineNumber: number,
            endLineNumber: number,
            scrollType?: ScrollType,
        ): void;
        revealLinesInCenter(
            lineNumber: number,
            endLineNumber: number,
            scrollType?: ScrollType,
        ): void;
        revealLinesInCenterIfOutsideViewport(
            lineNumber: number,
            endLineNumber: number,
            scrollType?: ScrollType,
        ): void;
        revealLinesNearTop(
            lineNumber: number,
            endLineNumber: number,
            scrollType?: ScrollType,
        ): void;
        revealPosition(position: IPosition, scrollType?: ScrollType): void;
        revealPositionInCenter(position: IPosition, scrollType?: ScrollType): void;
        revealPositionInCenterIfOutsideViewport(
            position: IPosition,
            scrollType?: ScrollType,
        ): void;
        revealPositionNearTop(position: IPosition, scrollType?: ScrollType): void;
        revealRange(range: IRange, scrollType?: ScrollType): void;
        revealRangeAtTop(range: IRange, scrollType?: ScrollType): void;
        revealRangeInCenter(range: IRange, scrollType?: ScrollType): void;
        revealRangeInCenterIfOutsideViewport(
            range: IRange,
            scrollType?: ScrollType,
        ): void;
        revealRangeNearTop(range: IRange, scrollType?: ScrollType): void;
        revealRangeNearTopIfOutsideViewport(
            range: IRange,
            scrollType?: ScrollType,
        ): void;
        saveViewState(): IDiffEditorViewState;
        setModel(model: IDiffEditorModel | IDiffEditorViewModel): void;
        setPosition(position: IPosition, source?: string): void;
        setSelection(selection: IRange, source?: string): void;
        setSelection(selection: Range, source?: string): void;
        setSelection(selection: ISelection, source?: string): void;
        setSelection(selection: Selection, source?: string): void;
        setSelections(selections: readonly ISelection[], source?: string): void;
        trigger(source: string, handlerId: string, payload: unknown): void;
        updateOptions(newOptions: IDiffEditorOptions): void;
    }

    Hierarchy (View Summary)

    Index
    • 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

      • Optionaldimension: IDimension
      • OptionalpostponeRendering: boolean

      Returns 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

    onDidChangeModel: IEvent<void>

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

    onDidUpdateDiff: IEvent<void>

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