Class DraggablePaneviewPanel`Abstract`

Hierarchy (View Summary)

PaneviewPanel
- DraggablePaneviewPanel
  - PaneFramework

Constructors

constructor

new DraggablePaneviewPanel(
    options: {
        accessor: IPaneviewComponent;
        component: string;
        disableDnd: boolean;
        headerComponent: string | undefined;
        headerSize: number;
        id: string;
        isExpanded: boolean;
        maximumBodySize: number;
        minimumBodySize: number;
        orientation: Orientation;
    },
): DraggablePaneviewPanel
Parameters
- options: {
      accessor: IPaneviewComponent;
      component: string;
      disableDnd: boolean;
      headerComponent: string | undefined;
      headerSize: number;
      id: string;
      isExpanded: boolean;
      maximumBodySize: number;
      minimumBodySize: number;
      orientation: Orientation;
  }
Returns DraggablePaneviewPanel
Overrides PaneviewPanel.constructor
- Defined in paneview/draggablePaneviewPanel.ts:49

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`headerComponent

headerComponent: string | undefined

`Readonly`headerSize

headerSize: number

`Readonly`id

id: string

`Readonly`onDidChange

onDidChange: DockviewEvent<{ orthogonalSize?: number; size?: number }> = ...

onDidChangeExpansionState

onDidChangeExpansionState: DockviewEvent<boolean> = ...

`Readonly`onDidDrop

onDidDrop: DockviewEvent<PaneviewDidDropEvent> = ...

`Readonly`onUnhandledDragOver

onUnhandledDragOver: DockviewEvent<PaneviewDndOverlayEvent> = ...

`Protected` `Optional`part

part?: IFrameworkPart

Accessors

element

get element(): HTMLElement
Returns HTMLElement
Inherited from PaneviewPanel.element
- Defined in gridview/basePanelView.ts:42

headerVisible

get headerVisible(): boolean
Returns boolean
Inherited from PaneviewPanel.headerVisible
- Defined in paneview/paneviewPanel.ts:142
set headerVisible(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from PaneviewPanel.headerVisible
- Defined in paneview/paneviewPanel.ts:146

height

get height(): number
Returns number
Inherited from PaneviewPanel.height
- Defined in gridview/basePanelView.ts:50

isDisposed

get isDisposed(): boolean
Returns boolean
Inherited from PaneviewPanel.isDisposed
- Defined in lifecycle.ts:30

maximumBodySize

get maximumBodySize(): number
Returns number
Inherited from PaneviewPanel.maximumBodySize
- Defined in paneview/paneviewPanel.ts:133
set maximumBodySize(value: number): void
Parameters
- value: number
Returns void
Inherited from PaneviewPanel.maximumBodySize
- Defined in paneview/paneviewPanel.ts:137

maximumSize

get maximumSize(): number
Returns number
Inherited from PaneviewPanel.maximumSize
- Defined in paneview/paneviewPanel.ts:105

minimumBodySize

get minimumBodySize(): number
Returns number
Inherited from PaneviewPanel.minimumBodySize
- Defined in paneview/paneviewPanel.ts:125
set minimumBodySize(value: number): void
Parameters
- value: number
Returns void
Inherited from PaneviewPanel.minimumBodySize
- Defined in paneview/paneviewPanel.ts:129

minimumSize

get minimumSize(): number
Returns number
Inherited from PaneviewPanel.minimumSize
- Defined in paneview/paneviewPanel.ts:97

orientation

get orientation(): Orientation
Returns Orientation
Inherited from PaneviewPanel.orientation
- Defined in paneview/paneviewPanel.ts:93
set orientation(value: Orientation): void
Parameters
- value: Orientation
Returns void
Inherited from PaneviewPanel.orientation
- Defined in paneview/paneviewPanel.ts:89

orthogonalSize

get orthogonalSize(): number
Returns number
Inherited from PaneviewPanel.orthogonalSize
- Defined in paneview/paneviewPanel.ts:117
set orthogonalSize(size: number): void
Parameters
- size: number
Returns void
Inherited from PaneviewPanel.orthogonalSize
- Defined in paneview/paneviewPanel.ts:121

params

get params(): Parameters | undefined
Returns Parameters | undefined
Inherited from PaneviewPanel.params
- Defined in gridview/basePanelView.ts:54

size

get size(): number
Returns number
Inherited from PaneviewPanel.size
- Defined in paneview/paneviewPanel.ts:113

width

get width(): number
Returns number
Inherited from PaneviewPanel.width
- Defined in gridview/basePanelView.ts:46

Methods

addDisposables

addDisposables(...args: DockviewIDisposable[]): void
Parameters
- ...args: DockviewIDisposable[]
Returns void
Inherited from PaneviewPanel.addDisposables
- Defined in lifecycle.ts:38

dispose

dispose(): void
Returns void
Inherited from PaneviewPanel.dispose
- Defined in gridview/basePanelView.ts:148

focus

focus(): void
Returns void
Inherited from PaneviewPanel.focus
- Defined in gridview/basePanelView.ts:86

`Protected` `Abstract`getBodyComponent

getBodyComponent(): IPanePart
Returns IPanePart
Inherited from PaneviewPanel.getBodyComponent
- Defined in paneview/paneviewPanel.ts:344

getComponent

getComponent(): IFrameworkPart
Returns IFrameworkPart
Inherited from PaneviewPanel.getComponent
- Defined in paneview/paneviewPanel.ts:331

`Protected` `Abstract`getHeaderComponent

getHeaderComponent(): IPanePart
Returns IPanePart
Inherited from PaneviewPanel.getHeaderComponent
- Defined in paneview/paneviewPanel.ts:345

init

init(parameters: PanePanelInitParameter): void
Parameters
- parameters: PanePanelInitParameter
Returns void
Inherited from PaneviewPanel.init
- Defined in paneview/paneviewPanel.ts:278

isExpanded

isExpanded(): boolean
Returns boolean
Inherited from PaneviewPanel.isExpanded
- Defined in paneview/paneviewPanel.ts:240

layout

layout(size: number, orthogonalSize: number): void
Parameters
- size: number
- orthogonalSize: number
Returns void
Inherited from PaneviewPanel.layout
- Defined in paneview/paneviewPanel.ts:268

removeDisposable

removeDisposable(disposable: DockviewIDisposable): void
Parameters
- disposable: DockviewIDisposable
Returns void
Inherited from PaneviewPanel.removeDisposable
- Defined in lifecycle.ts:41

setActive

setActive(isActive: boolean): void
Parameters
- isActive: boolean
Returns void
Inherited from PaneviewPanel.setActive
- Defined in paneview/paneviewPanel.ts:236

setExpanded

setExpanded(expanded: boolean): void
Parameters
- expanded: boolean
Returns void
Inherited from PaneviewPanel.setExpanded
- Defined in paneview/paneviewPanel.ts:244

setVisible

setVisible(isVisible: boolean): void
Parameters
- isVisible: boolean
Returns void
Inherited from PaneviewPanel.setVisible
- Defined in paneview/paneviewPanel.ts:232

toJSON

toJSON(): PanePanelViewState
Returns PanePanelViewState
Inherited from PaneviewPanel.toJSON
- Defined in paneview/paneviewPanel.ts:302

update

update(event: PanelUpdateEvent): void
Parameters
- event: PanelUpdateEvent
Returns void
Inherited from PaneviewPanel.update
- Defined in gridview/basePanelView.ts:114