Class PaneFramework

Hierarchy (view full)

DraggablePaneviewPanel
- PaneFramework

Constructors

constructor

new PaneFramework(options): PaneFramework
Parameters
- options: {
      accessor: IPaneviewComponent;
      body: IPanePart;
      component: string;
      disableDnd: boolean;
      header: IPanePart;
      headerComponent: undefined | string;
      headerSize: number;
      id: string;
      isExpanded: boolean;
      maximumBodySize: number;
      minimumBodySize: number;
      orientation: Orientation;
  }
  - accessor: IPaneviewComponent
  - body: IPanePart
  - component: string
  - disableDnd: boolean
  - header: IPanePart
  - headerComponent: undefined | string
  - headerSize: number
  - id: string
  - isExpanded: boolean
  - maximumBodySize: number
  - minimumBodySize: number
  - orientation: Orientation
Returns PaneFramework
Overrides DraggablePaneviewPanel.constructor
- Defined in paneview/paneviewComponent.ts:51

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: undefined | string

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

`Readonly` onDidDrop

onDidDrop: DockviewEvent<PaneviewDropEvent> = ...

`Readonly` onUnhandledDragOverEvent

onUnhandledDragOverEvent: DockviewEvent<PaneviewDndOverlayEvent> = ...

`Private` `Readonly` options

options: {
    accessor: IPaneviewComponent;
    body: IPanePart;
    component: string;
    disableDnd: boolean;
    header: IPanePart;
    headerComponent: undefined | string;
    headerSize: number;
    id: string;
    isExpanded: boolean;
    maximumBodySize: number;
    minimumBodySize: number;
    orientation: Orientation;
}

Type declaration

accessor: IPaneviewComponent
body: IPanePart
component: string
disableDnd: boolean
header: IPanePart
headerComponent: undefined | string
headerSize: number
id: string
isExpanded: boolean
maximumBodySize: number
minimumBodySize: number
orientation: Orientation

`Protected` `Optional` part

part?: IFrameworkPart

Accessors

element

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

headerVisible

get headerVisible(): boolean
Returns boolean
Inherited from DraggablePaneviewPanel.headerVisible
- Defined in paneview/paneviewPanel.ts:144
set headerVisible(value): void
Parameters
- value: boolean
Returns void
Inherited from DraggablePaneviewPanel.headerVisible
- Defined in paneview/paneviewPanel.ts:148

height

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

isDisposed

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

maximumBodySize

get maximumBodySize(): number
Returns number
Inherited from DraggablePaneviewPanel.maximumBodySize
- Defined in paneview/paneviewPanel.ts:135
set maximumBodySize(value): void
Parameters
- value: number
Returns void
Inherited from DraggablePaneviewPanel.maximumBodySize
- Defined in paneview/paneviewPanel.ts:139

maximumSize

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

minimumBodySize

get minimumBodySize(): number
Returns number
Inherited from DraggablePaneviewPanel.minimumBodySize
- Defined in paneview/paneviewPanel.ts:127
set minimumBodySize(value): void
Parameters
- value: number
Returns void
Inherited from DraggablePaneviewPanel.minimumBodySize
- Defined in paneview/paneviewPanel.ts:131

minimumSize

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

orientation

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

orthogonalSize

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

params

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

size

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

width

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

Methods

addDisposables

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

init

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

isExpanded

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

layout

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

setActive

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

setExpanded

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

setVisible

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

toJSON

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

update

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

Class PaneFramework

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: { accessor: IPaneviewComponent; body: IPanePart; component: string; disableDnd: boolean; header: IPanePart; headerComponent: undefined | string; headerSize: number; id: string; isExpanded: boolean; maximumBodySize: number; minimumBodySize: number; orientation: Orientation; }

accessor: IPaneviewComponent

body: IPanePart

component: string

disableDnd: boolean

header: IPanePart

headerComponent: undefined | string

headerSize: number

id: string

isExpanded: boolean

maximumBodySize: number

minimumBodySize: number

orientation: Orientation

Returns PaneFramework

Properties

Protected Optional _params

Readonly accessor

Readonly api

Protected Optional body

Protected Readonly component

Protected Optional header

Readonly headerComponent

Readonly headerSize

Readonly id

Readonly onDidChange

Type declaration

Optional orthogonalSize?: number

Optional size?: number

onDidChangeExpansionState

Readonly onDidDrop

Readonly onUnhandledDragOverEvent

Private Readonly options

Type declaration

accessor: IPaneviewComponent

body: IPanePart

component: string

disableDnd: boolean

header: IPanePart

headerComponent: undefined | string

headerSize: number

id: string

isExpanded: boolean

maximumBodySize: number

minimumBodySize: number

orientation: Orientation

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

options: {
accessor: IPaneviewComponent;
body: IPanePart;
component: string;
disableDnd: boolean;
header: IPanePart;
headerComponent: undefined | string;
headerSize: number;
id: string;
isExpanded: boolean;
maximumBodySize: number;
minimumBodySize: number;
orientation: Orientation;
}

`Protected` `Optional` _params

`Readonly` accessor

`Readonly` api

`Protected` `Optional` body

`Protected` `Readonly` component

`Protected` `Optional` header

`Readonly` headerComponent

`Readonly` headerSize

`Readonly` id

`Readonly` onDidChange

`Optional` orthogonalSize?: number

`Optional` size?: number

`Readonly` onDidDrop

`Readonly` onUnhandledDragOverEvent

`Private` `Readonly` options

`Protected` `Optional` part

`Rest` ...args: DockviewIDisposable[]