|
|
|
|
<!doctype html>
|
|
|
|
|
<html class="default no-js">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
|
|
|
<title>NotebookCell | 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="../modules.html">VS Code API</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li>
|
|
|
|
|
<a href="NotebookCell.html">NotebookCell</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h1>Interface NotebookCell</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>Represents a cell of a <a href="NotebookDocument.html">notebook</a>, either a <a href="../enums/NotebookCellKind.html#Code">code</a>-cell
|
|
|
|
|
or <a href="../enums/NotebookCellKind.html#Markup">markup</a>-cell.</p>
|
|
|
|
|
</div>
|
|
|
|
|
<p>NotebookCell instances are immutable and are kept in sync for as long as they are part of their notebook.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
|
|
|
<h3>Hierarchy</h3>
|
|
|
|
|
<ul class="tsd-hierarchy">
|
|
|
|
|
<li>
|
|
|
|
|
<span class="target">NotebookCell</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="NotebookCell.html#index" class="tsd-kind-icon">index</a></li>
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="NotebookCell.html#notebook" class="tsd-kind-icon">notebook</a></li>
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="NotebookCell.html#kind" class="tsd-kind-icon">kind</a></li>
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="NotebookCell.html#document" class="tsd-kind-icon">document</a></li>
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="NotebookCell.html#metadata" class="tsd-kind-icon">metadata</a></li>
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="NotebookCell.html#outputs" class="tsd-kind-icon">outputs</a></li>
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="NotebookCell.html#executionSummary" class="tsd-kind-icon">execution<wbr>Summary</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 name="index" class="tsd-anchor"></a>
|
|
|
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> index</h3>
|
|
|
|
|
<div class="tsd-signature tsd-kind-icon">index<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/main/vscode.d.ts#L11532">vscode.d.ts:11532</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>The index of this cell in its <a href="NotebookDocument.html#cellAt">containing notebook</a>. The
|
|
|
|
|
index is updated when a cell is moved within its notebook. The index is <code>-1</code>
|
|
|
|
|
when the cell has been removed from its notebook.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a name="notebook" class="tsd-anchor"></a>
|
|
|
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> notebook</h3>
|
|
|
|
|
<div class="tsd-signature tsd-kind-icon">notebook<span class="tsd-signature-symbol">:</span> <a href="NotebookDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">NotebookDocument</a></div>
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/main/vscode.d.ts#L11537">vscode.d.ts:11537</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>The <a href="NotebookDocument.html">notebook</a> that contains this cell.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a name="kind" class="tsd-anchor"></a>
|
|
|
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> kind</h3>
|
|
|
|
|
<div class="tsd-signature tsd-kind-icon">kind<span class="tsd-signature-symbol">:</span> <a href="../enums/NotebookCellKind.html" class="tsd-signature-type" data-tsd-kind="Enumeration">NotebookCellKind</a></div>
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/main/vscode.d.ts#L11542">vscode.d.ts:11542</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>The kind of this cell.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a name="document" class="tsd-anchor"></a>
|
|
|
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> document</h3>
|
|
|
|
|
<div class="tsd-signature tsd-kind-icon">document<span class="tsd-signature-symbol">:</span> <a href="TextDocument.html" class="tsd-signature-type" data-tsd-kind="Interface">TextDocument</a></div>
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/main/vscode.d.ts#L11547">vscode.d.ts:11547</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>The <a href="TextDocument.html">text</a> of this cell, represented as text document.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a name="metadata" class="tsd-anchor"></a>
|
|
|
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> metadata</h3>
|
|
|
|
|
<div class="tsd-signature tsd-kind-icon">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/youngjuning/vscode-api/blob/main/vscode.d.ts#L11552">vscode.d.ts:11552</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>The metadata of this cell. Can be anything but must be JSON-stringifyable.</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">any</span></h5>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a name="outputs" class="tsd-anchor"></a>
|
|
|
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> outputs</h3>
|
|
|
|
|
<div class="tsd-signature tsd-kind-icon">outputs<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">readonly </span><a href="../classes/NotebookCellOutput.html" class="tsd-signature-type" data-tsd-kind="Class">NotebookCellOutput</a><span class="tsd-signature-symbol">[]</span></div>
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/main/vscode.d.ts#L11557">vscode.d.ts:11557</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>The outputs of this cell.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a name="executionSummary" class="tsd-anchor"></a>
|
|
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> execution<wbr>Summary</h3>
|
|
|
|
|
<div class="tsd-signature tsd-kind-icon">execution<wbr>Summary<span class="tsd-signature-symbol">:</span> <a href="NotebookCellExecutionSummary.html" class="tsd-signature-type" data-tsd-kind="Interface">NotebookCellExecutionSummary</a></div>
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/main/vscode.d.ts#L11562">vscode.d.ts:11562</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>The most recent <a href="NotebookCellExecutionSummary.html">execution summary</a> for this cell.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</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="NotebookCell.html" class="tsd-kind-icon">Notebook<wbr>Cell</a>
|
|
|
|
|
<ul>
|
|
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a href="NotebookCell.html#index" class="tsd-kind-icon">index</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a href="NotebookCell.html#notebook" class="tsd-kind-icon">notebook</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a href="NotebookCell.html#kind" class="tsd-kind-icon">kind</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a href="NotebookCell.html#document" class="tsd-kind-icon">document</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a href="NotebookCell.html#metadata" class="tsd-kind-icon">metadata</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a href="NotebookCell.html#outputs" class="tsd-kind-icon">outputs</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a href="NotebookCell.html#executionSummary" class="tsd-kind-icon">execution<wbr>Summary</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<ul class="after-current">
|
|
|
|
|
</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>
|
