|
|
|
|
<!doctype html>
|
|
|
|
|
<html class="default no-js">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8">
|
|
|
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
|
|
|
<title>WebviewView | 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="WebviewView.html">WebviewView</a>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h1>Interface WebviewView</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 webview based view.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel tsd-hierarchy">
|
|
|
|
|
<h3>Hierarchy</h3>
|
|
|
|
|
<ul class="tsd-hierarchy">
|
|
|
|
|
<li>
|
|
|
|
|
<span class="target">WebviewView</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>Properties</h3>
|
|
|
|
|
<ul class="tsd-index-list">
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="WebviewView.html#viewType" class="tsd-kind-icon">view<wbr>Type</a></li>
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="WebviewView.html#webview" class="tsd-kind-icon">webview</a></li>
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="WebviewView.html#title" class="tsd-kind-icon">title</a></li>
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="WebviewView.html#description" class="tsd-kind-icon">description</a></li>
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="WebviewView.html#onDidDispose" class="tsd-kind-icon">on<wbr>Did<wbr>Dispose</a></li>
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="WebviewView.html#visible" class="tsd-kind-icon">visible</a></li>
|
|
|
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="WebviewView.html#onDidChangeVisibility" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Visibility</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="WebviewView.html#show" class="tsd-kind-icon">show</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="viewType" class="tsd-anchor"></a>
|
|
|
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> view<wbr>Type</h3>
|
|
|
|
|
<div class="tsd-signature tsd-kind-icon">view<wbr>Type<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/01cd187/vscode.d.ts#L7696">vscode.d.ts:7696</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Identifies the type of the webview view, such as <code>'hexEditor.dataView'</code>.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a name="webview" class="tsd-anchor"></a>
|
|
|
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> webview</h3>
|
|
|
|
|
<div class="tsd-signature tsd-kind-icon">webview<span class="tsd-signature-symbol">:</span> <a href="Webview.html" class="tsd-signature-type" data-tsd-kind="Interface">Webview</a></div>
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/01cd187/vscode.d.ts#L7701">vscode.d.ts:7701</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>The underlying webview for the view.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a name="title" class="tsd-anchor"></a>
|
|
|
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> title</h3>
|
|
|
|
|
<div class="tsd-signature tsd-kind-icon">title<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/01cd187/vscode.d.ts#L7708">vscode.d.ts:7708</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>View title displayed in the UI.</p>
|
|
|
|
|
</div>
|
|
|
|
|
<p>The view title is initially taken from the extension <code>package.json</code> contribution.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<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></div>
|
|
|
|
|
<aside class="tsd-sources">
|
|
|
|
|
<ul>
|
|
|
|
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api-cn/blob/01cd187/vscode.d.ts#L7713">vscode.d.ts:7713</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Human-readable string which is rendered less prominently in the title.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a name="onDidDispose" class="tsd-anchor"></a>
|
|
|
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> on<wbr>Did<wbr>Dispose</h3>
|
|
|
|
|
<div class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Dispose<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"><</span><span class="tsd-signature-type">void</span><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/01cd187/vscode.d.ts#L7723">vscode.d.ts:7723</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Event fired when the view is disposed.</p>
|
|
|
|
|
</div>
|
|
|
|
|
<p>Views are disposed when they are explicitly hidden by a user (this happens when a user
|
|
|
|
|
right clicks in a view and unchecks the webview view).</p>
|
|
|
|
|
<p>Trying to use the view after it has been disposed throws an exception.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a name="visible" class="tsd-anchor"></a>
|
|
|
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> visible</h3>
|
|
|
|
|
<div class="tsd-signature tsd-kind-icon">visible<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/01cd187/vscode.d.ts#L7730">vscode.d.ts:7730</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Tracks if the webview is currently visible.</p>
|
|
|
|
|
</div>
|
|
|
|
|
<p>Views are visible when they are on the screen and expanded.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</section>
|
|
|
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a name="onDidChangeVisibility" class="tsd-anchor"></a>
|
|
|
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> on<wbr>Did<wbr>Change<wbr>Visibility</h3>
|
|
|
|
|
<div class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Visibility<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"><</span><span class="tsd-signature-type">void</span><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/01cd187/vscode.d.ts#L7742">vscode.d.ts:7742</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Event fired when the visibility of the view changes.</p>
|
|
|
|
|
</div>
|
|
|
|
|
<p>Actions that trigger a visibility change:</p>
|
|
|
|
|
<ul>
|
|
|
|
|
<li>The view is collapsed or expanded.</li>
|
|
|
|
|
<li>The user switches to a different view group in the sidebar or panel.</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<p>Note that hiding a view using the context menu instead disposes of the view and fires <code>onDidDispose</code>.</p>
|
|
|
|
|
</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="show" class="tsd-anchor"></a>
|
|
|
|
|
<h3>show</h3>
|
|
|
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
|
|
|
|
<li class="tsd-signature tsd-kind-icon">show<span class="tsd-signature-symbol">(</span>preserveFocus<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</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-cn/blob/01cd187/vscode.d.ts#L7751">vscode.d.ts:7751</a></li>
|
|
|
|
|
</ul>
|
|
|
|
|
</aside>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<div class="lead">
|
|
|
|
|
<p>Reveal the view in the UI.</p>
|
|
|
|
|
</div>
|
|
|
|
|
<p>If the view is collapsed, this will expand it.</p>
|
|
|
|
|
</div>
|
|
|
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
|
|
|
<ul class="tsd-parameters">
|
|
|
|
|
<li>
|
|
|
|
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> preserveFocus: <span class="tsd-signature-type">boolean</span></h5>
|
|
|
|
|
<div class="tsd-comment tsd-typography">
|
|
|
|
|
<p>When <code>true</code> the view will not take focus.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</li>
|
|
|
|
|
</ul>
|
|
|
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
|
|
|
|
</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">
|
|
|
|
|
<a href="WebviewView.html" class="tsd-kind-icon">Webview<wbr>View</a>
|
|
|
|
|
<ul>
|
|
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a href="WebviewView.html#viewType" class="tsd-kind-icon">view<wbr>Type</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a href="WebviewView.html#webview" class="tsd-kind-icon">webview</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a href="WebviewView.html#title" class="tsd-kind-icon">title</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a href="WebviewView.html#description" class="tsd-kind-icon">description</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a href="WebviewView.html#onDidDispose" class="tsd-kind-icon">on<wbr>Did<wbr>Dispose</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a href="WebviewView.html#visible" class="tsd-kind-icon">visible</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
|
|
|
<a href="WebviewView.html#onDidChangeVisibility" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>Visibility</a>
|
|
|
|
|
</li>
|
|
|
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
|
|
|
|
<a href="WebviewView.html#show" class="tsd-kind-icon">show</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>
|
|
|
|
|
<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 by <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
|
|
|
</div>
|
|
|
|
|
<div class="overlay"></div>
|
|
|
|
|
<script src="../assets/js/main.js"></script>
|
|
|
|
|
</body>
|
|
|
|
|
</html>
|
