Class InlineDiffView

Hierarchy (view full)

BaseDiffView
- InlineDiffView

Index

Constructors

constructor

Constructors

constructor

new InlineDiffView(diffModel?, container?): InlineDiffView
Constructs a new inline DiffView instance.
Parameters
- Optional diffModel: {
      editorA: Editor;
      editorB: Editor;
      sessionA: EditSession;
      sessionB: EditSession;
      showSideA: boolean;
      valueA: string;
      valueB: string;
  }
  The model for the diff view.
  - editorA: Editor
    The editor for the original view.
  - editorB: Editor
    The editor for the edited view.
  - sessionA: EditSession
    The edit session for the original view.
  - sessionB: EditSession
    The edit session for the edited view.
  - showSideA: boolean
    Whether to show the original view or modified view.
  - valueA: string
    The original content.
  - valueB: string
    The modified content.
- Optional container: HTMLElement
  optional container element for the DiffView.
Returns InlineDiffView
Overrides BaseDiffView.constructor
- Defined in src/ext/diff/inline_diff_view.js:21

Properties

$syncingFold

$syncingFold: boolean

$updatingSelection

$updatingSelection: boolean

activeEditor

activeEditor: any

chunks

chunks: DiffChunk[]

container

container: HTMLElement

currentDiffIndex

currentDiffIndex: number

cursorLayer

cursorLayer: any

diffProvider

diffProvider: {
compute: ((val1, val2, options) => any[]);
}

Type declaration

compute: ((val1, val2, options) => any[])
- - (val1, val2, options): any[]
  - Parameters
    - val1: any
    - val2: any
    - options: any
    Returns any[]

diffSession

diffSession: {
    chunks: DiffChunk[];
    sessionA: EditSession;
    sessionB: EditSession;
}

@type{{sessionA: EditSession, sessionB: EditSession, chunks: DiffChunk[]}}

Type declaration

chunks: DiffChunk[]
sessionA: EditSession
sessionB: EditSession

editorA

editorA: any

editorB

editorB: any

gutterDecoratorA

gutterDecoratorA: MinimalGutterDiffDecorator

gutterDecoratorB

gutterDecoratorB: MinimalGutterDiffDecorator

gutterLayer

gutterLayer: any

inlineDiffEditor

inlineDiffEditor: boolean

markerA

markerA: DiffHighlight

markerB

markerB: DiffHighlight

markerLayer

markerLayer: any

onMouseDetach

onMouseDetach: (() => void)

Type declaration

- (): void
- Returns void

options

options: {
    ignoreTrimWhitespace: boolean;
    maxComputationTimeMs: number;
    syncSelections: boolean;
}

Type declaration

ignoreTrimWhitespace: boolean
maxComputationTimeMs: number
syncSelections: boolean

otherEditor

otherEditor: any

otherEditorContainer

otherEditorContainer: any

otherSession

otherSession: EditSession

othertextInput

othertextInput: any

realignPending

realignPending: boolean

savedOptionsA

savedOptionsA: Partial<EditorOptions>

savedOptionsB

savedOptionsB: Partial<EditorOptions>

selectionRangeA

selectionRangeA: any

selectionRangeB

selectionRangeB: any

sessionA

sessionA: EditSession

sessionB

sessionB: EditSession

showSideA

showSideA: boolean

syncSelectionMarkerA

syncSelectionMarkerA: SyncSelectionMarker

syncSelectionMarkerB

syncSelectionMarkerB: SyncSelectionMarker

textLayer

textLayer: any

Methods

$attachEventHandlers

$attachEventHandlers(): void
Returns void
- Defined in src/ext/diff/inline_diff_view.js:306

$attachSessionEventHandlers

$attachSessionEventHandlers(editor, marker): void
Parameters
- editor: any
- marker: any
Returns void
- Defined in src/ext/diff/inline_diff_view.js:286

$attachSessionsEventHandlers

$attachSessionsEventHandlers(): void
Returns void
Abstract
Overrides BaseDiffView.$attachSessionsEventHandlers
- Defined in src/ext/diff/inline_diff_view.js:281

$detachEventHandlers

$detachEventHandlers(): void
Returns void
Abstract
Overrides BaseDiffView.$detachEventHandlers
- Defined in src/ext/diff/inline_diff_view.js:312

$detachSessionHandlers

$detachSessionHandlers(editor, marker): void
Parameters
- editor: any
- marker: any
Returns void
- Defined in src/ext/diff/inline_diff_view.js:299

$detachSessionsEventHandlers

$detachSessionsEventHandlers(): void
Returns void
Abstract
Overrides BaseDiffView.$detachSessionsEventHandlers
- Defined in src/ext/diff/inline_diff_view.js:293

$diffLines

$diffLines(val1, val2): DiffChunk[]
Parameters
- val1: string[]
- val2: string[]
Returns DiffChunk[]
Inherited from BaseDiffView.$diffLines
- Defined in src/ext/diff/base_diff_view.js:290

$getDeltaIndent

$getDeltaIndent(fromEditSession, toEditSession, fromLine, toLine): number
Parameters
- fromEditSession: EditSession
- toEditSession: EditSession
- fromLine: number
- toLine: number
Returns number
Inherited from BaseDiffView.$getDeltaIndent
- Defined in src/ext/diff/base_diff_view.js:580

$getIndent

$getIndent(editSession, line): number
Parameters
- editSession: EditSession
- line: number
Returns number
Inherited from BaseDiffView.$getIndent
- Defined in src/ext/diff/base_diff_view.js:590

$removeLineWidgets

$removeLineWidgets(session): void
Parameters
- session: any
Returns void
Inherited from BaseDiffView.$removeLineWidgets
- Defined in src/ext/diff/base_diff_view.js:433

$setupModel

$setupModel(session?, value?): Editor
Parameters
- Optional session: EditSession
- Optional value: string
Returns Editor
Inherited from BaseDiffView.$setupModel
- Defined in src/ext/diff/base_diff_view.js:155

$setupModels

$setupModels(diffModel?): void
Parameters
- Optional diffModel: {
      editorA: Editor;
      editorB: Editor;
      sessionA: EditSession;
      sessionB: EditSession;
      showSideA: boolean;
      valueA: string;
      valueB: string;
  }
  The model for the diff view.
  - editorA: Editor
    The editor for the original view.
  - editorB: Editor
    The editor for the edited view.
  - sessionA: EditSession
    The edit session for the original view.
  - sessionB: EditSession
    The edit session for the edited view.
  - showSideA: boolean
    Whether to show the original view or modified view.
  - valueA: string
    The original content.
  - valueB: string
    The modified content.
Returns void
Inherited from BaseDiffView.$setupModels
- Defined in src/ext/diff/base_diff_view.js:94

addGutterDecorators

addGutterDecorators(): void
Returns void
Inherited from BaseDiffView.addGutterDecorators
- Defined in src/ext/diff/base_diff_view.js:144

align

align(): void
scroll locking

Returns void
Abstract
Overrides BaseDiffView.align
- Defined in src/ext/diff/inline_diff_view.js:223

clearSelectionMarkers

clearSelectionMarkers(): void
Returns void
Inherited from BaseDiffView.clearSelectionMarkers
- Defined in src/ext/diff/base_diff_view.js:637

destroy

destroy(): void
Returns void
Inherited from BaseDiffView.destroy
- Defined in src/ext/diff/base_diff_view.js:448

detach

detach(): void
Returns void
Inherited from BaseDiffView.detach
- Defined in src/ext/diff/base_diff_view.js:416

findChunkIndex

findChunkIndex(chunks, row, isOriginal): number
Parameters
- chunks: DiffChunk[]
- row: number
- isOriginal: boolean
Returns number
Inherited from BaseDiffView.findChunkIndex
- Defined in src/ext/diff/base_diff_view.js:607

firstDiffSelected

firstDiffSelected(): boolean
Returns boolean
Inherited from BaseDiffView.firstDiffSelected
- Defined in src/ext/diff/base_diff_view.js:476

foldUnchanged

foldUnchanged(): void
Returns void
Inherited from BaseDiffView.foldUnchanged
- Defined in src/ext/diff/base_diff_view.js:165

getDiffSession

getDiffSession(): {
    chunks: DiffChunk[];
    sessionA: EditSession;
    sessionB: EditSession;
}
Returns {
    chunks: DiffChunk[];
    sessionA: EditSession;
    sessionB: EditSession;
}
- chunks: DiffChunk[]
- sessionA: EditSession
- sessionB: EditSession
Inherited from BaseDiffView.getDiffSession
- Defined in src/ext/diff/base_diff_view.js:232

getTheme

getTheme(): any
Returns any
Inherited from BaseDiffView.getTheme
- Defined in src/ext/diff/base_diff_view.js:241

gotoNext

gotoNext(dir): void
Parameters
- dir: any
Returns void
Inherited from BaseDiffView.gotoNext
- Defined in src/ext/diff/base_diff_view.js:454

init

init(diffModel): void
Parameters
- diffModel: any
Returns void
- Defined in src/ext/diff/inline_diff_view.js:27

initMouse

initMouse(): void
Returns void
- Defined in src/ext/diff/inline_diff_view.js:157

initSelectionMarkers

initSelectionMarkers(): void
Returns void
Inherited from BaseDiffView.initSelectionMarkers
- Defined in src/ext/diff/base_diff_view.js:631

initTextInput

initTextInput(restore): void
Parameters
- restore: any
Returns void
- Defined in src/ext/diff/inline_diff_view.js:118

initTextLayer

initTextLayer(): void
Returns void
- Defined in src/ext/diff/inline_diff_view.js:81

lastDiffSelected

lastDiffSelected(): boolean
Returns boolean
Inherited from BaseDiffView.lastDiffSelected
- Defined in src/ext/diff/base_diff_view.js:480

onAfterRender

onAfterRender(changes, renderer): void
Parameters
- changes: number
- renderer: VirtualRenderer
Returns void
- Defined in src/ext/diff/inline_diff_view.js:340

onChangeFold

onChangeFold(ev, session): void
Parameters
- ev: any
- session: EditSession
Returns void
Inherited from BaseDiffView.onChangeFold
- Defined in src/ext/diff/base_diff_view.js:358

onChangeTheme

onChangeTheme(): void
Returns void
Inherited from BaseDiffView.onChangeTheme
- Defined in src/ext/diff/base_diff_view.js:245

onInput

onInput(): void
Returns void
Inherited from BaseDiffView.onInput
- Defined in src/ext/diff/base_diff_view.js:255

onSelect

onSelect(e, selection): void
Parameters
- e: any
- selection: any
Returns void
Inherited from BaseDiffView.onSelect
- Defined in src/ext/diff/base_diff_view.js:309

printDiffs

printDiffs(): void
Returns void
Inherited from BaseDiffView.printDiffs
- Defined in src/ext/diff/base_diff_view.js:594

realign

realign(): void
Returns void
Inherited from BaseDiffView.realign
- Defined in src/ext/diff/base_diff_view.js:408

resize

resize(force): void
Parameters
- force: any
Returns void
Inherited from BaseDiffView.resize
- Defined in src/ext/diff/base_diff_view.js:250

searchHighlight

searchHighlight(selection): void
Parameters
- selection: any
Returns void
Inherited from BaseDiffView.searchHighlight
- Defined in src/ext/diff/base_diff_view.js:620

selectEditor

selectEditor(editor): void
Parameters
- editor: any
Returns void
- Defined in src/ext/diff/inline_diff_view.js:130

setDiffSession

setDiffSession(session): void
Parameters
- session: {
      chunks: DiffChunk[];
      sessionA: any;
      sessionB: EditSession;
  }
  - chunks: DiffChunk[]
  - sessionA: any
  - sessionB: EditSession
Returns void
Inherited from BaseDiffView.setDiffSession
- Defined in src/ext/diff/base_diff_view.js:200

setOptions

setOptions(options): void
Parameters
- options: {
      foldUnchanged: boolean;
      ignoreTrimWhitespace: boolean;
      maxComputationTimeMs: number;
      syncSelections: boolean;
  }
  The configuration options for the DiffView.
  - foldUnchanged: boolean
    Whether to fold unchanged regions in the diff view.
  - ignoreTrimWhitespace: boolean
    Whether to ignore whitespace changes when computing diffs.
  - maxComputationTimeMs: number
    The maximum time in milliseconds to spend computing diffs (0 means no limit).
  - syncSelections: boolean
    Whether to synchronize selections between the original and edited views.
Returns void
Inherited from BaseDiffView.setOptions
- Defined in src/ext/diff/base_diff_view.js:71

setProvider

setProvider(provider): void
Parameters
- provider: DiffProvider
Returns void
Inherited from BaseDiffView.setProvider
- Defined in src/ext/diff/base_diff_view.js:300

setTheme

setTheme(theme): void
Parameters
- theme: any
Returns void
Inherited from BaseDiffView.setTheme
- Defined in src/ext/diff/base_diff_view.js:236

syncSelect

syncSelect(selection): void
Parameters
- selection: any
Returns void
Inherited from BaseDiffView.syncSelect
- Defined in src/ext/diff/base_diff_view.js:314

transformPosition

transformPosition(pos, isOriginal): Ace.Point
Parameters
- pos: Ace.Point
- isOriginal: boolean
Returns Ace.Point
Inherited from BaseDiffView.transformPosition
- Defined in src/ext/diff/base_diff_view.js:497

transformRange

transformRange(range, isOriginal): Range
Parameters
- range: Range
- isOriginal: boolean
Returns Range
Inherited from BaseDiffView.transformRange
- Defined in src/ext/diff/base_diff_view.js:488

updateSelectionMarker

updateSelectionMarker(marker, session, range): void
Parameters
- marker: any
- session: any
- range: any
Returns void
Inherited from BaseDiffView.updateSelectionMarker
- Defined in src/ext/diff/base_diff_view.js:349

Class InlineDiffView

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional diffModel: { editorA: Editor; editorB: Editor; sessionA: EditSession; sessionB: EditSession; showSideA: boolean; valueA: string; valueB: string; }

editorA: Editor

editorB: Editor

sessionA: EditSession

sessionB: EditSession

showSideA: boolean

valueA: string

valueB: string

Optional container: HTMLElement

Returns InlineDiffView

Properties

$syncingFold

$updatingSelection

activeEditor

chunks

container

currentDiffIndex

cursorLayer

diffProvider

Type declaration

compute: ((val1, val2, options) => any[])

Parameters

val1: any

val2: any

options: any

Returns any[]

diffSession

Type declaration

chunks: DiffChunk[]

sessionA: EditSession

sessionB: EditSession

editorA

editorB

gutterDecoratorA

gutterDecoratorB

gutterLayer

inlineDiffEditor

markerA

markerB

markerLayer

onMouseDetach

Type declaration

Returns void

options

Type declaration

ignoreTrimWhitespace: boolean

maxComputationTimeMs: number

syncSelections: boolean

otherEditor

otherEditorContainer

otherSession

othertextInput

realignPending

savedOptionsA

savedOptionsB

selectionRangeA

selectionRangeB

sessionA

sessionB

showSideA

syncSelectionMarkerA

syncSelectionMarkerB

textLayer

Methods

$attachEventHandlers

Returns void

$attachSessionEventHandlers

Parameters

editor: any

marker: any

Returns void

`Optional` diffModel: {
editorA: Editor;
editorB: Editor;
sessionA: EditSession;
sessionB: EditSession;
showSideA: boolean;
valueA: string;
valueB: string;
}

`Optional` container: HTMLElement

`Optional` session: EditSession

`Optional` value: string

`Optional` diffModel: {
editorA: Editor;
editorB: Editor;
sessionA: EditSession;
sessionB: EditSession;
showSideA: boolean;
valueA: string;
valueB: string;
}