Dockview
Preparing search index...
dockview-core
PaneFramework
Class PaneFramework
Hierarchy (
View Summary
)
DraggablePaneviewPanel
PaneFramework
Index
Constructors
constructor
Properties
_
params?
accessor
api
body?
component
header?
header
Component
header
Size
id
on
Did
Change
on
Did
Change
Expansion
State
on
Did
Drop
on
Unhandled
Drag
Over
part?
Accessors
element
header
Visible
height
is
Disposed
maximum
Body
Size
maximum
Size
minimum
Body
Size
minimum
Size
orientation
orthogonal
Size
params
size
width
Methods
add
Disposables
dispose
focus
get
Body
Component
get
Component
get
Header
Component
init
is
Expanded
layout
remove
Disposable
set
Active
set
Expanded
set
Visible
to
JSON
update
Constructors
constructor
new
PaneFramework
(
options
:
{
accessor
:
IPaneviewComponent
;
body
:
IPanePart
;
component
:
string
;
disableDnd
:
boolean
;
header
:
IPanePart
;
headerComponent
:
string
|
undefined
;
headerSize
:
number
;
id
:
string
;
isExpanded
:
boolean
;
maximumBodySize
:
number
;
minimumBodySize
:
number
;
orientation
:
Orientation
;
}
,
)
:
PaneFramework
Parameters
options
:
{
accessor
:
IPaneviewComponent
;
body
:
IPanePart
;
component
:
string
;
disableDnd
:
boolean
;
header
:
IPanePart
;
headerComponent
:
string
|
undefined
;
headerSize
:
number
;
id
:
string
;
isExpanded
:
boolean
;
maximumBodySize
:
number
;
minimumBodySize
:
number
;
orientation
:
Orientation
;
}
Returns
PaneFramework
Properties
Protected
Optional
_
params
_params
?:
PanelInitParameters
Readonly
accessor
accessor
:
IPaneviewComponent
Readonly
api
api
:
PaneviewPanelApiImpl
Protected
Optional
body
body
?:
HTMLElement
Protected
Readonly
component
component
:
string
Protected
Optional
header
header
?:
HTMLElement
Readonly
header
Component
headerComponent
:
string
|
undefined
Readonly
header
Size
headerSize
:
number
Readonly
id
id
:
string
Readonly
on
Did
Change
onDidChange
:
DockviewEvent
<
{
orthogonalSize
?:
number
;
size
?:
number
}
>
= ...
on
Did
Change
Expansion
State
onDidChangeExpansionState
:
DockviewEvent
<
boolean
>
= ...
Readonly
on
Did
Drop
onDidDrop
:
DockviewEvent
<
PaneviewDidDropEvent
>
= ...
Readonly
on
Unhandled
Drag
Over
onUnhandledDragOver
:
DockviewEvent
<
PaneviewDndOverlayEvent
>
= ...
Protected
Optional
part
part
?:
IFrameworkPart
Accessors
element
get
element
()
:
HTMLElement
Returns
HTMLElement
header
Visible
get
headerVisible
()
:
boolean
Returns
boolean
set
headerVisible
(
value
:
boolean
)
:
void
Parameters
value
:
boolean
Returns
void
height
get
height
()
:
number
Returns
number
is
Disposed
get
isDisposed
()
:
boolean
Returns
boolean
maximum
Body
Size
get
maximumBodySize
()
:
number
Returns
number
set
maximumBodySize
(
value
:
number
)
:
void
Parameters
value
:
number
Returns
void
maximum
Size
get
maximumSize
()
:
number
Returns
number
minimum
Body
Size
get
minimumBodySize
()
:
number
Returns
number
set
minimumBodySize
(
value
:
number
)
:
void
Parameters
value
:
number
Returns
void
minimum
Size
get
minimumSize
()
:
number
Returns
number
orientation
get
orientation
()
:
Orientation
Returns
Orientation
set
orientation
(
value
:
Orientation
)
:
void
Parameters
value
:
Orientation
Returns
void
orthogonal
Size
get
orthogonalSize
()
:
number
Returns
number
set
orthogonalSize
(
size
:
number
)
:
void
Parameters
size
:
number
Returns
void
params
get
params
()
:
Parameters
|
undefined
Returns
Parameters
|
undefined
size
get
size
()
:
number
Returns
number
width
get
width
()
:
number
Returns
number
Methods
add
Disposables
addDisposables
(
...
args
:
DockviewIDisposable
[]
)
:
void
Parameters
...
args
:
DockviewIDisposable
[]
Returns
void
dispose
dispose
()
:
void
Returns
void
focus
focus
()
:
void
Returns
void
get
Body
Component
getBodyComponent
()
:
IPanePart
Returns
IPanePart
get
Component
getComponent
()
:
IFrameworkPart
Returns
IFrameworkPart
get
Header
Component
getHeaderComponent
()
:
IPanePart
Returns
IPanePart
init
init
(
parameters
:
PanePanelInitParameter
)
:
void
Parameters
parameters
:
PanePanelInitParameter
Returns
void
is
Expanded
isExpanded
()
:
boolean
Returns
boolean
layout
layout
(
size
:
number
,
orthogonalSize
:
number
)
:
void
Parameters
size
:
number
orthogonalSize
:
number
Returns
void
remove
Disposable
removeDisposable
(
disposable
:
DockviewIDisposable
)
:
void
Parameters
disposable
:
DockviewIDisposable
Returns
void
set
Active
setActive
(
isActive
:
boolean
)
:
void
Parameters
isActive
:
boolean
Returns
void
set
Expanded
setExpanded
(
expanded
:
boolean
)
:
void
Parameters
expanded
:
boolean
Returns
void
set
Visible
setVisible
(
isVisible
:
boolean
)
:
void
Parameters
isVisible
:
boolean
Returns
void
to
JSON
toJSON
()
:
PanePanelViewState
Returns
PanePanelViewState
update
update
(
event
:
PanelUpdateEvent
)
:
void
Parameters
event
:
PanelUpdateEvent
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
_
params
accessor
api
body
component
header
header
Component
header
Size
id
on
Did
Change
on
Did
Change
Expansion
State
on
Did
Drop
on
Unhandled
Drag
Over
part
Accessors
element
header
Visible
height
is
Disposed
maximum
Body
Size
maximum
Size
minimum
Body
Size
minimum
Size
orientation
orthogonal
Size
params
size
width
Methods
add
Disposables
dispose
focus
get
Body
Component
get
Component
get
Header
Component
init
is
Expanded
layout
remove
Disposable
set
Active
set
Expanded
set
Visible
to
JSON
update
Dockview
Loading...