A webview based view.

Fields

read onlywebview:Webview

The underlying webview for the view.

read onlyvisible:Bool

Tracks if the webview is currently visible.

Views are visible when they are on the screen and expanded.

read onlyviewType:String

Identifies the type of the webview view, such as 'hexEditor.dataView'.

@:optionaloptionaltitle:Null<String>

View title displayed in the UI.

The view title is initially taken from the extension package.json contribution.

show(?preserveFocus:Bool):Void

Reveal the view in the UI.

If the view is collapsed, this will expand it.

Parameters:

preserveFocus

When true the view will not take focus.

read onlyonDidDispose:Event<Void>

Event fired when the view is disposed.

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).

Trying to use the view after it has been disposed throws an exception.

read onlyonDidChangeVisibility:Event<Void>

Event fired when the visibility of the view changes.

Actions that trigger a visibility change:

  • The view is collapsed or expanded.
  • The user switches to a different view group in the sidebar or panel.

Note that hiding a view using the context menu instead disposes of the view and fires onDidDispose.

@:optionaloptionaldescription:Null<String>

Human-readable string which is rendered less prominently in the title.