Class SplitviewPanel`Abstract`

Hierarchy

BasePanelView<SplitviewPanelApiImpl>
- SplitviewPanel

Implements

ISplitviewPanel

Index

Constructors

Properties

_params? api component id onDidChange part?

Accessors

element height isDisposed maximumSize minimumSize orientation params priority snap width

Methods

addDisposables dispose focus getComponent init layout removeDisposable setActive setVisible toJSON update

Constructors

constructor

new SplitviewPanel(id: string, componentName: string): SplitviewPanel
Parameters
- id: string
- componentName: string
Returns SplitviewPanel
Overrides BasePanelView<SplitviewPanelApiImpl>.constructor
- Defined in splitview/splitviewPanel.ts:84

Properties

`Protected` `Optional`_params

_params?: PanelInitParameters

`Readonly`api

api: SplitviewPanelApiImpl

`Protected` `Readonly`component

component: string

`Readonly`id

id: string

`Readonly`onDidChange

onDidChange: DockviewEvent<{ orthogonalSize?: number; size?: number }> = ...

`Protected` `Optional`part

part?: IFrameworkPart

Accessors

element

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

height

get height(): number
Returns number
Implementation of ISplitviewPanel.height
Inherited from BasePanelView.height
- Defined in gridview/basePanelView.ts:50

isDisposed

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

maximumSize

get maximumSize(): number
Returns number
Implementation of ISplitviewPanel.maximumSize
- Defined in splitview/splitviewPanel.ts:66

minimumSize

get minimumSize(): number
Returns number
Implementation of ISplitviewPanel.minimumSize
- Defined in splitview/splitviewPanel.ts:52

orientation

get orientation(): Orientation
Returns Orientation
Implementation of ISplitviewPanel.orientation
- Defined in splitview/splitviewPanel.ts:48
set orientation(value: Orientation): void
Parameters
- value: Orientation
Returns void
Implementation of ISplitviewPanel.orientation
- Defined in splitview/splitviewPanel.ts:44

params

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

priority

get priority(): LayoutPriority | undefined
Returns LayoutPriority | undefined
Implementation of ISplitviewPanel.priority
- Defined in splitview/splitviewPanel.ts:40

snap

get snap(): boolean
Returns boolean
Implementation of ISplitviewPanel.snap
- Defined in splitview/splitviewPanel.ts:80

width

get width(): number
Returns number
Implementation of ISplitviewPanel.width
Inherited from BasePanelView.width
- Defined in gridview/basePanelView.ts:46

Methods

addDisposables

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

dispose

dispose(): void
Returns void
Inherited from BasePanelView.dispose
- Defined in gridview/basePanelView.ts:148

focus

focus(): void
Returns void
Implementation of ISplitviewPanel.focus
Inherited from BasePanelView.focus
- Defined in gridview/basePanelView.ts:86

`Protected` `Abstract`getComponent

getComponent(): IFrameworkPart
Returns IFrameworkPart
Inherited from BasePanelView.getComponent
- Defined in gridview/basePanelView.ts:40

init

init(parameters: PanelViewInitParameters): void
Parameters
- parameters: PanelViewInitParameters
Returns void
Overrides BasePanelView.init
- Defined in splitview/splitviewPanel.ts:137

layout

layout(size: number, orthogonalSize: number): void
Parameters
- size: number
- orthogonalSize: number
Returns void
Overrides BasePanelView.layout
- Defined in splitview/splitviewPanel.ts:129

removeDisposable

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

setActive

setActive(isActive: boolean): void
Parameters
- isActive: boolean
Returns void
- Defined in splitview/splitviewPanel.ts:125

setVisible

setVisible(isVisible: boolean): void
Parameters
- isVisible: boolean
Returns void
- Defined in splitview/splitviewPanel.ts:121

toJSON

toJSON(): {
    component: string;
    id: string;
    maximumSize: number
    | undefined;
    minimumSize: number | undefined;
    params?: Parameters;
}
Returns {
    component: string;
    id: string;
    maximumSize: number | undefined;
    minimumSize: number | undefined;
    params?: Parameters;
}
Implementation of ISplitviewPanel.toJSON
Overrides BasePanelView.toJSON
- Defined in splitview/splitviewPanel.ts:153

update

update(event: PanelUpdateEvent): void
Parameters
- event: PanelUpdateEvent
Returns void
Implementation of ISplitviewPanel.update
Inherited from BasePanelView.update
- Defined in gridview/basePanelView.ts:114