Class PaneviewComponent

Hierarchy

Resizable
- PaneviewComponent

Implements

IPaneviewComponent

Constructors

constructor

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

Properties

`Private` `Readonly` _classNames

_classNames: Classnames

`Private` `Readonly` _disposable

_disposable: DockviewMutableDisposable = ...

`Private` `Readonly` _id

_id: string = ...

`Private` `Readonly` _onDidAddView

_onDidAddView: DockviewEmitter<PaneviewPanel> = ...

`Private` `Readonly` _onDidDrop

_onDidDrop: DockviewEmitter<PaneviewDropEvent> = ...

`Private` `Readonly` _onDidLayoutChange

_onDidLayoutChange: DockviewEmitter<void> = ...

`Private` `Readonly` _onDidLayoutfromJSON

_onDidLayoutfromJSON: DockviewEmitter<void> = ...

`Private` `Readonly` _onDidRemoveView

_onDidRemoveView: DockviewEmitter<PaneviewPanel> = ...

`Private` `Readonly` _onUnhandledDragOverEvent

_onUnhandledDragOverEvent: DockviewEmitter<PaneviewDndOverlayEvent> = ...

`Private` _options

_options: PaneviewComponentOptions

`Private` _paneview

_paneview: Paneview

`Private` `Readonly` _viewDisposables

_viewDisposables: Map<string, DockviewIDisposable> = ...

`Readonly` onDidAddView

onDidAddView: DockviewEvent<PaneviewPanel> = ...

`Readonly` onDidDrop

onDidDrop: DockviewEvent<PaneviewDropEvent> = ...

`Readonly` onDidLayoutChange

onDidLayoutChange: DockviewEvent<void> = ...

`Readonly` onDidLayoutFromJSON

onDidLayoutFromJSON: DockviewEvent<void> = ...

`Readonly` onDidRemoveView

onDidRemoveView: DockviewEvent<PaneviewPanel> = ...

`Readonly` onUnhandledDragOverEvent

onUnhandledDragOverEvent: DockviewEvent<PaneviewDndOverlayEvent> = ...

Accessors

disableResizing

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

element

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

height

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

id

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

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:178

minimumSize

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

options

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

panels

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

paneview

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

width

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

Methods

addDisposables

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

addPanel

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

clear

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

dispose

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

`Private` doAddPanel

doAddPanel(panel): void
Parameters
- panel: PaneFramework
Returns void
- Defined in paneview/paneviewComponent.ts:449

`Private` doRemovePanel

doRemovePanel(panel): void
Parameters
- panel: PaneviewPanel
Returns void
- Defined in paneview/paneviewComponent.ts:462

focus

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

fromJSON

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

getPanel

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

layout

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

movePanel

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

removePanel

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

setVisible

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

toJSON

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

updateOptions

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

Generated using TypeDoc