Class WebviewsExtImpl

Hierarchy

WebviewsExtImpl

Implements

WebviewsExt

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WebviewsExtImpl(rpc: RPCProtocol, workspace: WorkspaceExtImpl): WebviewsExtImpl

- Defined in packages/plugin-ext/src/plugin/webviews.ts:34
Parameters
- rpc: RPCProtocol
- workspace: WorkspaceExtImpl
Returns WebviewsExtImpl

Properties

Private initData

initData: undefined | WebviewInitData

Private Readonly proxy

proxy: WebviewsMain

Private Readonly serializers

serializers: Map<string, { plugin: Plugin; serializer: WebviewPanelSerializer<unknown> }> = ...

Private Readonly webviewPanels

webviewPanels: Map<string, WebviewPanelImpl> = ...

Methods

$deserializeWebviewPanel

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

Implementation of WebviewsExt.$deserializeWebviewPanel
- Defined in packages/plugin-ext/src/plugin/webviews.ts:74
Parameters
- viewId: string
- viewType: string
- title: string
- state: any
- viewState: WebviewPanelViewState
- options: WebviewOptions & WebviewPanelOptions
Returns PromiseLike<void>

$onDidChangeWebviewPanelViewState

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

Implementation of WebviewsExt.$onDidChangeWebviewPanelViewState
- Defined in packages/plugin-ext/src/plugin/webviews.ts:54
Parameters
- handle: string
- newState: WebviewPanelViewState
Returns void

$onDidDisposeWebviewPanel

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

Implementation of WebviewsExt.$onDidDisposeWebviewPanel
- Defined in packages/plugin-ext/src/plugin/webviews.ts:66
Parameters
- handle: string
Returns PromiseLike<void>

$onMessage

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

Implementation of WebviewsExt.$onMessage
- Defined in packages/plugin-ext/src/plugin/webviews.ts:48
Parameters
- handle: string
- message: any
Returns void

createWebview

createWebview(viewType: string, title: string, showOptions: Active | Beside | One | Two | Three | Four | Five | Six | Seven | Eight | Nine | WebviewPanelShowOptions, options: WebviewPanelOptions & WebviewOptions, plugin: Plugin): WebviewPanel

- Defined in packages/plugin-ext/src/plugin/webviews.ts:98
Parameters
- viewType: string
- title: string
- showOptions: Active | Beside | One | Two | Three | Four | Five | Six | Seven | Eight | Nine | WebviewPanelShowOptions
- options: WebviewPanelOptions & WebviewOptions
- plugin: Plugin
Returns WebviewPanel

createWebviewPanel

createWebviewPanel(viewType: string, title: string, showOptions: Active | Beside | One | Two | Three | Four | Five | Six | Seven | Eight | Nine | WebviewPanelShowOptions, options: WebviewPanelOptions & WebviewOptions, plugin: Plugin, viewId: string): WebviewPanelImpl

- Defined in packages/plugin-ext/src/plugin/webviews.ts:113
Parameters
- viewType: string
- title: string
- showOptions: Active | Beside | One | Two | Three | Four | Five | Six | Seven | Eight | Nine | WebviewPanelShowOptions
- options: WebviewPanelOptions & WebviewOptions
- plugin: Plugin
- viewId: string
Returns WebviewPanelImpl

getWebviewPanel

getWebviewPanel(viewId: string): undefined | WebviewPanelImpl

- Defined in packages/plugin-ext/src/plugin/webviews.ts:149
Parameters
- viewId: string
Returns undefined | WebviewPanelImpl

init

init(initData: WebviewInitData): void

- Defined in packages/plugin-ext/src/plugin/webviews.ts:43
Parameters
- initData: WebviewInitData
Returns void

registerWebviewPanelSerializer

registerWebviewPanelSerializer(viewType: string, serializer: WebviewPanelSerializer<unknown>, plugin: Plugin): Disposable

- Defined in packages/plugin-ext/src/plugin/webviews.ts:131
Parameters
- viewType: string
- serializer: WebviewPanelSerializer<unknown>
- plugin: Plugin
Returns Disposable