Class WebviewsExtImpl

constructor

• new WebviewsExtImpl(): WebviewsExtImpl

  Returns WebviewsExtImpl

ReadonlyonDidDispose

ReadonlyonDidDisposeEmitter

$deserializeWebviewPanel

• $deserializeWebviewPanel(
      viewId: string,
      viewType: string,
      title: string,
      state: any,
      viewState: WebviewPanelViewState,
      options: WebviewOptions & WebviewPanelOptions,
  ): PromiseLike<void>

  Parameters

  • viewId: string
  • viewType: string
  • title: string
  • state: any

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

  • viewState: WebviewPanelViewState
  • options: WebviewOptions & WebviewPanelOptions

  Returns PromiseLike<void>

$onDidChangeWebviewPanelViewState

• $onDidChangeWebviewPanelViewState(
      handle: string,
      newState: WebviewPanelViewState,
  ): void

  Parameters

  • handle: string
  • newState: WebviewPanelViewState

  Returns void

$onDidDisposeWebviewPanel

• $onDidDisposeWebviewPanel(handle: string): PromiseLike<void>

  Parameters

  • handle: string

  Returns PromiseLike<void>

$onMessage

• $onMessage(handle: string, message: any): void

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

  Parameters

  • handle: string
  • message: any

  Returns void

createNewWebview

• createNewWebview(
      options: WebviewPanelOptions & WebviewOptions,
      plugin: Plugin,
      viewId: string,
      origin?: string,
  ): WebviewImpl

  Parameters

  • options: WebviewPanelOptions & WebviewOptions
  • plugin: Plugin
  • viewId: string
  • Optionalorigin: string

  Returns WebviewImpl

createWebview

• createWebview(
      viewType: string,
      title: string,
      showOptions: ViewColumn | WebviewPanelShowOptions,
      options: WebviewPanelOptions & WebviewOptions,
      plugin: Plugin,
  ): WebviewPanel

  Parameters

  • viewType: string
  • title: string
  • showOptions: ViewColumn | WebviewPanelShowOptions
  • options: WebviewPanelOptions & WebviewOptions
  • plugin: Plugin

  Returns WebviewPanel

createWebviewPanel

• createWebviewPanel(
      viewType: string,
      title: string,
      showOptions: ViewColumn | WebviewPanelShowOptions,
      options: WebviewPanelOptions & WebviewOptions,
      plugin: Plugin,
      viewId: string,
      originBasedOnType?: boolean,
  ): WebviewPanelImpl

  Creates a new webview panel.

  Parameters

  • viewType: string

    Identifies the type of the webview panel.

  • title: string

    Title of the panel.

  • showOptions: ViewColumn | WebviewPanelShowOptions

    Where webview panel will be reside.

  • options: WebviewPanelOptions & WebviewOptions

    Settings for the new panel.

  • plugin: Plugin

    The plugin contributing the webview.

  • viewId: string

    The identifier of the webview instance.

  • originBasedOnType: boolean = true

    true if a stable origin based on the viewType shall be used, false if the viewId should be used.

  Returns WebviewPanelImpl

  The new webview panel.

deleteWebview

• deleteWebview(handle: string): void

  Parameters

  • handle: string

  Returns void

getResourceRoot

• getResourceRoot(): undefined | string

  Returns undefined | string

getWebview

• getWebview(handle: string): undefined | WebviewImpl

  Parameters

  • handle: string

  Returns undefined | WebviewImpl

getWebviewPanel

• getWebviewPanel(viewId: string): undefined | WebviewPanelImpl

  Parameters

  • viewId: string

  Returns undefined | WebviewPanelImpl

init

• init(initData: WebviewInitData): void

  Parameters

  • initData: WebviewInitData

  Returns void

initialize

• initialize(): void

  Returns void

registerWebviewPanelSerializer

• registerWebviewPanelSerializer(
      viewType: string,
      serializer: WebviewPanelSerializer,
      plugin: Plugin,
  ): Disposable

  Parameters

  • viewType: string
  • serializer: WebviewPanelSerializer
  • plugin: Plugin

  Returns Disposable

toGeneralWebviewResource

• toGeneralWebviewResource(extension: PluginModel, resource: Uri): Uri

  Parameters

  • extension: PluginModel
  • resource: Uri

  Returns Uri