Class SplitviewPanel`Abstract`

Hierarchy

BasePanelView<SplitviewPanelApiImpl>
- SplitviewPanel

Implements

ISplitviewPanel

Index

Constructors

constructor

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

Properties

`Private` _evaluatedMaximumSize

_evaluatedMaximumSize: number = Number.POSITIVE_INFINITY

`Private` _evaluatedMinimumSize

_evaluatedMinimumSize: number = 0

`Private` _maximumSize

_maximumSize: FunctionOrValue<number> = Number.POSITIVE_INFINITY

`Private` _minimumSize

_minimumSize: FunctionOrValue<number> = 0

`Private` `Readonly` _onDidChange

_onDidChange: DockviewEmitter<{
orthogonalSize?: number;
size?: number;
}> = ...

Type declaration

Optional orthogonalSize?: number
Optional size?: number

`Private` `Optional` _orientation

_orientation?: HORIZONTAL | VERTICAL

`Protected` `Optional` _params

_params?: PanelInitParameters

`Private` `Optional` _priority

_priority?: Low | High | Normal

`Private` _snap

_snap: boolean = false

`Readonly` api

api: SplitviewPanelApiImpl

`Protected` `Readonly` component

component: string

`Readonly` id

id: string

`Readonly` onDidChange

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

Type declaration

Optional orthogonalSize?: number
Optional 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:67

minimumSize

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

orientation

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

params

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

priority

get priority(): undefined | Low | High | Normal
Returns undefined | Low | High | Normal
Implementation of ISplitviewPanel.priority
- Defined in splitview/splitviewPanel.ts:41

snap

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

width

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

Methods

addDisposables

addDisposables(...args): void
Parameters
- Rest ...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): void
Parameters
- parameters: PanelViewInitParameters
Returns void
Overrides BasePanelView.init
- Defined in splitview/splitviewPanel.ts:138

layout

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

setActive

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

setVisible

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

toJSON

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

update

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

`Private` updateConstraints

updateConstraints(): void
Returns void
- Defined in splitview/splitviewPanel.ts:169

Class SplitviewPanelAbstract

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

id: string

componentName: string

Returns SplitviewPanel

Properties

Private _evaluatedMaximumSize

Private _evaluatedMinimumSize

Private _maximumSize

Private _minimumSize

Private Readonly _onDidChange

Type declaration

Optional orthogonalSize?: number

Optional size?: number

Private Optional _orientation

Protected Optional _params

Private Optional _priority

Private _snap

Readonly api

Protected Readonly component

Readonly id

Readonly onDidChange

Type declaration

Optional orthogonalSize?: number

Optional size?: number

Protected Optional part

Accessors

element

Returns HTMLElement

height

Returns number

isDisposed

Returns boolean

maximumSize

Returns number

minimumSize

Returns number

orientation

Returns Orientation

Parameters

value: Orientation

Returns void

params

Returns undefined | Parameters

priority

Returns undefined | Low | High | Normal

snap

Returns boolean

width

Returns number

Methods

addDisposables

Parameters

Rest ...args: DockviewIDisposable[]

Returns void

dispose

Returns void

focus

Returns void

Protected Abstract getComponent

Returns IFrameworkPart

init

Parameters

parameters: PanelViewInitParameters

Returns void

layout

Parameters

size: number

orthogonalSize: number

Returns void

setActive

Class SplitviewPanel`Abstract`

`Private` _evaluatedMaximumSize

`Private` _evaluatedMinimumSize

`Private` _maximumSize

`Private` _minimumSize

`Private` `Readonly` _onDidChange

`Optional` orthogonalSize?: number

`Optional` size?: number

`Private` `Optional` _orientation

`Protected` `Optional` _params

`Private` `Optional` _priority

`Private` _snap

`Readonly` api

`Protected` `Readonly` component

`Readonly` id

`Readonly` onDidChange

`Optional` orthogonalSize?: number

`Optional` size?: number

`Protected` `Optional` part

`Rest` ...args: DockviewIDisposable[]

`Protected` `Abstract` getComponent

Returns {
component: string;
id: string;
maximumSize: undefined | number;
minimumSize: undefined | number;
params?: Parameters;
}

`Readonly` component: string

`Readonly` id: string

`Optional` `Readonly` params?: Parameters

`Private` updateConstraints