mirror of
https://github.com/microsoft/monaco-editor.git
synced 2025-12-23 00:22:56 +01:00
8 lines
No EOL
9.6 KiB
HTML
8 lines
No EOL
9.6 KiB
HTML
<!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>IDocumentDiffProvider | Monaco Editor API</title><meta name="description" content="Documentation for Monaco Editor API"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Monaco Editor API</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../index.html">Monaco Editor API</a></li><li><a href="../modules/monaco.html">monaco</a></li><li><a href="../modules/monaco.editor.html">editor</a></li><li><a href="monaco.editor.IDocumentDiffProvider.html">IDocumentDiffProvider</a></li></ul><h1>Interface IDocumentDiffProvider</h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>A document diff provider computes the diff between two text models.</p>
|
|
</div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">IDocumentDiffProvider</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Properties</h3><ul class="tsd-index-list"><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.editor.IDocumentDiffProvider.html#onDidChange" class="tsd-kind-icon">on<wbr/>Did<wbr/>Change</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-interface"><a href="monaco.editor.IDocumentDiffProvider.html#computeDiff" class="tsd-kind-icon">compute<wbr/>Diff</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Properties</h2><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a id="onDidChange" class="tsd-anchor"></a><h3 class="tsd-anchor-link">on<wbr/>Did<wbr/>Change<a href="#onDidChange" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><div class="tsd-signature tsd-kind-icon">on<wbr/>Did<wbr/>Change<span class="tsd-signature-symbol">:</span> <a href="monaco.IEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">IEvent</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L2266">website/typedoc/monaco.d.ts:2266</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Is fired when settings of the diff algorithm change that could alter the result of the diffing computation.
|
|
Any user of this provider should recompute the diff when this event is fired.</p>
|
|
</div></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface"><a id="computeDiff" class="tsd-anchor"></a><h3 class="tsd-anchor-link">compute<wbr/>Diff<a href="#computeDiff" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface"><li class="tsd-signature tsd-kind-icon">compute<wbr/>Diff<span class="tsd-signature-symbol">(</span>original<span class="tsd-signature-symbol">: </span><a href="monaco.editor.ITextModel.html" class="tsd-signature-type" data-tsd-kind="Interface">ITextModel</a>, modified<span class="tsd-signature-symbol">: </span><a href="monaco.editor.ITextModel.html" class="tsd-signature-type" data-tsd-kind="Interface">ITextModel</a>, options<span class="tsd-signature-symbol">: </span><a href="monaco.editor.IDocumentDiffProviderOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDocumentDiffProviderOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="monaco.editor.IDocumentDiff.html" class="tsd-signature-type" data-tsd-kind="Interface">IDocumentDiff</a><span class="tsd-signature-symbol">></span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/microsoft/monaco-editor/blob/08439de/website/typedoc/monaco.d.ts#L2261">website/typedoc/monaco.d.ts:2261</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
|
|
<p>Computes the diff between the text models <code>original</code> and <code>modified</code>.</p>
|
|
</div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>original: <a href="monaco.editor.ITextModel.html" class="tsd-signature-type" data-tsd-kind="Interface">ITextModel</a></h5></li><li><h5>modified: <a href="monaco.editor.ITextModel.html" class="tsd-signature-type" data-tsd-kind="Interface">ITextModel</a></h5></li><li><h5>options: <a href="monaco.editor.IDocumentDiffProviderOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">IDocumentDiffProviderOptions</a></h5></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="monaco.editor.IDocumentDiff.html" class="tsd-signature-type" data-tsd-kind="Interface">IDocumentDiff</a><span class="tsd-signature-symbol">></span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../index.html">Exports</a></li><li class="current tsd-kind-namespace"><a href="../modules/monaco.html">monaco</a><ul><li class="current tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/monaco.editor.html">editor</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/monaco.languages.html">languages</a></li><li class=" tsd-kind-namespace tsd-parent-kind-namespace"><a href="../modules/monaco.worker.html">worker</a></li></ul></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface tsd-parent-kind-namespace"><a href="monaco.editor.IDocumentDiffProvider.html" class="tsd-kind-icon">IDocument<wbr/>Diff<wbr/>Provider</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="monaco.editor.IDocumentDiffProvider.html#onDidChange" class="tsd-kind-icon">on<wbr/>Did<wbr/>Change</a></li><li class="tsd-kind-method tsd-parent-kind-interface"><a href="monaco.editor.IDocumentDiffProvider.html#computeDiff" class="tsd-kind-icon">compute<wbr/>Diff</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html> |