Class PaneviewPanel`Abstract`

Hierarchy (View Summary)

BasePanelView<PaneviewPanelApiImpl>
- PaneviewPanel
  - DraggablePaneviewPanel

Implements

Constructors

constructor

new PaneviewPanel(
    options: {
        component: string;
        headerComponent: string | undefined;
        headerSize: number;
        id: string;
        isExpanded: boolean;
        isHeaderVisible: boolean;
        maximumBodySize: number;
        minimumBodySize: number;
        orientation: Orientation;
    },
): PaneviewPanel
Parameters
- options: {
      component: string;
      headerComponent: string | undefined;
      headerSize: number;
      id: string;
      isExpanded: boolean;
      isHeaderVisible: boolean;
      maximumBodySize: number;
      minimumBodySize: number;
      orientation: Orientation;
  }
Returns PaneviewPanel
Overrides BasePanelView<PaneviewPanelApiImpl>.constructor
- Defined in paneview/paneviewPanel.ts:151

Properties

`Protected` `Optional`_params

_params?: PanelInitParameters

`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> = ...

`Protected` `Optional`part

part?: IFrameworkPart

Accessors

element

get element(): HTMLElement
Returns HTMLElement
Implementation of IPaneview.element
Inherited from BasePanelView.element
- Defined in gridview/basePanelView.ts:42

headerVisible

get headerVisible(): boolean
Returns boolean
Implementation of IPaneviewPanel.headerVisible
- Defined in paneview/paneviewPanel.ts:142
set headerVisible(value: boolean): void
Parameters
- value: boolean
Returns void
Implementation of IPaneviewPanel.headerVisible
- Defined in paneview/paneviewPanel.ts:146

height

get height(): number
Returns number
Implementation of IPaneviewPanel.height
Inherited from BasePanelView.height
- Defined in gridview/basePanelView.ts:50

isDisposed

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

maximumBodySize

get maximumBodySize(): number
Returns number
Implementation of IPaneviewPanel.maximumBodySize
- Defined in paneview/paneviewPanel.ts:133
set maximumBodySize(value: number): void
Parameters
- value: number
Returns void
Implementation of IPaneviewPanel.maximumBodySize
- Defined in paneview/paneviewPanel.ts:137

maximumSize

get maximumSize(): number
Returns number
Implementation of IPaneviewPanel.maximumSize
- Defined in paneview/paneviewPanel.ts:105

minimumBodySize

get minimumBodySize(): number
Returns number
Implementation of IPaneviewPanel.minimumBodySize
- Defined in paneview/paneviewPanel.ts:125
set minimumBodySize(value: number): void
Parameters
- value: number
Returns void
Implementation of IPaneviewPanel.minimumBodySize
- Defined in paneview/paneviewPanel.ts:129

minimumSize

get minimumSize(): number
Returns number
Implementation of IPaneviewPanel.minimumSize
- Defined in paneview/paneviewPanel.ts:97

orientation

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

orthogonalSize

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

params

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

size

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

width

get width(): number
Returns number
Implementation of IPaneviewPanel.width
Inherited from BasePanelView.width
- Defined in gridview/basePanelView.ts:46

Methods

addDisposables

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

dispose

dispose(): void
Returns void
Implementation of IPaneview.dispose
Inherited from BasePanelView.dispose
- Defined in gridview/basePanelView.ts:148

focus

focus(): void
Returns void
Implementation of IPaneviewPanel.focus
Inherited from BasePanelView.focus
- Defined in gridview/basePanelView.ts:86

`Protected` `Abstract`getBodyComponent

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

getComponent

getComponent(): IFrameworkPart
Returns IFrameworkPart
Overrides BasePanelView.getComponent
- Defined in paneview/paneviewPanel.ts:331

`Protected` `Abstract`getHeaderComponent

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

init

init(parameters: PanePanelInitParameter): void
Parameters
- parameters: PanePanelInitParameter
Returns void
Overrides BasePanelView.init
- Defined in paneview/paneviewPanel.ts:278

isExpanded

isExpanded(): boolean
Returns boolean
Implementation of IPaneviewPanel.isExpanded
- Defined in paneview/paneviewPanel.ts:240

layout

layout(size: number, orthogonalSize: number): void
Parameters
- size: number
- orthogonalSize: number
Returns void
Implementation of IPaneview.layout
Overrides BasePanelView.layout
- Defined in paneview/paneviewPanel.ts:268

removeDisposable

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

setActive

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

setExpanded

setExpanded(expanded: boolean): void
Parameters
- expanded: boolean
Returns void
Implementation of IPaneviewPanel.setExpanded
- Defined in paneview/paneviewPanel.ts:244

setVisible

setVisible(isVisible: boolean): void
Parameters
- isVisible: boolean
Returns void
Implementation of IPaneview.setVisible
- Defined in paneview/paneviewPanel.ts:232

toJSON

toJSON(): PanePanelViewState
Returns PanePanelViewState
Implementation of IPaneviewPanel.toJSON
Overrides BasePanelView.toJSON
- Defined in paneview/paneviewPanel.ts:302

update

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