Class SplitviewComponent

A high-level implementation of splitview that works using 'panels'

Hierarchy

Resizable
- SplitviewComponent

Implements

ISplitviewComponent

Constructors

constructor

new SplitviewComponent(container, options): SplitviewComponent
Parameters
- container: HTMLElement
- options: SplitviewComponentOptions
Returns SplitviewComponent
Overrides Resizable.constructor
- Defined in splitview/splitviewComponent.ts:158

Properties

`Private` _activePanel

_activePanel: undefined | SplitviewPanel

`Private` `Readonly` _classNames

_classNames: Classnames

`Private` `Readonly` _onDidAddView

_onDidAddView: DockviewEmitter<IView> = ...

`Private` `Readonly` _onDidLayoutChange

_onDidLayoutChange: DockviewEmitter<void> = ...

`Private` `Readonly` _onDidLayoutfromJSON

_onDidLayoutfromJSON: DockviewEmitter<void> = ...

`Private` `Readonly` _onDidRemoveView

_onDidRemoveView: DockviewEmitter<IView> = ...

`Private` _options

_options: SplitviewComponentOptions

`Private` `Readonly` _panels

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

`Private` _splitview

_splitview: Splitview

`Private` `Readonly` _splitviewChangeDisposable

_splitviewChangeDisposable: DockviewMutableDisposable = ...

`Readonly` onDidAddView

onDidAddView: DockviewEvent<IView> = ...

`Readonly` onDidLayoutChange

onDidLayoutChange: DockviewEvent<void> = ...

`Readonly` onDidLayoutFromJSON

onDidLayoutFromJSON: DockviewEvent<void> = ...

`Readonly` onDidRemoveView

onDidRemoveView: DockviewEvent<IView> = ...

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 ISplitviewComponent.height
- Defined in splitview/splitviewComponent.ts:146

isDisposed

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

length

get length(): number
Returns number
Implementation of ISplitviewComponent.length
- Defined in splitview/splitviewComponent.ts:112

maximumSize

get maximumSize(): number
Returns number
Implementation of ISplitviewComponent.maximumSize
- Defined in splitview/splitviewComponent.ts:142

minimumSize

get minimumSize(): number
Returns number
Implementation of ISplitviewComponent.minimumSize
- Defined in splitview/splitviewComponent.ts:138

options

get options(): SplitviewComponentOptions
Returns SplitviewComponentOptions
- Defined in splitview/splitviewComponent.ts:108

orientation

get orientation(): Orientation
Returns Orientation
Implementation of ISplitviewComponent.orientation
- Defined in splitview/splitviewComponent.ts:116

panels

get panels(): SplitviewPanel[]
Returns SplitviewPanel[]
Implementation of ISplitviewComponent.panels
- Defined in splitview/splitviewComponent.ts:104

splitview

get splitview(): Splitview
Returns Splitview
- Defined in splitview/splitviewComponent.ts:120
set splitview(value): void
Parameters
- value: Splitview
Returns void
- Defined in splitview/splitviewComponent.ts:124

width

get width(): number
Returns number
Implementation of ISplitviewComponent.width
- Defined in splitview/splitviewComponent.ts:152

Methods

addDisposables

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

addPanel

addPanel<T>(options): SplitviewPanel
Type Parameters
- T extends object = Parameters
Parameters
- options: AddSplitviewComponentOptions<T>
Returns SplitviewPanel
Implementation of ISplitviewComponent.addPanel
- Defined in splitview/splitviewComponent.ts:257

clear

clear(): void
Returns void
Implementation of ISplitviewComponent.clear
- Defined in splitview/splitviewComponent.ts:399

dispose

dispose(): void
Returns void
Implementation of ISplitviewComponent.dispose
Overrides Resizable.dispose
- Defined in splitview/splitviewComponent.ts:412

`Private` doAddView

doAddView(view): void
Parameters
- view: SplitviewPanel
Returns void
- Defined in splitview/splitviewComponent.ts:301

focus

focus(): void
Returns void
Implementation of ISplitviewComponent.focus
- Defined in splitview/splitviewComponent.ts:202

fromJSON

fromJSON(serializedSplitview): void
Parameters
- serializedSplitview: SerializedSplitview
Returns void
Implementation of ISplitviewComponent.fromJSON
- Defined in splitview/splitviewComponent.ts:333

getPanel

getPanel(id): undefined | SplitviewPanel
Parameters
- id: string
Returns undefined | SplitviewPanel
Implementation of ISplitviewComponent.getPanel
- Defined in splitview/splitviewComponent.ts:253

layout

layout(width, height): void
Parameters
- width: number
- height: number
Returns void
Implementation of ISplitviewComponent.layout
Overrides Resizable.layout
- Defined in splitview/splitviewComponent.ts:293

movePanel

movePanel(from, to): void
Parameters
- from: number
- to: number
Returns void
Implementation of ISplitviewComponent.movePanel
- Defined in splitview/splitviewComponent.ts:206

removePanel

removePanel(panel, sizing?): void
Parameters
- panel: SplitviewPanel
- Optional sizing: DistributeSizing | SplitSizing | InvisibleSizing
Returns void
Implementation of ISplitviewComponent.removePanel
- Defined in splitview/splitviewComponent.ts:232

setActive

setActive(panel, skipFocus?): void
Parameters
- panel: SplitviewPanel
- Optional skipFocus: boolean
Returns void
- Defined in splitview/splitviewComponent.ts:215

setVisible

setVisible(panel, visible): void
Parameters
- panel: SplitviewPanel
- visible: boolean
Returns void
Implementation of ISplitviewComponent.setVisible
- Defined in splitview/splitviewComponent.ts:210

toJSON

toJSON(): SerializedSplitview
Returns SerializedSplitview
Implementation of ISplitviewComponent.toJSON
- Defined in splitview/splitviewComponent.ts:312

updateOptions

updateOptions(options): void
Parameters
- options: Partial<SplitviewComponentOptions>
Returns void
Implementation of ISplitviewComponent.updateOptions
- Defined in splitview/splitviewComponent.ts:181

Generated using TypeDoc