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.
427 lines
21 KiB
427 lines
21 KiB
3 years ago
|
<!doctype html>
|
||
|
|
<html class="default no-js">
|
||
|
|
<head>
|
||
|
|
<meta charset="utf-8">
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||
|
3 years ago
|
<title>WebviewPanel | VS Code API</title>
|
||
|
|
<meta name="description" content="Documentation for VS Code API">
|
||
|
3 years ago
|
<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>
|
||
|
3 years ago
|
<a href="../index.html" class="title">VS Code API</a>
|
||
|
3 years ago
|
</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>
|
||
|
3 years ago
|
<a href="../modules.html">VS Code API</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li>
|
||
|
3 years ago
|
<a href="WebviewPanel.html">WebviewPanel</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
</ul>
|
||
|
|
<h1>Interface WebviewPanel</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 panel that contains a webview.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-hierarchy">
|
||
|
|
<h3>Hierarchy</h3>
|
||
|
|
<ul class="tsd-hierarchy">
|
||
|
|
<li>
|
||
|
|
<span class="target">WebviewPanel</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">
|
||
|
3 years ago
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="WebviewPanel.html#viewType" class="tsd-kind-icon">view<wbr>Type</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="WebviewPanel.html#title" class="tsd-kind-icon">title</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="WebviewPanel.html#iconPath" class="tsd-kind-icon">icon<wbr>Path</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="WebviewPanel.html#webview" class="tsd-kind-icon">webview</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="WebviewPanel.html#options" class="tsd-kind-icon">options</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="WebviewPanel.html#viewColumn" class="tsd-kind-icon">view<wbr>Column</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="WebviewPanel.html#active" class="tsd-kind-icon">active</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="WebviewPanel.html#visible" class="tsd-kind-icon">visible</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="WebviewPanel.html#onDidChangeViewState" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>View<wbr>State</a></li>
|
||
|
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="WebviewPanel.html#onDidDispose" class="tsd-kind-icon">on<wbr>Did<wbr>Dispose</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-index-section ">
|
||
|
|
<h3>Methods</h3>
|
||
|
|
<ul class="tsd-index-list">
|
||
|
3 years ago
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="WebviewPanel.html#reveal" class="tsd-kind-icon">reveal</a></li>
|
||
|
|
<li class="tsd-kind-method tsd-parent-kind-interface"><a href="WebviewPanel.html#dispose" class="tsd-kind-icon">dispose</a></li>
|
||
|
3 years ago
|
</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>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L7557">vscode.d.ts:7557</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>Identifies the type of the webview panel, such as <code>'markdown.preview'</code>.</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>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>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L7562">vscode.d.ts:7562</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>Title of the panel shown in UI.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||
|
|
<a name="iconPath" class="tsd-anchor"></a>
|
||
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> icon<wbr>Path</h3>
|
||
|
3 years ago
|
<div class="tsd-signature tsd-kind-icon">icon<wbr>Path<span class="tsd-signature-symbol">:</span> <a href="../classes/Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-symbol">{ </span>light<span class="tsd-signature-symbol">: </span><a href="../classes/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><a href="../classes/Uri.html" class="tsd-signature-type" data-tsd-kind="Class">Uri</a><span class="tsd-signature-symbol"> }</span></div>
|
||
|
3 years ago
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L7567">vscode.d.ts:7567</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>Icon for the panel shown in UI.</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>
|
||
|
3 years ago
|
<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>
|
||
|
3 years ago
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L7572">vscode.d.ts:7572</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
3 years ago
|
<p><a href="Webview.html"><code>Webview</code></a> belonging to the panel.</p>
|
||
|
3 years ago
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||
|
|
<a name="options" class="tsd-anchor"></a>
|
||
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> options</h3>
|
||
|
3 years ago
|
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span> <a href="WebviewPanelOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">WebviewPanelOptions</a></div>
|
||
|
3 years ago
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L7577">vscode.d.ts:7577</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>Content settings for the webview panel.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||
|
|
<a name="viewColumn" class="tsd-anchor"></a>
|
||
|
|
<h3><span class="tsd-flag ts-flagOptional">Optional</span> <span class="tsd-flag ts-flagReadonly">Readonly</span> view<wbr>Column</h3>
|
||
|
3 years ago
|
<div class="tsd-signature tsd-kind-icon">view<wbr>Column<span class="tsd-signature-symbol">:</span> <a href="../enums/ViewColumn.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ViewColumn</a></div>
|
||
|
3 years ago
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L7583">vscode.d.ts:7583</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>Editor position of the panel. This property is only set if the webview is in
|
||
|
|
one of the editor view columns.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||
|
|
<a name="active" class="tsd-anchor"></a>
|
||
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> active</h3>
|
||
|
|
<div class="tsd-signature tsd-kind-icon">active<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L7588">vscode.d.ts:7588</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>Whether the panel is active (focused by the user).</p>
|
||
|
|
</div>
|
||
|
|
</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>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L7593">vscode.d.ts:7593</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>Whether the panel is visible.</p>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</section>
|
||
|
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||
|
|
<a name="onDidChangeViewState" class="tsd-anchor"></a>
|
||
|
|
<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> on<wbr>Did<wbr>Change<wbr>View<wbr>State</h3>
|
||
|
3 years ago
|
<div class="tsd-signature tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>View<wbr>State<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><a href="WebviewPanelOnDidChangeViewStateEvent.html" class="tsd-signature-type" data-tsd-kind="Interface">WebviewPanelOnDidChangeViewStateEvent</a><span class="tsd-signature-symbol">></span></div>
|
||
|
3 years ago
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L7598">vscode.d.ts:7598</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>Fired when the panel's view state changes.</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>
|
||
|
3 years ago
|
<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>
|
||
|
3 years ago
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L7608">vscode.d.ts:7608</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>Fired when the panel is disposed.</p>
|
||
|
|
</div>
|
||
|
|
<p>This may be because the user closed the panel or because <code>.dispose()</code> was
|
||
|
|
called on it.</p>
|
||
|
|
<p>Trying to use the panel after it has been disposed throws an exception.</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="reveal" class="tsd-anchor"></a>
|
||
|
|
<h3>reveal</h3>
|
||
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||
|
3 years ago
|
<li class="tsd-signature tsd-kind-icon">reveal<span class="tsd-signature-symbol">(</span>viewColumn<span class="tsd-signature-symbol">?: </span><a href="../enums/ViewColumn.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ViewColumn</a>, 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>
|
||
|
3 years ago
|
</ul>
|
||
|
|
<ul class="tsd-descriptions">
|
||
|
|
<li class="tsd-description">
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L7619">vscode.d.ts:7619</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>Show the webview panel in a given column.</p>
|
||
|
|
</div>
|
||
|
|
<p>A webview panel may only show in a single column at a time. If it is already showing, this
|
||
|
|
method moves it to a new column.</p>
|
||
|
|
</div>
|
||
|
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
||
|
|
<ul class="tsd-parameters">
|
||
|
|
<li>
|
||
|
3 years ago
|
<h5><span class="tsd-flag ts-flagOptional">Optional</span> viewColumn: <a href="../enums/ViewColumn.html" class="tsd-signature-type" data-tsd-kind="Enumeration">ViewColumn</a></h5>
|
||
|
3 years ago
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<p>View column to show the panel in. Shows in the current <code>viewColumn</code> if undefined.</p>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
<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 webview 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 class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-interface">
|
||
|
|
<a name="dispose" class="tsd-anchor"></a>
|
||
|
|
<h3>dispose</h3>
|
||
|
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-interface">
|
||
|
|
<li class="tsd-signature tsd-kind-icon">dispose<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||
|
|
</ul>
|
||
|
|
<ul class="tsd-descriptions">
|
||
|
|
<li class="tsd-description">
|
||
|
|
<aside class="tsd-sources">
|
||
|
|
<ul>
|
||
|
3 years ago
|
<li>Defined in <a href="https://github.com/youngjuning/vscode-api/blob/branch/vscode.d.ts#L7628">vscode.d.ts:7628</a></li>
|
||
|
3 years ago
|
</ul>
|
||
|
|
</aside>
|
||
|
|
<div class="tsd-comment tsd-typography">
|
||
|
|
<div class="lead">
|
||
|
|
<p>Dispose of the webview panel.</p>
|
||
|
|
</div>
|
||
|
|
<p>This closes the panel if it showing and disposes of the resources owned by the webview.
|
||
|
|
Webview panels are also disposed when the user closes the webview panel. Both cases
|
||
|
|
fire the <code>onDispose</code> event.</p>
|
||
|
|
</div>
|
||
|
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</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="../modules.html">Exports</a>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</nav>
|
||
|
|
<nav class="tsd-navigation secondary menu-sticky">
|
||
|
|
<ul class="before-current">
|
||
|
|
</ul>
|
||
|
|
<ul class="current">
|
||
|
3 years ago
|
<li class="current tsd-kind-interface">
|
||
|
|
<a href="WebviewPanel.html" class="tsd-kind-icon">Webview<wbr>Panel</a>
|
||
|
3 years ago
|
<ul>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||
|
3 years ago
|
<a href="WebviewPanel.html#viewType" class="tsd-kind-icon">view<wbr>Type</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||
|
3 years ago
|
<a href="WebviewPanel.html#title" class="tsd-kind-icon">title</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||
|
3 years ago
|
<a href="WebviewPanel.html#iconPath" class="tsd-kind-icon">icon<wbr>Path</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||
|
3 years ago
|
<a href="WebviewPanel.html#webview" class="tsd-kind-icon">webview</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||
|
3 years ago
|
<a href="WebviewPanel.html#options" class="tsd-kind-icon">options</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||
|
3 years ago
|
<a href="WebviewPanel.html#viewColumn" class="tsd-kind-icon">view<wbr>Column</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||
|
3 years ago
|
<a href="WebviewPanel.html#active" class="tsd-kind-icon">active</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||
|
3 years ago
|
<a href="WebviewPanel.html#visible" class="tsd-kind-icon">visible</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||
|
3 years ago
|
<a href="WebviewPanel.html#onDidChangeViewState" class="tsd-kind-icon">on<wbr>Did<wbr>Change<wbr>View<wbr>State</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||
|
3 years ago
|
<a href="WebviewPanel.html#onDidDispose" class="tsd-kind-icon">on<wbr>Did<wbr>Dispose</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||
|
3 years ago
|
<a href="WebviewPanel.html#reveal" class="tsd-kind-icon">reveal</a>
|
||
|
3 years ago
|
</li>
|
||
|
|
<li class=" tsd-kind-method tsd-parent-kind-interface">
|
||
|
3 years ago
|
<a href="WebviewPanel.html#dispose" class="tsd-kind-icon">dispose</a>
|
||
|
3 years ago
|
</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">
|
||
|
3 years ago
|
<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>
|
||
|
3 years ago
|
<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>
|
||
|
3 years ago
|
<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>
|
||
|
3 years ago
|
</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>
|