Class WebviewPanelImpl

constructor

• new WebviewPanelImpl(
      viewId: string,
      proxy: WebviewsMain,
      _viewType: string,
      _title: string,
      showOptions: ViewColumn | WebviewPanelShowOptions,
      _options: WebviewPanelOptions,
      _webview: WebviewImpl,
  ): WebviewPanelImpl

  Parameters

  • viewId: string
  • proxy: WebviewsMain
  • _viewType: string
  • _title: string
  • showOptions: ViewColumn | WebviewPanelShowOptions
  • _options: WebviewPanelOptions
  • _webview: WebviewImpl

  Returns WebviewPanelImpl

ReadonlyonDidChangeViewState

ReadonlyonDidChangeViewStateEmitter

ReadonlyonDidDispose

ReadonlyonDisposeEmitter

active

• get active(): boolean

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

  Returns boolean

iconPath

• get iconPath(): undefined | Uri | { dark: Uri; light: Uri }

  Icon for the panel shown in UI.

  Returns undefined | Uri | { dark: Uri; light: Uri }

• set iconPath(iconPath: undefined | Uri | { dark: Uri; light: Uri }): void

  Icon for the panel shown in UI.

  Parameters

  • iconPath: undefined | Uri | { dark: Uri; light: Uri }

  Returns void

options

• get options(): WebviewPanelOptions

  Content settings for the webview panel.

  Returns WebviewPanelOptions

showOptions

• get showOptions(): WebviewPanelShowOptions

  Settings to determine where webview panel will be reside

  Returns WebviewPanelShowOptions

title

• get title(): string

  Title of the panel shown in UI.

  Returns string

• set title(newTitle: string): void

  Title of the panel shown in UI.

  Parameters

  • newTitle: string

  Returns void

viewColumn

• get viewColumn(): undefined | ViewColumn

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

  Returns undefined | ViewColumn

viewType

• get viewType(): string

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

  Returns string

visible

• get visible(): boolean

  Whether the panel is visible.

  Returns boolean

webview

• get webview(): WebviewImpl

  Webview belonging to the panel.

  Returns WebviewImpl

dispose

• dispose(): void

  Dispose of the webview panel.

  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 onDispose event.

  Returns void

postMessage

• postMessage(message: any): PromiseLike<boolean>

  eslint-disable-next-line @typescript-eslint/no-explicit-any

  Parameters

  • message: any

  Returns PromiseLike<boolean>

reveal

• reveal(
      arg0?: ViewColumn | WebviewPanelTargetArea,
      arg1?: boolean | ViewColumn,
      arg2?: boolean,
  ): void

  Show the webview panel according to a given options.

  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.

  Parameters

  • Optionalarg0: ViewColumn | WebviewPanelTargetArea

    target area where webview panel will be resided. Shows in the 'WebviewPanelTargetArea.Main' area if undefined.

  • Optionalarg1: boolean | ViewColumn

    View column to show the panel in. Shows in the current viewColumn if undefined.

  • Optionalarg2: boolean

    When true, the webview will not take focus.

  Returns void

setActive

• setActive(value: boolean): void

  Parameters

  • value: boolean

  Returns void

setShowOptions

• setShowOptions(value: WebviewPanelShowOptions): void

  Parameters

  • value: WebviewPanelShowOptions

  Returns void

setViewColumn

• setViewColumn(value: undefined | ViewColumn): void

  Parameters

  • value: undefined | ViewColumn

  Returns void

setVisible

• setVisible(value: boolean): void

  Parameters

  • value: boolean

  Returns void