WebviewPanel

A panel that contains a Webview.

Online Documentation

Properties

Link copied to clipboard
abstract external val active: Boolean

Whether the panel is active (focused by the user).

Link copied to clipboard
abstract external var iconPath: IconPath?

Icon for the panel shown in UI.

Link copied to clipboard

Fired when the panel's view state changes.

Link copied to clipboard
abstract external val onDidDispose: Event<Void>

Fired when the panel is disposed.

Link copied to clipboard
abstract external val options: WebviewPanelOptions

Content settings for the webview panel.

Link copied to clipboard
abstract external var title: String

Title of the panel shown in UI.

Link copied to clipboard
abstract external val viewColumn: ViewColumn?

Editor position of the panel. This property is only set if the webview is in one of the editor view columns.

Link copied to clipboard
abstract external val viewType: String

Identifies the type of the webview panel, such as 'markdown.preview'.

Link copied to clipboard
abstract external val visible: Boolean

Whether the panel is visible.

Link copied to clipboard
abstract external val webview: Webview

Webview belonging to the panel.

Functions

Link copied to clipboard
abstract external override fun dispose()

Dispose of the webview panel.

Link copied to clipboard
abstract external fun reveal(viewColumn: ViewColumn = definedExternally, preserveFocus: Boolean = definedExternally)

Show the webview panel in a given column.