|
|
<!doctype html>
|
|
|
<html class="default no-js" lang="zh-CN">
|
|
|
<head>
|
|
|
<meta charset="utf-8">
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
|
<title>TreeItem | VS Code API 中文文档</title>
|
|
|
<meta name="description" content="VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API，这个站点列出了扩展开发者可以使用的所有 vscode api 中文文档，是 vscode 插件开发必备。">
|
|
|
<meta name="author" content="洛竹">
|
|
|
<meta name="copyright" content="洛竹">
|
|
|
<meta property="og:title" content="Vscode Api 中文文档" />
|
|
|
<meta property="og:type" content="docs">
|
|
|
<meta property="og:image" content="https://code.visualstudio.com/favicon.ico" />
|
|
|
<meta property="og:url" content="https://vscode-api-cn.js.org/index.html">
|
|
|
<meta property="og:site_name" content="Vscode Api 中文文档">
|
|
|
<meta property="article:tag" content="vscode api">
|
|
|
<meta property="article:tag" content="vscode api 中文文档">
|
|
|
<meta property="article:tag" content="vscode 插件">
|
|
|
<meta property="article:tag" content="vscode 插件开发">
|
|
|
<meta property="article:tag" content="vscode VS Code API 中文文档">
|
|
|
<meta property="article:tag" content="vscode TreeItem">
|
|
|
<meta property="og:description" content="VS Code API 是一系列你可以在 Visual Studio Code 扩展中调用的 JavaScript API，这个站点列出了扩展开发者可以使用的所有 vscode api 中文文档，是 vscode 插件开发必备。">
|
|
|
<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='canonical' href='https://vscode-api-cn.js.org/classes/vscode.TreeItem.html' />
|
|
|
<link rel="stylesheet" href="../assets/css/main.css">
|
|
|
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
|
<script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-7962287588031867" crossorigin="anonymous"></script>
|
|
|
<script type="text/javascript">
|
|
|
(function (c, l, a, r, i, t, y) {
|
|
|
c[a] = c[a] || function () { (c[a].q = c[a].q || []).push(arguments) };
|
|
|
t = l.createElement(r); t.async = 1; t.src = "https://www.clarity.ms/tag/" + i;
|
|
|
y = l.getElementsByTagName(r)[0]; y.parentNode.insertBefore(t, y);
|
|
|
})(window, document, "clarity", "script", "g1cbw4nxoq");
|
|
|
</script>
|
|
|
<!-- Google tag (gtag.js) -->
|
|
|
<script async src="https://www.googletagmanager.com/gtag/js?id=G-T4TRRS1LB1"></script>
|
|
|
<script>
|
|
|
window.dataLayer = window.dataLayer || [];
|
|
|
function gtag(){dataLayer.push(arguments);}
|
|
|
gtag('js', new Date());
|
|
|
|
|
|
gtag('config', 'G-T4TRRS1LB1');
|
|
|
</script>
|
|
|
<style>
|
|
|
.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="../modules/vscode.html">vscode</a>
|
|
|
</li>
|
|
|
<li>
|
|
|
<a href="vscode.TreeItem.html">TreeItem</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h1>Class TreeItem</h1>
|
|
|
</div>
|
|
|
</div>
|
|
|
</header>
|
|
|
<div class="container container-main">
|
|
|
<div class="row">
|
|
|
<div class="col-8 col-content">
|
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
|
<h3>层级</h3>
|
|
|
<ul class="tsd-hierarchy">
|
|
|
<li>
|
|
|
<span class="target">TreeItem</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>Constructors（1）</h3>
|
|
|
<ul class="tsd-index-list">
|
|
|
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="vscode.TreeItem.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
<section class="tsd-index-section ">
|
|
|
<h3>Properties（10）</h3>
|
|
|
<ul class="tsd-index-list">
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.TreeItem.html#label" class="tsd-kind-icon">label</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.TreeItem.html#id" class="tsd-kind-icon">id</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.TreeItem.html#iconPath" class="tsd-kind-icon">icon<wbr>Path</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.TreeItem.html#description" class="tsd-kind-icon">description</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.TreeItem.html#resourceUri" class="tsd-kind-icon">resource<wbr>Uri</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.TreeItem.html#tooltip" class="tsd-kind-icon">tooltip</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.TreeItem.html#command" class="tsd-kind-icon">command</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.TreeItem.html#collapsibleState" class="tsd-kind-icon">collapsible<wbr>State</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.TreeItem.html#contextValue" class="tsd-kind-icon">context<wbr>Value</a></li>
|
|
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="vscode.TreeItem.html#accessibilityInformation" class="tsd-kind-icon">accessibility<wbr>Information</a></li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
</div>
|
|
|
</section>
|
|
|
</section>
|
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
|
<h2>Constructors（1）</h2>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
|
<a name="constructor" class="tsd-anchor"></a>
|
|
|
<h3>constructor</h3>
|
|
|
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Tree<wbr>Item<span class="tsd-signature-symbol">(</span>label<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/vscode.TreeItemLabel.html" class="tsd-signature-type" data-tsd-kind="Interface">TreeItemLabel</a>, collapsibleState<span class="tsd-signature-symbol">?: </span><a href="../enums/vscode.TreeItemCollapsibleState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TreeItemCollapsibleState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vscode.TreeItem.html" class="tsd-signature-type" data-tsd-kind="Class">TreeItem</a></li>
|
|
|
<li class="tsd-signature tsd-kind-icon">new <wbr>Tree<wbr>Item<span class="tsd-signature-symbol">(</span>resourceUri<span class="tsd-signature-symbol">: </span><a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a>, collapsibleState<span class="tsd-signature-symbol">?: </span><a href="../enums/vscode.TreeItemCollapsibleState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TreeItemCollapsibleState</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="vscode.TreeItem.html" class="tsd-signature-type" data-tsd-kind="Class">TreeItem</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-cn/blob/bb17da2/vscode.d.ts#L9488">vscode.d.ts:9488</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>label: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/vscode.TreeItemLabel.html" class="tsd-signature-type" data-tsd-kind="Interface">TreeItemLabel</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>A human-readable string describing this item</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> collapsibleState: <a href="../enums/vscode.TreeItemCollapsibleState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TreeItemCollapsibleState</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p><a href="../enums/vscode.TreeItemCollapsibleState.html">TreeItemCollapsibleState</a> of the tree item. Default is <a href="../enums/vscode.TreeItemCollapsibleState.html#None">TreeItemCollapsibleState.None</a></p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="vscode.TreeItem.html" class="tsd-signature-type" data-tsd-kind="Class">TreeItem</a></h4>
|
|
|
</li>
|
|
|
<li class="tsd-description">
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/bb17da2/vscode.d.ts#L9494">vscode.d.ts:9494</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
<ul class="tsd-parameters">
|
|
|
<li>
|
|
|
<h5>resourceUri: <a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<p>The <a href="vscode.Uri.html">Uri</a> of the resource representing this item.</p>
|
|
|
</div>
|
|
|
</li>
|
|
|
<li>
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> collapsibleState: <a href="../enums/vscode.TreeItemCollapsibleState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TreeItemCollapsibleState</a></h5>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p><a href="../enums/vscode.TreeItemCollapsibleState.html">TreeItemCollapsibleState</a> of the tree item. Default is <a href="../enums/vscode.TreeItemCollapsibleState.html#None">TreeItemCollapsibleState.None</a></p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h4 class="tsd-returns-title">Returns <a href="vscode.TreeItem.html" class="tsd-signature-type" data-tsd-kind="Class">TreeItem</a></h4>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</section>
|
|
|
</section>
|
|
|
<section class="tsd-panel-group tsd-member-group ">
|
|
|
<h2>Properties（10）</h2>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="label" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> label</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/vscode.TreeItemLabel.html" class="tsd-signature-type" data-tsd-kind="Interface">TreeItemLabel</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/bb17da2/vscode.d.ts#L9408">vscode.d.ts:9408</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>A human-readable string describing this item. When <code>falsy</code>, it is derived from <a href="vscode.TreeItem.html#resourceUri">resourceUri</a>.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="id" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> id</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/bb17da2/vscode.d.ts#L9415">vscode.d.ts:9415</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Optional id for the tree item that has to be unique across tree. The id is used to preserve the selection and expansion state of the tree item.</p>
|
|
|
</div>
|
|
|
<p>If not provided, an id is generated using the tree item's label. <strong>Note</strong> that when labels change, ids will change and that selection and expansion state cannot be kept stable anymore.</p>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="iconPath" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> icon<wbr>Path</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">icon<wbr>Path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a><span class="tsd-signature-symbol"> | </span><a href="vscode.ThemeIcon.html" class="tsd-signature-type" data-tsd-kind="Class">ThemeIcon</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>light<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a><span class="tsd-signature-symbol">; </span>dark<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a><span class="tsd-signature-symbol"> }</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/bb17da2/vscode.d.ts#L9422">vscode.d.ts:9422</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The icon path or <a href="vscode.ThemeIcon.html">ThemeIcon</a> for the tree item.
|
|
|
When <code>falsy</code>, <a href="vscode.ThemeIcon.html#Folder">Folder Theme Icon</a> is assigned, if item is collapsible otherwise <a href="vscode.ThemeIcon.html#File">File Theme Icon</a>.
|
|
|
When a file or folder <a href="vscode.ThemeIcon.html">ThemeIcon</a> is specified, icon is derived from the current file icon theme for the specified theme icon using <a href="vscode.TreeItem.html#resourceUri">resourceUri</a> (if provided).</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="description" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><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/youngjuning/vscode-api-cn/blob/bb17da2/vscode.d.ts#L9428">vscode.d.ts:9428</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>A human-readable string which is rendered less prominent.
|
|
|
When <code>true</code>, it is derived from <a href="vscode.TreeItem.html#resourceUri">resourceUri</a> and when <code>falsy</code>, it is not shown.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="resourceUri" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> resource<wbr>Uri</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">resource<wbr>Uri<span class="tsd-signature-symbol">:</span> <a href="vscode.Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/bb17da2/vscode.d.ts#L9436">vscode.d.ts:9436</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The <a href="vscode.Uri.html">Uri</a> of the resource representing this item.</p>
|
|
|
</div>
|
|
|
<p>Will be used to derive the <a href="vscode.TreeItem.html#label">label</a>, when it is not provided.
|
|
|
Will be used to derive the icon from current file icon theme, when <a href="vscode.TreeItem.html#iconPath">iconPath</a> has <a href="vscode.ThemeIcon.html">ThemeIcon</a> value.</p>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="tooltip" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tooltip</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">tooltip<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="vscode.MarkdownString.html" class="tsd-signature-type" data-tsd-kind="Class">MarkdownString</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/bb17da2/vscode.d.ts#L9441">vscode.d.ts:9441</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The tooltip text when you hover over this item.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="command" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> command</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">command<span class="tsd-signature-symbol">:</span> <a href="../interfaces/vscode.Command.html" class="tsd-signature-type" data-tsd-kind="Interface">Command</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/bb17da2/vscode.d.ts#L9450">vscode.d.ts:9450</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>The <a href="../interfaces/vscode.Command.html">Command</a> that should be executed when the tree item is selected.</p>
|
|
|
</div>
|
|
|
<p>Please use <code>vscode.open</code> or <code>vscode.diff</code> as command IDs when the tree item is opening
|
|
|
something in the editor. Using these commands ensures that the resulting editor will
|
|
|
appear consistent with how other built-in trees open editors.</p>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="collapsibleState" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> collapsible<wbr>State</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">collapsible<wbr>State<span class="tsd-signature-symbol">:</span> <a href="../enums/vscode.TreeItemCollapsibleState.html" class="tsd-signature-type" data-tsd-kind="Enumeration">TreeItemCollapsibleState</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/bb17da2/vscode.d.ts#L9455">vscode.d.ts:9455</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p><a href="../enums/vscode.TreeItemCollapsibleState.html">TreeItemCollapsibleState</a> of the tree item.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="contextValue" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> context<wbr>Value</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">context<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/bb17da2/vscode.d.ts#L9475">vscode.d.ts:9475</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Context value of the tree item. This can be used to contribute item specific actions in the tree.
|
|
|
For example, a tree item is given a context value as <code>folder</code>. When contributing actions to <code>view/item/context</code>
|
|
|
using <code>menus</code> extension point, you can specify context value for key <code>viewItem</code> in <code>when</code> expression like <code>viewItem == folder</code>.</p>
|
|
|
<pre><code><span style="color: #000000"> </span><span style="color: #A31515">"contributes"</span><span style="color: #000000">: {</span>
|
|
|
<span style="color: #000000"> </span><span style="color: #A31515">"menus"</span><span style="color: #001080">:</span><span style="color: #000000"> {</span>
|
|
|
<span style="color: #000000"> </span><span style="color: #A31515">"view/item/context"</span><span style="color: #001080">:</span><span style="color: #000000"> [</span>
|
|
|
<span style="color: #000000"> {</span>
|
|
|
<span style="color: #000000"> </span><span style="color: #A31515">"command"</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">"extension.deleteFolder"</span><span style="color: #000000">,</span>
|
|
|
<span style="color: #000000"> </span><span style="color: #A31515">"when"</span><span style="color: #001080">:</span><span style="color: #000000"> </span><span style="color: #A31515">"viewItem == folder"</span>
|
|
|
<span style="color: #000000"> }</span>
|
|
|
<span style="color: #000000"> ]</span>
|
|
|
<span style="color: #000000"> }</span>
|
|
|
<span style="color: #000000"> }</span>
|
|
|
</code></pre>
|
|
|
<p>This will show action <code>extension.deleteFolder</code> only for items with <code>contextValue</code> is <code>folder</code>.</p>
|
|
|
</div>
|
|
|
</div>
|
|
|
</section>
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
|
<a name="accessibilityInformation" class="tsd-anchor"></a>
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> accessibility<wbr>Information</h3>
|
|
|
<div class="tsd-signature tsd-kind-icon">accessibility<wbr>Information<span class="tsd-signature-symbol">:</span> <a href="../interfaces/vscode.AccessibilityInformation.html" class="tsd-signature-type" data-tsd-kind="Interface">AccessibilityInformation</a></div>
|
|
|
<aside class="tsd-sources">
|
|
|
<ul>
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/bb17da2/vscode.d.ts#L9482">vscode.d.ts:9482</a></li>
|
|
|
</ul>
|
|
|
</aside>
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
<div class="lead">
|
|
|
<p>Accessibility information used when screen reader interacts with this tree item.
|
|
|
Generally, a TreeItem has no need to set the <code>role</code> of the accessibilityInformation;
|
|
|
however, there are cases where a TreeItem is not displayed in a tree-like way where setting the <code>role</code> may make sense.</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>
|
|
|
<li class="current tsd-kind-namespace">
|
|
|
<a href="../modules/vscode.html">vscode</a>
|
|
|
<ul>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.authentication.html">authentication</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.commands.html">commands</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.comments.html">comments</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.debug.html">debug</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.env.html">env</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.extensions.html">extensions</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.languages.html">languages</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.notebooks.html">notebooks</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.scm.html">scm</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.tasks.html">tasks</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.tests.html">tests</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.window.html">window</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-namespace tsd-parent-kind-namespace">
|
|
|
<a href="../modules/vscode.workspace.html">workspace</a>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
</nav>
|
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
|
|
<div style="width: 200px">
|
|
|
<script type="text/javascript" id="clstr_globe" src="//clustrmaps.com/globe.js?d=cMnk-gSDNcAzNMMm67U8rWRaHnjUc0Xb0giSGndepK4"></script>
|
|
|
</div>
|
|
|
<ul class="before-current">
|
|
|
</ul>
|
|
|
<ul class="current">
|
|
|
<li class="current tsd-kind-class tsd-parent-kind-namespace">
|
|
|
<a href="vscode.TreeItem.html" class="tsd-kind-icon">Tree<wbr>Item</a>
|
|
|
<ul>
|
|
|
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
|
<a href="vscode.TreeItem.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.TreeItem.html#label" class="tsd-kind-icon">label</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.TreeItem.html#id" class="tsd-kind-icon">id</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.TreeItem.html#iconPath" class="tsd-kind-icon">icon<wbr>Path</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.TreeItem.html#description" class="tsd-kind-icon">description</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.TreeItem.html#resourceUri" class="tsd-kind-icon">resource<wbr>Uri</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.TreeItem.html#tooltip" class="tsd-kind-icon">tooltip</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.TreeItem.html#command" class="tsd-kind-icon">command</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.TreeItem.html#collapsibleState" class="tsd-kind-icon">collapsible<wbr>State</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.TreeItem.html#contextValue" class="tsd-kind-icon">context<wbr>Value</a>
|
|
|
</li>
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
|
<a href="vscode.TreeItem.html#accessibilityInformation" class="tsd-kind-icon">accessibility<wbr>Information</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>
|
|
|
</ul>
|
|
|
</div>
|
|
|
</div>
|
|
|
</footer>
|
|
|
<div class="container tsd-generator">
|
|
|
<p>友链：<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>. Maintained by <a href="https://youngjuning.js.org" target="_blank">洛竹</a></p>
|
|
|
</div>
|
|
|
<div class="overlay"></div>
|
|
|
<script src="../assets/js/main.js"></script>
|
|
|
</body>
|
|
|
</html> |
