|
|
|
|
|
<!doctype html>
|
|
|
|
|
|
<html class="default no-js">
|
|
|
|
|
|
<head>
|
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
|
|
|
|
<title>TreeItem | 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>
|
|
|
|
|
|
a[title="站长统计"] {
|
|
|
|
|
|
display: none;
|
|
|
|
|
|
}
|
|
|
|
|
|
.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="../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/vscode-cn/vscode-api-cn/blob/df4d2e0/vscode.d.ts#L9380">vscode.d.ts:9380</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/vscode-cn/vscode-api-cn/blob/df4d2e0/vscode.d.ts#L9386">vscode.d.ts:9386</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/vscode-cn/vscode-api-cn/blob/df4d2e0/vscode.d.ts#L9300">vscode.d.ts:9300</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/vscode-cn/vscode-api-cn/blob/df4d2e0/vscode.d.ts#L9307">vscode.d.ts:9307</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/vscode-cn/vscode-api-cn/blob/df4d2e0/vscode.d.ts#L9314">vscode.d.ts:9314</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/vscode-cn/vscode-api-cn/blob/df4d2e0/vscode.d.ts#L9320">vscode.d.ts:9320</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/vscode-cn/vscode-api-cn/blob/df4d2e0/vscode.d.ts#L9328">vscode.d.ts:9328</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/vscode-cn/vscode-api-cn/blob/df4d2e0/vscode.d.ts#L9333">vscode.d.ts:9333</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/vscode-cn/vscode-api-cn/blob/df4d2e0/vscode.d.ts#L9342">vscode.d.ts:9342</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/vscode-cn/vscode-api-cn/blob/df4d2e0/vscode.d.ts#L9347">vscode.d.ts:9347</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/vscode-cn/vscode-api-cn/blob/df4d2e0/vscode.d.ts#L9367">vscode.d.ts:9367</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/vscode-cn/vscode-api-cn/blob/df4d2e0/vscode.d.ts#L9374">vscode.d.ts:9374</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">
|
|
|
|
|
|
<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://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> | <a href="https://www.cnzz.com/stat/website.php?web_id=1280241129" target="_blank" title="VS Code 官网文档站长统计">站长统计</a></p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div class="overlay"></div>
|
|
|
|
|
|
<script src="../assets/js/main.js"></script>
|
|
|
|
|
|
<script type="text/javascript">document.write(unescape("%3Cspan id='cnzz_stat_icon_1280241129'%3E%3C/span%3E%3Cscript src='https://s9.cnzz.com/z_stat.php%3Fid%3D1280241129' type='text/javascript'%3E%3C/script%3E"));</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: fixed; 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>
|
