跳至主要内容

接口:WebviewPanel

包含 Webview 的面板。

属性

active

只读 active: 布尔值

面板是否处于活动状态(由用户聚焦)。

定义在

packages/extension-api/src/extension-api.d.ts:2000


iconPath?

可选 iconPath: Uri | 对象

在 UI 中显示的面板图标。

定义在

packages/extension-api/src/extension-api.d.ts:1979


onDidChangeViewState

只读 onDidChangeViewState: Event<WebviewPanelOnDidChangeViewStateEvent>

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

定义在

packages/extension-api/src/extension-api.d.ts:2010


onDidDispose

只读 onDidDispose: Event<void>

面板被处置时触发。

这可能是因为用户关闭了面板,也可能是因为在它上面调用了 .dispose()

在面板被处置后尝试使用它会抛出异常。

定义在

packages/extension-api/src/extension-api.d.ts:2020


title

title: 字符串

在 UI 中显示的面板标题。

定义在

packages/extension-api/src/extension-api.d.ts:1974


viewType

只读 viewType: 字符串

标识 Webview 面板类型。

定义在

packages/extension-api/src/extension-api.d.ts:1969


visible

只读 visible: 布尔值

面板是否可见。

定义在

packages/extension-api/src/extension-api.d.ts:2005


webview

只读 webview: Webview

Webview 属于面板。

定义在

packages/extension-api/src/extension-api.d.ts:1995

方法

dispose()

dispose(): void

处置 Webview 面板。

如果面板正在显示,则会关闭它并处置 Webview 拥有的资源。当用户关闭 Webview 面板时,Webview 面板也会被处置。这两种情况都会触发 onDispose 事件。

返回值

void

定义在

packages/extension-api/src/extension-api.d.ts:2035


reveal()

reveal(preserveFocus?): void

显示 Webview 面板。

参数

preserveFocus?: 布尔值

true 时,Webview 不会获取焦点。

返回值

void

定义在

packages/extension-api/src/extension-api.d.ts:2026