yetao
/
vscode-api-cn.js
mirror of https://github.com/youngjuning/vscode-api-cn.js.org.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
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.
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'bde3177d8f'
${ noResults }
vscode-api-cn.js/interfaces/TreeDataProvider.html

358 lines
20 KiB
Raw Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>TreeDataProvider | 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="TreeDataProvider.html">TreeDataProvider</a>
</li>
</ul>
<h1>Interface TreeDataProvider&lt;T&gt;</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 data provider that provides tree data</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">TreeDataProvider</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="TreeDataProvider.html#onDidChangeTreeData" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Tree<wbr>Data</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="TreeDataProvider.html#getTreeItem" class="tsd-kind-icon">get<wbr>Tree<wbr>Item</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="TreeDataProvider.html#getChildren" class="tsd-kind-icon">get<wbr>Children</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="TreeDataProvider.html#getParent" class="tsd-kind-icon">get<wbr>Parent</a></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="TreeDataProvider.html#resolveTreeItem" class="tsd-kind-icon">resolve<wbr>Tree<wbr>Item</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="onDidChangeTreeData" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> on<wbr>Did<wbr>Change<wbr>Tree<wbr>Data</h3>
<div class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Tree<wbr>Data<span class="tsd-signature-symbol">:</span> <a href="Event.html" class="tsd-signature-type" data-tsd-kind="Interface">Event</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/5aad9ba/vscode.d.ts#L9246">vscode.d.ts:9246</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>An optional event to signal that an element or root has changed.
This will trigger the view to update the changed element/root and its children recursively (if shown).
To signal that root has changed, do not pass any argument or pass <code>undefined</code> or <code>null</code>.</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 name="getTreeItem" class="tsd-anchor"></a>
<h3>get<wbr>Tree<wbr>Item</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Tree<wbr>Item<span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../classes/TreeItem.html" class="tsd-signature-type" data-tsd-kind="Class">TreeItem</a><span class="tsd-signature-symbol"> | </span><a href="Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol">&lt;</span><a href="../classes/TreeItem.html" class="tsd-signature-type" data-tsd-kind="Class">TreeItem</a><span class="tsd-signature-symbol">&gt;</span></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#L9254">vscode.d.ts:9254</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get <a href="../classes/TreeItem.html">TreeItem</a> representation of the <code>element</code></p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>element: <span class="tsd-signature-type">T</span></h5>
<div class="tsd-comment tsd-typography">
<p>The element for which <a href="../classes/TreeItem.html">TreeItem</a> representation is asked for.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../classes/TreeItem.html" class="tsd-signature-type" data-tsd-kind="Class">TreeItem</a><span class="tsd-signature-symbol"> | </span><a href="Thenable.html" class="tsd-signature-type" data-tsd-kind="Interface">Thenable</a><span class="tsd-signature-symbol">&lt;</span><a href="../classes/TreeItem.html" class="tsd-signature-type" data-tsd-kind="Class">TreeItem</a><span class="tsd-signature-symbol">&gt;</span></h4>
<p><a href="../classes/TreeItem.html">TreeItem</a> representation of the element</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getChildren" class="tsd-anchor"></a>
<h3>get<wbr>Children</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Children<span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#ProviderResult" class="tsd-signature-type" data-tsd-kind="Type alias">ProviderResult</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></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#L9262">vscode.d.ts:9262</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Get the children of <code>element</code> or root if no element is passed.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> element: <span class="tsd-signature-type">T</span></h5>
<div class="tsd-comment tsd-typography">
<p>The element from which the provider gets children. Can be <code>undefined</code>.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../index.html#ProviderResult" class="tsd-signature-type" data-tsd-kind="Type alias">ProviderResult</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>Children of <code>element</code> or root if no element is passed.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="getParent" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> get<wbr>Parent</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">get<wbr>Parent<span class="tsd-signature-symbol">(</span>element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#ProviderResult" class="tsd-signature-type" data-tsd-kind="Type alias">ProviderResult</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></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#L9273">vscode.d.ts:9273</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Optional method to return the parent of <code>element</code>.
Return <code>null</code> or <code>undefined</code> if <code>element</code> is a child of root.</p>
</div>
<p><strong>NOTE:</strong> This method should be implemented in order to access <a href="TreeView.html#reveal">reveal</a> API.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>element: <span class="tsd-signature-type">T</span></h5>
<div class="tsd-comment tsd-typography">
<p>The element for which the parent has to be returned.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../index.html#ProviderResult" class="tsd-signature-type" data-tsd-kind="Type alias">ProviderResult</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
<p>Parent of <code>element</code>.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
<a name="resolveTreeItem" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> resolve<wbr>Tree<wbr>Item</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
<li class="tsd-signature tsd-kind-icon">resolve<wbr>Tree<wbr>Item<span class="tsd-signature-symbol">(</span>item<span class="tsd-signature-symbol">: </span><a href="../classes/TreeItem.html" class="tsd-signature-type" data-tsd-kind="Class">TreeItem</a>, element<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">T</span>, token<span class="tsd-signature-symbol">: </span><a href="CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../index.html#ProviderResult" class="tsd-signature-type" data-tsd-kind="Type alias">ProviderResult</a><span class="tsd-signature-symbol">&lt;</span><a href="../classes/TreeItem.html" class="tsd-signature-type" data-tsd-kind="Class">TreeItem</a><span class="tsd-signature-symbol">&gt;</span></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#L9296">vscode.d.ts:9296</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Called on hover to resolve the <a href="../classes/TreeItem.html#tooltip">TreeItem</a> property if it is undefined.
Called on tree item click/open to resolve the <a href="../classes/TreeItem.html#command">TreeItem</a> property if it is undefined.
Only properties that were undefined can be resolved in <code>resolveTreeItem</code>.
Functionality may be expanded later to include being called to resolve other missing
properties on selection and/or on open.</p>
</div>
<p>Will only ever be called once per TreeItem.</p>
<p>onDidChangeTreeData should not be triggered from within resolveTreeItem.</p>
<p><em>Note</em> that this function is called when tree items are already showing in the UI.
Because of that, no property that changes the presentation (label, description, etc.)
can be changed.</p>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>item: <a href="../classes/TreeItem.html" class="tsd-signature-type" data-tsd-kind="Class">TreeItem</a></h5>
<div class="tsd-comment tsd-typography">
<p>Undefined properties of <code>item</code> should be set then <code>item</code> should be returned.</p>
</div>
</li>
<li>
<h5>element: <span class="tsd-signature-type">T</span></h5>
<div class="tsd-comment tsd-typography">
<p>The object associated with the TreeItem.</p>
</div>
</li>
<li>
<h5>token: <a href="CancellationToken.html" class="tsd-signature-type" data-tsd-kind="Interface">CancellationToken</a></h5>
<div class="tsd-comment tsd-typography">
<p>A cancellation token.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="../index.html#ProviderResult" class="tsd-signature-type" data-tsd-kind="Type alias">ProviderResult</a><span class="tsd-signature-symbol">&lt;</span><a href="../classes/TreeItem.html" class="tsd-signature-type" data-tsd-kind="Class">TreeItem</a><span class="tsd-signature-symbol">&gt;</span></h4>
<p>The resolved tree item or a thenable that resolves to such. It is OK to return the given
<code>item</code>. When no result is returned, the given <code>item</code> will be used.</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>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-has-type-parameter">
<a href="TreeDataProvider.html" class="tsd-kind-icon">Tree<wbr>Data<wbr>Provider</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="TreeDataProvider.html#onDidChangeTreeData" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Tree<wbr>Data</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="TreeDataProvider.html#getTreeItem" class="tsd-kind-icon">get<wbr>Tree<wbr>Item</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="TreeDataProvider.html#getChildren" class="tsd-kind-icon">get<wbr>Children</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="TreeDataProvider.html#getParent" class="tsd-kind-icon">get<wbr>Parent</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-interface">
<a href="TreeDataProvider.html#resolveTreeItem" class="tsd-kind-icon">resolve<wbr>Tree<wbr>Item</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>
Reference in new issue View Git Blame Copy Permalink