Class PaneviewPanel`Abstract`

Hierarchy (view full)

BasePanelView<PaneviewPanelApiImpl>
- PaneviewPanel
  - DraggablePaneviewPanel

Implements

Constructors

constructor

new PaneviewPanel(options): PaneviewPanel
Parameters
- options: {
      component: string;
      headerComponent: undefined | string;
      headerSize: number;
      id: string;
      isExpanded: boolean;
      isHeaderVisible: boolean;
      maximumBodySize: number;
      minimumBodySize: number;
      orientation: Orientation;
  }
  - component: string
  - headerComponent: undefined | string
  - 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:153

Properties

`Private` _headerVisible

_headerVisible: boolean

`Private` _isExpanded

_isExpanded: boolean = false

`Private` _maximumBodySize

_maximumBodySize: number

`Private` _minimumBodySize

_minimumBodySize: number

`Private` `Readonly` _onDidChange

_onDidChange: DockviewEmitter<{
orthogonalSize?: number;
size?: number;
}> = ...

Type declaration

Optional orthogonalSize?: number
Optional size?: number

`Private` `Readonly` _onDidChangeExpansionState

_onDidChangeExpansionState: DockviewEmitter<boolean> = ...

`Private` _orientation

_orientation: Orientation

`Private` _orthogonalSize

_orthogonalSize: number = 0

`Protected` `Optional` _params

_params?: PanelInitParameters

`Private` _size

_size: number = 0

`Private` animationTimer

animationTimer: any

`Readonly` api

api: PaneviewPanelApiImpl

`Protected` `Optional` body

body?: HTMLElement

`Private` `Optional` bodyPart

bodyPart?: IPanePart

`Protected` `Readonly` component

component: string

`Protected` `Optional` header

header?: HTMLElement

`Readonly` headerComponent

headerComponent: undefined | string

`Private` `Optional` headerPart

headerPart?: IPanePart

`Readonly` headerSize

headerSize: number

`Readonly` id

id: string

`Readonly` onDidChange

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

Type declaration

Optional orthogonalSize?: number
Optional 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:144
set headerVisible(value): void
Parameters
- value: boolean
Returns void
Implementation of IPaneviewPanel.headerVisible
- Defined in paneview/paneviewPanel.ts:148

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:135
set maximumBodySize(value): void
Parameters
- value: number
Returns void
Implementation of IPaneviewPanel.maximumBodySize
- Defined in paneview/paneviewPanel.ts:139

maximumSize

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

minimumBodySize

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

minimumSize

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

orientation

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

orthogonalSize

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

params

get params(): undefined | Parameters
Returns undefined | Parameters
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:115

width

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

Methods

addDisposables

addDisposables(...args): void
Parameters
- Rest ...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:346

getComponent

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

`Protected` `Abstract` getHeaderComponent

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

init

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

isExpanded

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

layout

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

`Private` renderOnce

renderOnce(): void
Returns void
- Defined in paneview/paneviewPanel.ts:313

setActive

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

setExpanded

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

setVisible

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

toJSON

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

update

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

Class PaneviewPanelAbstract

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: { component: string; headerComponent: undefined | string; headerSize: number; id: string; isExpanded: boolean; isHeaderVisible: boolean; maximumBodySize: number; minimumBodySize: number; orientation: Orientation; }

component: string

headerComponent: undefined | string

headerSize: number

id: string

isExpanded: boolean

isHeaderVisible: boolean

maximumBodySize: number

minimumBodySize: number

orientation: Orientation

Returns PaneviewPanel

Properties

Private _headerVisible

Private _isExpanded

Private _maximumBodySize

Private _minimumBodySize

Private Readonly _onDidChange

Type declaration

Optional orthogonalSize?: number

Optional size?: number

Private Readonly _onDidChangeExpansionState

Private _orientation

Private _orthogonalSize

Protected Optional _params

Private _size

Private animationTimer

Readonly api

Protected Optional body

Private Optional bodyPart

Protected Readonly component

Protected Optional header

Readonly headerComponent

Private Optional headerPart

Readonly headerSize

Readonly id

Readonly onDidChange

Type declaration

Optional orthogonalSize?: number

Optional size?: number

onDidChangeExpansionState

Protected Optional part

Accessors

element

Returns HTMLElement

headerVisible

Returns boolean

Parameters

value: boolean

Returns void

height

Returns number

isDisposed

Returns boolean

maximumBodySize

Returns number

Parameters

value: number

Returns void

maximumSize

Returns number

minimumBodySize

Returns number

Parameters

value: number

Returns void

minimumSize

Returns number

orientation

Returns Orientation

Class PaneviewPanel`Abstract`

options: {
component: string;
headerComponent: undefined | string;
headerSize: number;
id: string;
isExpanded: boolean;
isHeaderVisible: boolean;
maximumBodySize: number;
minimumBodySize: number;
orientation: Orientation;
}

`Private` _headerVisible

`Private` _isExpanded

`Private` _maximumBodySize

`Private` _minimumBodySize

`Private` `Readonly` _onDidChange

`Optional` orthogonalSize?: number

`Optional` size?: number

`Private` `Readonly` _onDidChangeExpansionState

`Private` _orientation

`Private` _orthogonalSize

`Protected` `Optional` _params

`Private` _size

`Private` animationTimer

`Readonly` api

`Protected` `Optional` body

`Private` `Optional` bodyPart

`Protected` `Readonly` component

`Protected` `Optional` header

`Readonly` headerComponent

`Private` `Optional` headerPart

`Readonly` headerSize

`Readonly` id

`Readonly` onDidChange

`Optional` orthogonalSize?: number

`Optional` size?: number

`Protected` `Optional` part

`Rest` ...args: DockviewIDisposable[]

`Protected` `Abstract` getBodyComponent

`Protected` `Abstract` getHeaderComponent

`Private` renderOnce