Dockview
Preparing search index...
dockview-core
IPaneviewComponent
Interface IPaneviewComponent
interface
IPaneviewComponent
{
height
:
number
;
id
:
string
;
maximumSize
:
number
;
minimumSize
:
number
;
onDidAddView
:
DockviewEvent
<
PaneviewPanel
>
;
onDidDrop
:
DockviewEvent
<
PaneviewDidDropEvent
>
;
onDidLayoutChange
:
DockviewEvent
<
void
>
;
onDidLayoutFromJSON
:
DockviewEvent
<
void
>
;
onDidRemoveView
:
DockviewEvent
<
PaneviewPanel
>
;
onUnhandledDragOver
:
DockviewEvent
<
PaneviewDndOverlayEvent
>
;
options
:
PaneviewComponentOptions
;
panels
:
IPaneviewPanel
[]
;
width
:
number
;
addPanel
<
T
extends
object
=
Parameters
>
(
options
:
AddPaneviewComponentOptions
<
T
>
,
)
:
IPaneviewPanel
;
clear
()
:
void
;
dispose
()
:
void
;
focus
()
:
void
;
fromJSON
(
serializedPaneview
:
SerializedPaneview
)
:
void
;
getPanel
(
id
:
string
)
:
IPaneviewPanel
|
undefined
;
layout
(
width
:
number
,
height
:
number
)
:
void
;
movePanel
(
from
:
number
,
to
:
number
)
:
void
;
removePanel
(
panel
:
IPaneviewPanel
)
:
void
;
setVisible
(
panel
:
IPaneviewPanel
,
visible
:
boolean
)
:
void
;
toJSON
()
:
SerializedPaneview
;
updateOptions
(
options
:
Partial
<
PaneviewComponentOptions
>
)
:
void
;
}
Hierarchy (
View Summary
)
DockviewIDisposable
IPaneviewComponent
Implemented by
PaneviewComponent
Index
Properties
height
id
maximum
Size
minimum
Size
on
Did
Add
View
on
Did
Drop
on
Did
Layout
Change
on
Did
Layout
From
JSON
on
Did
Remove
View
on
Unhandled
Drag
Over
options
panels
width
Methods
add
Panel
clear
dispose
focus
from
JSON
get
Panel
layout
move
Panel
remove
Panel
set
Visible
to
JSON
update
Options
Properties
Readonly
height
height
:
number
Readonly
id
id
:
string
Readonly
maximum
Size
maximumSize
:
number
Readonly
minimum
Size
minimumSize
:
number
Readonly
on
Did
Add
View
onDidAddView
:
DockviewEvent
<
PaneviewPanel
>
Readonly
on
Did
Drop
onDidDrop
:
DockviewEvent
<
PaneviewDidDropEvent
>
Readonly
on
Did
Layout
Change
onDidLayoutChange
:
DockviewEvent
<
void
>
Readonly
on
Did
Layout
From
JSON
onDidLayoutFromJSON
:
DockviewEvent
<
void
>
Readonly
on
Did
Remove
View
onDidRemoveView
:
DockviewEvent
<
PaneviewPanel
>
Readonly
on
Unhandled
Drag
Over
onUnhandledDragOver
:
DockviewEvent
<
PaneviewDndOverlayEvent
>
Readonly
options
options
:
PaneviewComponentOptions
Readonly
panels
panels
:
IPaneviewPanel
[]
Readonly
width
width
:
number
Methods
add
Panel
addPanel
<
T
extends
object
=
Parameters
>
(
options
:
AddPaneviewComponentOptions
<
T
>
,
)
:
IPaneviewPanel
Type Parameters
T
extends
object
=
Parameters
Parameters
options
:
AddPaneviewComponentOptions
<
T
>
Returns
IPaneviewPanel
clear
clear
()
:
void
Returns
void
dispose
dispose
()
:
void
Returns
void
focus
focus
()
:
void
Returns
void
from
JSON
fromJSON
(
serializedPaneview
:
SerializedPaneview
)
:
void
Parameters
serializedPaneview
:
SerializedPaneview
Returns
void
get
Panel
getPanel
(
id
:
string
)
:
IPaneviewPanel
|
undefined
Parameters
id
:
string
Returns
IPaneviewPanel
|
undefined
layout
layout
(
width
:
number
,
height
:
number
)
:
void
Parameters
width
:
number
height
:
number
Returns
void
move
Panel
movePanel
(
from
:
number
,
to
:
number
)
:
void
Parameters
from
:
number
to
:
number
Returns
void
remove
Panel
removePanel
(
panel
:
IPaneviewPanel
)
:
void
Parameters
panel
:
IPaneviewPanel
Returns
void
set
Visible
setVisible
(
panel
:
IPaneviewPanel
,
visible
:
boolean
)
:
void
Parameters
panel
:
IPaneviewPanel
visible
:
boolean
Returns
void
to
JSON
toJSON
()
:
SerializedPaneview
Returns
SerializedPaneview
update
Options
updateOptions
(
options
:
Partial
<
PaneviewComponentOptions
>
)
:
void
Parameters
options
:
Partial
<
PaneviewComponentOptions
>
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
height
id
maximum
Size
minimum
Size
on
Did
Add
View
on
Did
Drop
on
Did
Layout
Change
on
Did
Layout
From
JSON
on
Did
Remove
View
on
Unhandled
Drag
Over
options
panels
width
Methods
add
Panel
clear
dispose
focus
from
JSON
get
Panel
layout
move
Panel
remove
Panel
set
Visible
to
JSON
update
Options
Dockview
Loading...