跳转到主内容

界面：WebviewPanel

定义于： packages/extension-api/src/extension-api.d.ts:2024

包含一个 Webview 的面板。

属性​

active​

readonly active: boolean

定义于： packages/extension-api/src/extension-api.d.ts:2059

面板是否为活动状态（用户聚焦）。

iconPath?​

optional iconPath: Uri | { dark: Uri; light: Uri; }

定义于： packages/extension-api/src/extension-api.d.ts:2038

面板在 UI 中显示的图标。

Type Declaration​

Uri

{ dark: Uri; light: Uri; }

dark​

readonly dark: Uri

深色主题的图标路径。

light​

readonly light: Uri

浅色主题的图标路径。

onDidChangeViewState​

readonly onDidChangeViewState: Event<WebviewPanelOnDidChangeViewStateEvent>

定义于： packages/extension-api/src/extension-api.d.ts:2069

面板的视图状态更改时触发。

onDidDispose​

readonly onDidDispose: Event<void>

定义于： packages/extension-api/src/extension-api.d.ts:2079

面板被释放时触发。

这可能是因为用户关闭了面板，或者在面板上调用了 .dispose()。

在面板被释放后尝试使用该面板会抛出异常。

title​

title: string

定义于： packages/extension-api/src/extension-api.d.ts:2033

面板在 UI 中显示的标题。

viewType​

readonly viewType: string

定义于： packages/extension-api/src/extension-api.d.ts:2028

标识 Webview 面板的类型。

visible​

readonly visible: boolean

定义于： packages/extension-api/src/extension-api.d.ts:2064

面板是否可见。

webview​

readonly webview: Webview

定义于： packages/extension-api/src/extension-api.d.ts:2054

属于面板的 Webview。

方法​

dispose()​

dispose(): void

定义于： packages/extension-api/src/extension-api.d.ts:2094

释放 Webview 面板。

这会关闭正在显示的面板，并释放 Webview 所拥有的资源。当用户关闭 Webview 面板时，Webview 面板也会被释放。这两种情况都会触发 onDispose 事件。

返回​

void

reveal()​

reveal(preserveFocus?): void

定义于： packages/extension-api/src/extension-api.d.ts:2085

显示 Webview 面板。

参数​

preserveFocus?​

boolean

如果为 true，Webview 将不会获得焦点。

返回值​

void