Class SplitviewComponent

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

Hierarchy

Resizable
- SplitviewComponent

Implements

ISplitviewComponent

Index

Constructors

constructor

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

Properties

`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 BaseGrid.disableResizing
- Defined in resizable.ts:14
set disableResizing(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from BaseGrid.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 ISplitviewComponent.height
- Defined in splitview/splitviewComponent.ts:151

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

maximumSize

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

minimumSize

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

options

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

orientation

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

panels

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

splitview

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

width

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

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: AddSplitviewComponentOptions<T>,
): SplitviewPanel
Type Parameters
- T extends object = Parameters
Parameters
- options: AddSplitviewComponentOptions<T>
Returns SplitviewPanel
Implementation of ISplitviewComponent.addPanel
- Defined in splitview/splitviewComponent.ts:262

clear

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

dispose

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

focus

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

fromJSON

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

getPanel

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

layout

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

movePanel

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

removeDisposable

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

removePanel

removePanel(panel: SplitviewPanel, sizing?: Sizing): void
Parameters
- panel: SplitviewPanel
- Optionalsizing: Sizing
Returns void
Implementation of ISplitviewComponent.removePanel
- Defined in splitview/splitviewComponent.ts:237

setActive

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

setVisible

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

toJSON

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

updateOptions

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