|
|
<!doctype html>
|
|
|
<html class="default no-js">
|
|
|
<head>
|
|
|
<meta charset="utf-8">
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
|
<title>NotebookDocumentContentOptions | VS Code API 中文文档</title>
|
|
|
<meta name="description" content="Documentation for VS Code API 中文文档">
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
|
<link rel="shortcut icon" href="https://code.visualstudio.com/favicon.ico" sizes="128x128">
|
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
|
<style>
|
|
|
.github-corner svg {
|
|
|
z-index: 1;
|
|
|
}
|
|
|
.github-corner:hover .octo-arm {
|
|
|
animation:octocat-wave 560ms ease-in-out
|
|
|
}
|
|
|
@keyframes octocat-wave {
|
|
|
0%,100%{transform:rotate(0)}
|
|
|
20%,60%{transform:rotate(-25deg)}
|
|
|
40%,80%{transform:rotate(10deg)}
|
|
|
}
|
|
|
@media (max-width:500px) {
|
|
|
.github-corner:hover
|
|
|
.octo-arm{animation:none}
|
|
|
.github-corner .octo-arm{
|
|
|
animation:octocat-wave 560ms ease-in-out
|
|
|
}
|
|
|
}
|
|
|
.container-main {
|
|
|
padding-bottom: 50px;
|
|
|
}
|
|
|
</style>
|
|
|
</head>
|
|
|
<body>
|
|
|
<header>
|
|
|
<div class="tsd-page-toolbar">
|
|
|
<div class="container">
|
|
|
<div class="table-wrap">
|
|
|
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
|
<div class="field">
|
|
|
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
|
<input id="tsd-search-field" type="text" />
|
|
|
</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">VS Code 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="../modules.html">VS Code API 中文文档</a>
|
|
|
</li>
|
|
|
<li>
|
|
|
<a href="NotebookDocumentContentOptions.html">NotebookDocumentContentOptions</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h1>Interface NotebookDocumentContentOptions</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>Notebook content options define what parts of a notebook are persisted. Note</p>
|
|
|
</div>
|
|
|
<p>For instance, a notebook serializer can opt-out of saving outputs and in that case the editor doesn't mark a
|
|
|
notebooks as <a href="NotebookDocument.html#isDirty">dirty</a> when its output has changed.</p>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
|
<h3>层级</h3>
|
|
|
<ul class="tsd-hierarchy">
|
|
|
<li>
|
|
|
<span class="target">NotebookDocumentContentOptions</span>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-panel-group tsd-index-group">
|
|
|
<h2>索引</h2>
|
|
|
<section class="tsd-panel tsd-index-panel">
|
|
|
<div class="tsd-index-content">
|
|
|
<section class="tsd-index-section ">
|
|
|
<h3>Properties（3）</h3>
|
|
|
<ul class="tsd-index-list">
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="NotebookDocumentContentOptions.html#transientOutputs" class="tsd-kind-icon">transient<wbr>Outputs</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="NotebookDocumentContentOptions.html#transientCellMetadata" class="tsd-kind-icon">transient<wbr>Cell<wbr>Metadata</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="NotebookDocumentContentOptions.html#transientDocumentMetadata" class="tsd-kind-icon">transient<wbr>Document<wbr>Metadata</a></li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
</div>
|
|
|
</section>
|
|
|
</section>
|
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
|
<h2>Properties（3）</h2>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
|
<a name="transientOutputs" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> transient<wbr>Outputs</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">transient<wbr>Outputs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/3c33e77/vscode.d.ts#L11969">vscode.d.ts:11969</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Controls if outputs change will trigger notebook document content change and if it will be used in the diff editor
|
|
|
Default to false. If the content provider doesn't persisit the outputs in the file document, this should be set to true.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
|
<a name="transientCellMetadata" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> transient<wbr>Cell<wbr>Metadata</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">transient<wbr>Cell<wbr>Metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/3c33e77/vscode.d.ts#L11975">vscode.d.ts:11975</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Controls if a cell metadata property change will trigger notebook document content change and if it will be used in the diff editor
|
|
|
Default to false. If the content provider doesn't persisit a metadata property in the file document, it should be set to true.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="tsd-type-declaration">
|
|
|
<h4>Type declaration</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li class="tsd-parameter-index-signature">
|
|
|
<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
|
<a name="transientDocumentMetadata" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> transient<wbr>Document<wbr>Metadata</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">transient<wbr>Document<wbr>Metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{}</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/vscode-cn/vscode-api-cn/blob/3c33e77/vscode.d.ts#L11981">vscode.d.ts:11981</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Controls if a document metadata property change will trigger notebook document content change and if it will be used in the diff editor
|
|
|
Default to false. If the content provider doesn't persisit a metadata property in the file document, it should be set to true.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
<div class="tsd-type-declaration">
|
|
|
<h4>Type declaration</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li class="tsd-parameter-index-signature">
|
|
|
<h5><span class="tsd-signature-symbol">[</span>key: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">undefined</span></h5>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
</section>
|
|
|
</section>
|
|
|
</div>
|
|
|
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
|
<nav class="tsd-navigation primary">
|
|
|
<ul>
|
|
|
<li class=" ">
|
|
|
<a href="../modules.html">Exports</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</nav>
|
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
|
<ul class="before-current">
|
|
|
</ul>
|
|
|
<ul class="current">
|
|
|
<li class="current tsd-kind-interface">
|
|
|
<a href="NotebookDocumentContentOptions.html" class="tsd-kind-icon">Notebook<wbr>Document<wbr>Content<wbr>Options</a>
|
|
|
<ul>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
|
<a href="NotebookDocumentContentOptions.html#transientOutputs" class="tsd-kind-icon">transient<wbr>Outputs</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
|
<a href="NotebookDocumentContentOptions.html#transientCellMetadata" class="tsd-kind-icon">transient<wbr>Cell<wbr>Metadata</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
|
<a href="NotebookDocumentContentOptions.html#transientDocumentMetadata" class="tsd-kind-icon">transient<wbr>Document<wbr>Metadata</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<ul class="after-current">
|
|
|
</ul>
|
|
|
</nav>
|
|
|
</div>
|
|
|
</div>
|
|
|
</div>
|
|
|
<footer class="with-border-bottom">
|
|
|
<div class="container">
|
|
|
<h2>图例</h2>
|
|
|
<div class="tsd-legend-group">
|
|
|
<ul class="tsd-legend">
|
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
|
</ul>
|
|
|
<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>
|
|
|
<ul class="tsd-legend">
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
|
|
</ul>
|
|
|
<ul class="tsd-legend">
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
|
|
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
|
|
</ul>
|
|
|
</div>
|
|
|
</div>
|
|
|
</footer>
|
|
|
<div class="container tsd-generator">
|
|
|
<p><a href="https://liiked.github.io/VS-Code-Extension-Doc-ZH/" target="_blank">VS Code 插件开发中文文档</a> | <a href="https://jeasonstudio.gitbooks.io/vscode-cn-doc/content/" target="_blank">VS Code 中文文档</a> | <a href="https://code.visualstudio.com/docs" target="_blank">VS Code 官网文档</a> | <a href="https://marketplace.visualstudio.com/" target="_blank">VS Code 扩展市场</a></p>
|
|
|
<p>Generated by <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
|
</div>
|
|
|
<div class="overlay"></div>
|
|
|
<script src="../assets/js/main.js"></script>
|
|
|
<a href="https://github.com/youngjuning/vscode-api-cn" target="_blank" class="github-corner" aria-label="View source on GitHub"><svg width="80" height="80" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true"><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a>
|
|
|
</body>
|
|
|
</html> |
