Class Splitview

Constructors

constructor

new Splitview(container, options): Splitview
Parameters
- container: HTMLElement
- options: SplitViewOptions
Returns Splitview
- Defined in splitview/splitview.ts:224

Properties

`Private` _contentSize

_contentSize: number = 0

`Private` _disabled

_disabled: boolean = false

`Private` _endSnappingEnabled

_endSnappingEnabled: boolean = true

`Private` _margin

_margin: number = 0

`Private` `Readonly` _onDidAddView

_onDidAddView: DockviewEmitter<IView> = ...

`Private` `Readonly` _onDidRemoveView

_onDidRemoveView: DockviewEmitter<IView> = ...

`Private` `Readonly` _onDidSashEnd

_onDidSashEnd: DockviewEmitter<void> = ...

`Private` _orientation

_orientation: Orientation

`Private` _orthogonalSize

_orthogonalSize: number = 0

`Private` _proportions

_proportions: undefined | (undefined | number)[] = undefined

`Private` _size

_size: number = 0

`Private` _startSnappingEnabled

_startSnappingEnabled: boolean = true

`Private` `Readonly` container

container: HTMLElement

`Private` `Readonly` element

element: HTMLElement

`Readonly` onDidAddView

onDidAddView: DockviewEvent<IView> = ...

`Readonly` onDidRemoveView

onDidRemoveView: DockviewEvent<IView> = ...

`Readonly` onDidSashEnd

onDidSashEnd: DockviewEvent<void> = ...

`Private` `Readonly` proportionalLayout

proportionalLayout: boolean

`Private` `Readonly` sashContainer

sashContainer: HTMLElement

`Private` `Readonly` sashes

sashes: ISashItem[] = []

`Private` `Readonly` viewContainer

viewContainer: HTMLElement

`Private` `Readonly` viewItems

viewItems: ViewItem[] = []

Accessors

contentSize

get contentSize(): number
Returns number
- Defined in splitview/splitview.ts:123

disabled

get disabled(): boolean
Returns boolean
- Defined in splitview/splitview.ts:206
set disabled(value): void
Parameters
- value: boolean
Returns void
- Defined in splitview/splitview.ts:210

endSnappingEnabled

get endSnappingEnabled(): boolean
Returns boolean
- Defined in splitview/splitview.ts:193
set endSnappingEnabled(endSnappingEnabled): void
Parameters
- endSnappingEnabled: boolean
Returns void
- Defined in splitview/splitview.ts:197

length

get length(): number
Returns number
- Defined in splitview/splitview.ts:143

margin

get margin(): number
Returns number
- Defined in splitview/splitview.ts:216
set margin(value): void
Parameters
- value: number
Returns void
- Defined in splitview/splitview.ts:220

maximumSize

get maximumSize(): number
Returns number
- Defined in splitview/splitview.ts:174

minimumSize

get minimumSize(): number
Returns number
- Defined in splitview/splitview.ts:170

orientation

get orientation(): Orientation
Returns Orientation
- Defined in splitview/splitview.ts:151
set orientation(value): void
Parameters
- value: Orientation
Returns void
- Defined in splitview/splitview.ts:155

orthogonalSize

get orthogonalSize(): number
Returns number
- Defined in splitview/splitview.ts:135
set orthogonalSize(value): void
Parameters
- value: number
Returns void
- Defined in splitview/splitview.ts:139

proportions

get proportions(): undefined | (undefined | number)[]
Returns undefined | (undefined | number)[]
- Defined in splitview/splitview.ts:147

size

get size(): number
Returns number
- Defined in splitview/splitview.ts:127
set size(value): void
Parameters
- value: number
Returns void
- Defined in splitview/splitview.ts:131

startSnappingEnabled

get startSnappingEnabled(): boolean
Returns boolean
- Defined in splitview/splitview.ts:180
set startSnappingEnabled(startSnappingEnabled): void
Parameters
- startSnappingEnabled: boolean
Returns void
- Defined in splitview/splitview.ts:184

Methods

addView

addView(view, size?, index?, skipLayout?): void
Parameters
- view: IView
- size: number | DistributeSizing | SplitSizing | InvisibleSizing = ...
- index: number = ...
- Optional skipLayout: boolean
Returns void
- Defined in splitview/splitview.ts:385

`Private` createContainer

createContainer(): HTMLElement
Returns HTMLElement
- Defined in splitview/splitview.ts:1142

`Private` createSashContainer

createSashContainer(): HTMLElement
Returns HTMLElement
- Defined in splitview/splitview.ts:1136

`Private` createViewContainer

createViewContainer(): HTMLElement
Returns HTMLElement
- Defined in splitview/splitview.ts:1130

dispose

dispose(): void
Returns void
- Defined in splitview/splitview.ts:1152

`Private` distributeEmptySpace

distributeEmptySpace(lowPriorityIndex?): void
Parameters
- Optional lowPriorityIndex: number
Returns void
- Defined in splitview/splitview.ts:741

distributeViewSizes

distributeViewSizes(): void
Returns void
- Defined in splitview/splitview.ts:594

`Private` findFirstSnapIndex

findFirstSnapIndex(indexes): undefined | number
Parameters
- indexes: number[]
Returns undefined | number
- Defined in splitview/splitview.ts:888

getViewCachedVisibleSize

getViewCachedVisibleSize(index): undefined | number
Parameters
- index: number
Returns undefined | number
- Defined in splitview/splitview.ts:651

getViewSize

getViewSize(index): number
Parameters
- index: number
Returns number
- Defined in splitview/splitview.ts:315

getViews

getViews<T>(): T[]
Type Parameters
- T extends IView
Returns T[]
- Defined in splitview/splitview.ts:351

isViewVisible

isViewVisible(index): boolean
Parameters
- index: number
Returns boolean
- Defined in splitview/splitview.ts:292

layout

layout(size, orthogonalSize): void
Parameters
- size: number
- orthogonalSize: number
Returns void
- Defined in splitview/splitview.ts:670

`Private` layoutViews

layoutViews(): void
Margin explain:

For n views in a splitview there will be n-1 margins m.

To fit the margins each view must reduce in size by (m * (n - 1)) / n.

For each view i the offet must be adjusted by m * i/(n - 1).

Returns void
- Defined in splitview/splitview.ts:796

moveView

moveView(from, to): void
Parameters
- from: number
- to: number
Returns void
- Defined in splitview/splitview.ts:660

`Private` onDidChange

onDidChange(item, size): void
Parameters
- item: ViewItem
- size: undefined | number
Returns void
- Defined in splitview/splitview.ts:355

`Private` relayout

relayout(lowPriorityIndexes?, highPriorityIndexes?): void
Parameters
- Optional lowPriorityIndexes: number[]
- Optional highPriorityIndexes: number[]
Returns void
- Defined in splitview/splitview.ts:723

removeView

removeView(index, sizing?, skipLayout?): IView
Parameters
- index: number
- Optional sizing: DistributeSizing | SplitSizing | InvisibleSizing
- skipLayout: boolean = false
Returns IView
- Defined in splitview/splitview.ts:622

`Private` resize

resize(index, delta, sizes?, lowPriorityIndexes?, highPriorityIndexes?, overloadMinDelta?, overloadMaxDelta?, snapBefore?, snapAfter?): number
Parameters
- index: number
- delta: number
- sizes: number[] = ...
- Optional lowPriorityIndexes: number[]
- Optional highPriorityIndexes: number[]
- overloadMinDelta: number = Number.NEGATIVE_INFINITY
- overloadMaxDelta: number = Number.POSITIVE_INFINITY
- Optional snapBefore: ISashDragSnapState
- Optional snapAfter: ISashDragSnapState
Returns number
- Defined in splitview/splitview.ts:1001

resizeView

resizeView(index, size): void
Parameters
- index: number
- size: number
Returns void
- Defined in splitview/splitview.ts:323

`Private` saveProportions

saveProportions(): void
Returns void
- Defined in splitview/splitview.ts:779

setViewVisible

setViewVisible(index, visible): void
Parameters
- index: number
- visible: boolean
Returns void
- Defined in splitview/splitview.ts:301

style

style(styles?): void
Parameters
- Optional styles: ISplitviewStyles
Returns void
- Defined in splitview/splitview.ts:277

`Private` updateSash

updateSash(sash, state): void
Parameters
- sash: ISashItem
- state: SashState
Returns void
- Defined in splitview/splitview.ts:990

`Private` updateSashEnablement

updateSashEnablement(): void
Returns void
- Defined in splitview/splitview.ts:921

Class Splitview

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

container: HTMLElement

options: SplitViewOptions

Returns Splitview

Properties

Private _contentSize

Private _disabled

Private _endSnappingEnabled

Private _margin

Private Readonly _onDidAddView

Private Readonly _onDidRemoveView

Private Readonly _onDidSashEnd

Private _orientation

Private _orthogonalSize

Private _proportions

Private _size

Private _startSnappingEnabled

Private Readonly container

Private Readonly element

Readonly onDidAddView

Readonly onDidRemoveView

Readonly onDidSashEnd

Private Readonly proportionalLayout

Private Readonly sashContainer

Private Readonly sashes

Private Readonly viewContainer

Private Readonly viewItems

Accessors

contentSize

Returns number

disabled

Returns boolean

Parameters

value: boolean

Returns void

endSnappingEnabled

Returns boolean

Parameters

endSnappingEnabled: boolean

Returns void

length

Returns number

margin

Returns number

Parameters

value: number

Returns void

maximumSize

Returns number

minimumSize

Returns number

orientation

Returns Orientation

Parameters

value: Orientation

Returns void

orthogonalSize

Returns number

Parameters

value: number

Returns void

proportions

Returns undefined | (undefined | number)[]

size

Returns number

Parameters

value: number

Returns void

startSnappingEnabled

Returns boolean

Parameters

startSnappingEnabled: boolean

`Private` _contentSize

`Private` _disabled

`Private` _endSnappingEnabled

`Private` _margin

`Private` `Readonly` _onDidAddView

`Private` `Readonly` _onDidRemoveView

`Private` `Readonly` _onDidSashEnd

`Private` _orientation

`Private` _orthogonalSize

`Private` _proportions

`Private` _size

`Private` _startSnappingEnabled

`Private` `Readonly` container

`Private` `Readonly` element

`Readonly` onDidAddView

`Readonly` onDidRemoveView

`Readonly` onDidSashEnd

`Private` `Readonly` proportionalLayout

`Private` `Readonly` sashContainer

`Private` `Readonly` sashes

`Private` `Readonly` viewContainer

`Private` `Readonly` viewItems

`Optional` skipLayout: boolean

`Private` createContainer

`Private` createSashContainer

`Private` createViewContainer

`Private` distributeEmptySpace

`Optional` lowPriorityIndex: number

`Private` findFirstSnapIndex

`Private` layoutViews

`Private` onDidChange

`Private` relayout

`Optional` lowPriorityIndexes: number[]

`Optional` highPriorityIndexes: number[]

`Optional` sizing: DistributeSizing | SplitSizing | InvisibleSizing