You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
341 lines
19 KiB
341 lines
19 KiB
<!doctype html>
|
|
<html class="default no-js">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<title>notebooks | 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="stylesheet" href="../assets/css/main.css">
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
</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="../index.html">VS Code API 简体中文版</a>
|
|
</li>
|
|
<li>
|
|
<a href="notebooks.html">notebooks</a>
|
|
</li>
|
|
</ul>
|
|
<h1>Namespace notebooks</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>Namespace for notebooks.</p>
|
|
</div>
|
|
<p>The notebooks functionality is composed of three loosely coupled components:</p>
|
|
<ol>
|
|
<li><a href="../interfaces/NotebookSerializer.html">NotebookSerializer</a> enable the editor to open, show, and save notebooks</li>
|
|
<li><a href="../interfaces/NotebookController.html">NotebookController</a> own the execution of notebooks, e.g they create output from code cells.</li>
|
|
<li>NotebookRenderer present notebook output in the editor. They run in a separate context.</li>
|
|
</ol>
|
|
</div>
|
|
</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>Functions</h3>
|
|
<ul class="tsd-index-list">
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="notebooks.html#createNotebookController" class="tsd-kind-icon">create<wbr>Notebook<wbr>Controller</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="notebooks.html#registerNotebookCellStatusBarItemProvider" class="tsd-kind-icon">register<wbr>Notebook<wbr>Cell<wbr>Status<wbr>Bar<wbr>Item<wbr>Provider</a></li>
|
|
<li class="tsd-kind-function tsd-parent-kind-namespace"><a href="notebooks.html#createRendererMessaging" class="tsd-kind-icon">create<wbr>Renderer<wbr>Messaging</a></li>
|
|
</ul>
|
|
</section>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
<h2>Functions</h2>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
<a name="createNotebookController" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Notebook<wbr>Controller</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Notebook<wbr>Controller<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, notebookType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-symbol">(</span>cells<span class="tsd-signature-symbol">: </span><a href="../interfaces/NotebookCell.html" class="tsd-signature-type" data-tsd-kind="Interface">NotebookCell</a><span class="tsd-signature-symbol">[]</span>, notebook<span class="tsd-signature-symbol">: </span><a href="../interfaces/NotebookDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">NotebookDocument</a>, controller<span class="tsd-signature-symbol">: </span><a href="../interfaces/NotebookController.html" class="tsd-signature-type" data-tsd-kind="Interface">NotebookController</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/NotebookController.html" class="tsd-signature-type" data-tsd-kind="Interface">NotebookController</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/5aad9ba/vscode.d.ts#L12323">vscode.d.ts:12323</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Creates a new notebook controller.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>id: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>Identifier of the controller. Must be unique per extension.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>notebookType: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A notebook type for which this controller is for.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>label: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The label of the controller.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> handler: <span class="tsd-signature-symbol">(</span>cells<span class="tsd-signature-symbol">: </span><a href="../interfaces/NotebookCell.html" class="tsd-signature-type" data-tsd-kind="Interface">NotebookCell</a><span class="tsd-signature-symbol">[]</span>, notebook<span class="tsd-signature-symbol">: </span><a href="../interfaces/NotebookDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">NotebookDocument</a>, controller<span class="tsd-signature-symbol">: </span><a href="../interfaces/NotebookController.html" class="tsd-signature-type" data-tsd-kind="Interface">NotebookController</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The execute-handler of the controller.</p>
|
|
</div>
|
|
<ul class="tsd-parameters">
|
|
<li class="tsd-parameter-signature">
|
|
<ul class="tsd-signatures tsd-kind-type-literal">
|
|
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>cells<span class="tsd-signature-symbol">: </span><a href="../interfaces/NotebookCell.html" class="tsd-signature-type" data-tsd-kind="Interface">NotebookCell</a><span class="tsd-signature-symbol">[]</span>, notebook<span class="tsd-signature-symbol">: </span><a href="../interfaces/NotebookDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">NotebookDocument</a>, controller<span class="tsd-signature-symbol">: </span><a href="../interfaces/NotebookController.html" class="tsd-signature-type" data-tsd-kind="Interface">NotebookController</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>cells: <a href="../interfaces/NotebookCell.html" class="tsd-signature-type" data-tsd-kind="Interface">NotebookCell</a><span class="tsd-signature-symbol">[]</span></h5>
|
|
</li>
|
|
<li>
|
|
<h5>notebook: <a href="../interfaces/NotebookDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">NotebookDocument</a></h5>
|
|
</li>
|
|
<li>
|
|
<h5>controller: <a href="../interfaces/NotebookController.html" class="tsd-signature-type" data-tsd-kind="Interface">NotebookController</a></h5>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/NotebookController.html" class="tsd-signature-type" data-tsd-kind="Interface">NotebookController</a></h4>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
<a name="registerNotebookCellStatusBarItemProvider" class="tsd-anchor"></a>
|
|
<h3>register<wbr>Notebook<wbr>Cell<wbr>Status<wbr>Bar<wbr>Item<wbr>Provider</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
<li class="tsd-signature tsd-kind-icon">register<wbr>Notebook<wbr>Cell<wbr>Status<wbr>Bar<wbr>Item<wbr>Provider<span class="tsd-signature-symbol">(</span>notebookType<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, provider<span class="tsd-signature-symbol">: </span><a href="../interfaces/NotebookCellStatusBarItemProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">NotebookCellStatusBarItemProvider</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/5aad9ba/vscode.d.ts#L12332">vscode.d.ts:12332</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Register a <a href="../interfaces/NotebookCellStatusBarItemProvider.html">cell statusbar item provider</a> for the given notebook type.</p>
|
|
</div>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>notebookType: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The notebook type to register for.</p>
|
|
</div>
|
|
</li>
|
|
<li>
|
|
<h5>provider: <a href="../interfaces/NotebookCellStatusBarItemProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">NotebookCellStatusBarItemProvider</a></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>A cell status bar provider.</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../classes/Disposable.html" class="tsd-signature-type" data-tsd-kind="Class">Disposable</a></h4>
|
|
<p>A <a href="../classes/Disposable.html">Disposable</a> that unregisters this provider when being disposed.</p>
|
|
</li>
|
|
</ul>
|
|
</section>
|
|
<section class="tsd-panel tsd-member tsd-kind-function tsd-parent-kind-namespace">
|
|
<a name="createRendererMessaging" class="tsd-anchor"></a>
|
|
<h3>create<wbr>Renderer<wbr>Messaging</h3>
|
|
<ul class="tsd-signatures tsd-kind-function tsd-parent-kind-namespace">
|
|
<li class="tsd-signature tsd-kind-icon">create<wbr>Renderer<wbr>Messaging<span class="tsd-signature-symbol">(</span>rendererId<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/NotebookRendererMessaging.html" class="tsd-signature-type" data-tsd-kind="Interface">NotebookRendererMessaging</a></li>
|
|
</ul>
|
|
<ul class="tsd-descriptions">
|
|
<li class="tsd-description">
|
|
<aside class="tsd-sources">
|
|
<ul>
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/5aad9ba/vscode.d.ts#L12344">vscode.d.ts:12344</a></li>
|
|
</ul>
|
|
</aside>
|
|
<div class="tsd-comment tsd-typography">
|
|
<div class="lead">
|
|
<p>Creates a new messaging instance used to communicate with a specific renderer.</p>
|
|
</div>
|
|
<ul>
|
|
<li><em>Note 1:</em> Extensions can only create renderer that they have defined in their <code>package.json</code>-file</li>
|
|
<li><em>Note 2:</em> A renderer only has access to messaging if <code>requiresMessaging</code> is set to <code>always</code> or <code>optional</code> in
|
|
its <code>notebookRenderer</code> contribution.</li>
|
|
</ul>
|
|
</div>
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
<ul class="tsd-parameters">
|
|
<li>
|
|
<h5>rendererId: <span class="tsd-signature-type">string</span></h5>
|
|
<div class="tsd-comment tsd-typography">
|
|
<p>The renderer ID to communicate with</p>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
<h4 class="tsd-returns-title">Returns <a href="../interfaces/NotebookRendererMessaging.html" class="tsd-signature-type" data-tsd-kind="Interface">NotebookRendererMessaging</a></h4>
|
|
<p>A new notebook renderer messaging object.</p>
|
|
</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=" tsd-kind-namespace">
|
|
<a href="authentication.html">authentication</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="commands.html">commands</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="comments.html">comments</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="debug.html">debug</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="env.html">env</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="extensions.html">extensions</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="languages.html">languages</a>
|
|
</li>
|
|
<li class="current tsd-kind-namespace">
|
|
<a href="notebooks.html">notebooks</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="scm.html">scm</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="tasks.html">tasks</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="tests.html">tests</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="window.html">window</a>
|
|
</li>
|
|
<li class=" tsd-kind-namespace">
|
|
<a href="workspace.html">workspace</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
<ul class="before-current">
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
<a href="notebooks.html#createNotebookController" class="tsd-kind-icon">create<wbr>Notebook<wbr>Controller</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
<a href="notebooks.html#registerNotebookCellStatusBarItemProvider" class="tsd-kind-icon">register<wbr>Notebook<wbr>Cell<wbr>Status<wbr>Bar<wbr>Item<wbr>Provider</a>
|
|
</li>
|
|
<li class=" tsd-kind-function tsd-parent-kind-namespace">
|
|
<a href="notebooks.html#createRendererMessaging" class="tsd-kind-icon">create<wbr>Renderer<wbr>Messaging</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<footer class="with-border-bottom">
|
|
<div class="container">
|
|
<h2>Legend</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>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
</div>
|
|
<div class="overlay"></div>
|
|
<script src="../assets/js/main.js"></script>
|
|
</body>
|
|
</html> |