Class PaneviewComponent

Hierarchy

Resizable
- PaneviewComponent

Implements

IPaneviewComponent

Index

Constructors

constructor

new PaneviewComponent(
container: HTMLElement,
options: PaneviewComponentOptions,
): PaneviewComponent
Parameters
- container: HTMLElement
- options: PaneviewComponentOptions
Returns PaneviewComponent
Overrides Resizable.constructor
- Defined in paneview/paneviewComponent.ts:210

Properties

`Readonly`onDidAddView

onDidAddView: DockviewEvent<PaneviewPanel> = ...

`Readonly`onDidDrop

onDidDrop: DockviewEvent<PaneviewDidDropEvent> = ...

`Readonly`onDidLayoutChange

onDidLayoutChange: DockviewEvent<void> = ...

`Readonly`onDidLayoutFromJSON

onDidLayoutFromJSON: DockviewEvent<void> = ...

`Readonly`onDidRemoveView

onDidRemoveView: DockviewEvent<PaneviewPanel> = ...

`Readonly`onUnhandledDragOver

onUnhandledDragOver: DockviewEvent<PaneviewDndOverlayEvent> = ...

Accessors

disableResizing

get disableResizing(): boolean
Returns boolean
Inherited from Resizable.disableResizing
- Defined in resizable.ts:14
set disableResizing(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from Resizable.disableResizing
- Defined in resizable.ts:18

element

get element(): HTMLElement
Returns HTMLElement
Inherited from Resizable.element
- Defined in resizable.ts:10

height

get height(): number
Returns number
Implementation of IPaneviewComponent.height
- Defined in paneview/paneviewComponent.ts:194

id

get id(): string
Returns string
Implementation of IPaneviewComponent.id
- Defined in paneview/paneviewComponent.ts:162

isDisposed

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

maximumSize

get maximumSize(): number
Returns number
Implementation of IPaneviewComponent.maximumSize
- Defined in paneview/paneviewComponent.ts:190

minimumSize

get minimumSize(): number
Returns number
Implementation of IPaneviewComponent.minimumSize
- Defined in paneview/paneviewComponent.ts:186

options

get options(): PaneviewComponentOptions
Returns PaneviewComponentOptions
Implementation of IPaneviewComponent.options
- Defined in paneview/paneviewComponent.ts:206

panels

get panels(): PaneviewPanel[]
Returns PaneviewPanel[]
Implementation of IPaneviewComponent.panels
- Defined in paneview/paneviewComponent.ts:166

paneview

get paneview(): Paneview
Returns Paneview
- Defined in paneview/paneviewComponent.ts:182
set paneview(value: Paneview): void
Parameters
- value: Paneview
Returns void
- Defined in paneview/paneviewComponent.ts:170

width

get width(): number
Returns number
Implementation of IPaneviewComponent.width
- Defined in paneview/paneviewComponent.ts:200

Methods

addDisposables

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

addPanel

addPanel<T extends object = Parameters>(
options: AddPaneviewComponentOptions<T>,
): IPaneviewPanel
Type Parameters
- T extends object = Parameters
Parameters
- options: AddPaneviewComponentOptions<T>
Returns IPaneviewPanel
Implementation of IPaneviewComponent.addPanel
- Defined in paneview/paneviewComponent.ts:261

clear

clear(): void
Returns void
Implementation of IPaneviewComponent.clear
- Defined in paneview/paneviewComponent.ts:455

dispose

dispose(): void
Returns void
Implementation of IPaneviewComponent.dispose
Overrides Resizable.dispose
- Defined in paneview/paneviewComponent.ts:486

focus

focus(): void
Returns void
Implementation of IPaneviewComponent.focus
- Defined in paneview/paneviewComponent.ts:245

fromJSON

fromJSON(serializedPaneview: SerializedPaneview): void
Parameters
- serializedPaneview: SerializedPaneview
Returns void
Implementation of IPaneviewComponent.fromJSON
- Defined in paneview/paneviewComponent.ts:371

getPanel

getPanel(id: string): PaneviewPanel | undefined
Parameters
- id: string
Returns PaneviewPanel | undefined
Implementation of IPaneviewComponent.getPanel
- Defined in paneview/paneviewComponent.ts:331

layout

layout(width: number, height: number): void
Parameters
- width: number
- height: number
Returns void
Implementation of IPaneviewComponent.layout
Overrides Resizable.layout
- Defined in paneview/paneviewComponent.ts:335

movePanel

movePanel(from: number, to: number): void
Parameters
- from: number
- to: number
Returns void
Implementation of IPaneviewComponent.movePanel
- Defined in paneview/paneviewComponent.ts:327

removeDisposable

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

removePanel

removePanel(panel: PaneviewPanel): void
Parameters
- panel: PaneviewPanel
Returns void
Implementation of IPaneviewComponent.removePanel
- Defined in paneview/paneviewComponent.ts:319

setVisible

setVisible(panel: PaneviewPanel, visible: boolean): void
Parameters
- panel: PaneviewPanel
- visible: boolean
Returns void
Implementation of IPaneviewComponent.setVisible
- Defined in paneview/paneviewComponent.ts:240

toJSON

toJSON(): SerializedPaneview
Returns SerializedPaneview
Implementation of IPaneviewComponent.toJSON
- Defined in paneview/paneviewComponent.ts:343

updateOptions

updateOptions(options: Partial<PaneviewComponentOptions>): void
Parameters
- options: Partial<PaneviewComponentOptions>
Returns void
Implementation of IPaneviewComponent.updateOptions
- Defined in paneview/paneviewComponent.ts:249