Theia API Documentation v1.65.0
Eclipse Theia Website
GitHub
Preparing search index...
@theia/plugin-ext
common/plugin-api-rpc
WebviewsMain
Interface WebviewsMain
interface
WebviewsMain
{
$createWebviewPanel
(
handle
:
string
,
viewType
:
string
,
title
:
string
,
showOptions
:
WebviewPanelShowOptions
,
options
:
WebviewPanelOptions
&
WebviewOptions
,
)
:
void
;
$disposeWebview
(
handle
:
string
)
:
void
;
$postMessage
(
handle
:
string
,
value
:
any
)
:
Thenable
<
boolean
>
;
$registerSerializer
(
viewType
:
string
)
:
void
;
$reveal
(
handle
:
string
,
showOptions
:
WebviewPanelShowOptions
)
:
void
;
$setBadge
(
handle
:
string
,
badge
:
undefined
|
ViewBadge
)
:
void
;
$setHtml
(
handle
:
string
,
value
:
string
)
:
void
;
$setIconPath
(
handle
:
string
,
value
:
undefined
|
IconUrl
)
:
void
;
$setOptions
(
handle
:
string
,
options
:
WebviewOptions
)
:
void
;
$setTitle
(
handle
:
string
,
value
:
string
)
:
void
;
$unregisterSerializer
(
viewType
:
string
)
:
void
;
}
Implemented by
WebviewsMainImpl
Index
Methods
$create
Webview
Panel
$dispose
Webview
$post
Message
$register
Serializer
$reveal
$set
Badge
$set
Html
$set
Icon
Path
$set
Options
$set
Title
$unregister
Serializer
Methods
$create
Webview
Panel
$createWebviewPanel
(
handle
:
string
,
viewType
:
string
,
title
:
string
,
showOptions
:
WebviewPanelShowOptions
,
options
:
WebviewPanelOptions
&
WebviewOptions
,
)
:
void
Parameters
handle
:
string
viewType
:
string
title
:
string
showOptions
:
WebviewPanelShowOptions
options
:
WebviewPanelOptions
&
WebviewOptions
Returns
void
$dispose
Webview
$disposeWebview
(
handle
:
string
)
:
void
Parameters
handle
:
string
Returns
void
$post
Message
$postMessage
(
handle
:
string
,
value
:
any
)
:
Thenable
<
boolean
>
Parameters
handle
:
string
value
:
any
Returns
Thenable
<
boolean
>
$register
Serializer
$registerSerializer
(
viewType
:
string
)
:
void
Parameters
viewType
:
string
Returns
void
$reveal
$reveal
(
handle
:
string
,
showOptions
:
WebviewPanelShowOptions
)
:
void
Parameters
handle
:
string
showOptions
:
WebviewPanelShowOptions
Returns
void
$set
Badge
$setBadge
(
handle
:
string
,
badge
:
undefined
|
ViewBadge
)
:
void
Parameters
handle
:
string
badge
:
undefined
|
ViewBadge
Returns
void
$set
Html
$setHtml
(
handle
:
string
,
value
:
string
)
:
void
Parameters
handle
:
string
value
:
string
Returns
void
$set
Icon
Path
$setIconPath
(
handle
:
string
,
value
:
undefined
|
IconUrl
)
:
void
Parameters
handle
:
string
value
:
undefined
|
IconUrl
Returns
void
$set
Options
$setOptions
(
handle
:
string
,
options
:
WebviewOptions
)
:
void
Parameters
handle
:
string
options
:
WebviewOptions
Returns
void
$set
Title
$setTitle
(
handle
:
string
,
value
:
string
)
:
void
Parameters
handle
:
string
value
:
string
Returns
void
$unregister
Serializer
$unregisterSerializer
(
viewType
:
string
)
:
void
Parameters
viewType
:
string
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
$create
Webview
Panel
$dispose
Webview
$post
Message
$register
Serializer
$reveal
$set
Badge
$set
Html
$set
Icon
Path
$set
Options
$set
Title
$unregister
Serializer
Eclipse Theia Website
GitHub
Theia API Documentation v1.65.0
Loading...