Class Gridview

Implements

DockviewIDisposable

Constructors

constructor

new Gridview(proportionalLayout, styles, orientation, locked?, margin?): Gridview
Parameters
- proportionalLayout: boolean
- styles: undefined | ISplitviewStyles
- orientation: Orientation
- Optional locked: boolean
- Optional margin: number
Returns Gridview
- Defined in gridview/gridview.ts:843

Properties

`Private` _locked

_locked: boolean = false

`Private` _margin

_margin: number = 0

`Private` _maximizedNode

_maximizedNode: undefined | {
hiddenOnMaximize: LeafNode[];
leaf: LeafNode;
} = undefined

Type declaration

hiddenOnMaximize: LeafNode[]
leaf: LeafNode

`Private` `Readonly` _onDidChange

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

Type declaration

Optional orthogonalSize?: number
Optional size?: number

`Private` `Readonly` _onDidMaximizedNodeChange

_onDidMaximizedNodeChange: DockviewEmitter<MaximizedViewChanged> = ...

`Private` `Readonly` _onDidViewVisibilityChange

_onDidViewVisibilityChange: DockviewEmitter<void> = ...

`Private` _root

_root: undefined | BranchNode

`Private` `Readonly` disposable

disposable: DockviewMutableDisposable = ...

`Readonly` element

element: HTMLElement

`Readonly` onDidChange

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

Type declaration

Optional orthogonalSize?: number
Optional size?: number

`Readonly` onDidMaximizedNodeChange

onDidMaximizedNodeChange: DockviewEvent<MaximizedViewChanged> = ...

`Readonly` onDidViewVisibilityChange

onDidViewVisibilityChange: DockviewEvent<void> = ...

`Readonly` proportionalLayout

proportionalLayout: boolean

`Readonly` styles

styles: undefined | ISplitviewStyles

Accessors

height

get height(): number
Returns number
- Defined in gridview/gridview.ts:365

length

get length(): number
Returns number
- Defined in gridview/gridview.ts:343

locked

get locked(): boolean
Returns boolean
- Defined in gridview/gridview.ts:385
set locked(value): void
Parameters
- value: boolean
Returns void
- Defined in gridview/gridview.ts:389

margin

get margin(): number
Returns number
- Defined in gridview/gridview.ts:409
set margin(value): void
Parameters
- value: number
Returns void
- Defined in gridview/gridview.ts:413

maximumHeight

get maximumHeight(): number
Returns number
- Defined in gridview/gridview.ts:381

maximumWidth

get maximumWidth(): number
Returns number
- Defined in gridview/gridview.ts:377

minimumHeight

get minimumHeight(): number
Returns number
- Defined in gridview/gridview.ts:373

minimumWidth

get minimumWidth(): number
Returns number
- Defined in gridview/gridview.ts:369

orientation

get orientation(): Orientation
Returns Orientation
- Defined in gridview/gridview.ts:347
set orientation(orientation): void
Parameters
- orientation: Orientation
Returns void
- Defined in gridview/gridview.ts:351

`Private` root

get root(): BranchNode
Returns BranchNode
- Defined in gridview/gridview.ts:664
set root(root): void
Parameters
- root: BranchNode
Returns void
- Defined in gridview/gridview.ts:668

width

get width(): number
Returns number
- Defined in gridview/gridview.ts:361

Methods

`Private` _deserialize

_deserialize(root, orientation, deserializer, orthogonalSize): void
Parameters
- root: ISerializedBranchNode
- orientation: Orientation
- deserializer: IViewDeserializer
- orthogonalSize: number
Returns void
- Defined in gridview/gridview.ts:607

`Private` _deserializeNode

_deserializeNode(node, orientation, deserializer, orthogonalSize): Node
Parameters
- node: ISerializedNode
- orientation: Orientation
- deserializer: IViewDeserializer
- orthogonalSize: number
Returns Node
- Defined in gridview/gridview.ts:621

`Private` _getViews

_getViews(node, orientation, cachedVisibleSize?): GridNode<IGridView>
Parameters
- node: Node
- orientation: Orientation
- Optional cachedVisibleSize: number
Returns GridNode<IGridView>
- Defined in gridview/gridview.ts:793

addView

addView(view, size, location): void
Parameters
- view: IGridView
- size: number | DistributeSizing | SplitSizing | InvisibleSizing
- location: number[]
Returns void
- Defined in gridview/gridview.ts:909

clear

clear(): void
Returns void
- Defined in gridview/gridview.ts:560

deserialize

deserialize<T>(json, deserializer): void
Type Parameters
- T
Parameters
- json: SerializedGridview<T>
- deserializer: IViewDeserializer
Returns void
- Defined in gridview/gridview.ts:573

dispose

dispose(): void
Returns void
Implementation of DockviewIDisposable.dispose
- Defined in gridview/gridview.ts:549

exitMaximizedView

exitMaximizedView(): void
Returns void
- Defined in gridview/gridview.ts:471

`Private` getNode

getNode(location, node?, path?): [BranchNode[], Node]
Parameters
- location: number[]
- node: Node = ...
- path: BranchNode[] = []
Returns [BranchNode[], Node]
- Defined in gridview/gridview.ts:1108

getView

getView(): GridBranchNode<IGridView>
Returns GridBranchNode<IGridView>
- Defined in gridview/gridview.ts:786
getView(location?): GridNode<IGridView>
Parameters
- Optional location: number[]
Returns GridNode<IGridView>
- Defined in gridview/gridview.ts:787

hasMaximizedView

hasMaximizedView(): boolean
Returns boolean
- Defined in gridview/gridview.ts:422

insertOrthogonalSplitviewAtRoot

insertOrthogonalSplitviewAtRoot(): void
If the root is orientated as a VERTICAL node then nest the existing root within a new HORIZIONTAL root node If the root is orientated as a HORIZONTAL node then nest the existing root within a new VERITCAL root node

Returns void
- Defined in gridview/gridview.ts:725

isViewVisible

isViewVisible(location): boolean
Parameters
- location: number[]
Returns boolean
- Defined in gridview/gridview.ts:867

layout

layout(width, height): void
Parameters
- width: number
- height: number
Returns void
- Defined in gridview/gridview.ts:1100

maximizeView

maximizeView(view): void
Parameters
- view: IGridView
Returns void
- Defined in gridview/gridview.ts:426

maximizedView

maximizedView(): undefined | IGridView
Returns undefined | IGridView
- Defined in gridview/gridview.ts:418

moveView

moveView(parentLocation, from, to): void
Parameters
- parentLocation: number[]
- from: number
- to: number
Returns void
- Defined in gridview/gridview.ts:895

next(location): LeafNode
Parameters
- location: number[]
Returns LeafNode
- Defined in gridview/gridview.ts:778

normalize

normalize(): void
Returns void
- Defined in gridview/gridview.ts:684

previous(location): LeafNode
Parameters
- location: number[]
Returns LeafNode
- Defined in gridview/gridview.ts:782

`Private` progmaticSelect

progmaticSelect(location, reverse?): LeafNode
Parameters
- location: number[]
- reverse: boolean = false
Returns LeafNode
- Defined in gridview/gridview.ts:822

remove

remove(view, sizing?): IGridView
Parameters
- view: IGridView
- Optional sizing: DistributeSizing | SplitSizing | InvisibleSizing
Returns IGridView
- Defined in gridview/gridview.ts:975

removeView

removeView(location, sizing?): IGridView
Parameters
- location: number[]
- Optional sizing: DistributeSizing | SplitSizing | InvisibleSizing
Returns IGridView
- Defined in gridview/gridview.ts:980

serialize

serialize(): SerializedGridview<any>
Returns SerializedGridview<any>
- Defined in gridview/gridview.ts:501

setViewVisible

setViewVisible(location, visible): void
Parameters
- location: number[]
- visible: boolean
Returns void
- Defined in gridview/gridview.ts:878

Class Gridview

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

proportionalLayout: boolean

styles: undefined | ISplitviewStyles

orientation: Orientation

Optional locked: boolean

Optional margin: number

Returns Gridview

Properties

Private _locked

Private _margin

Private _maximizedNode

Type declaration

hiddenOnMaximize: LeafNode[]

leaf: LeafNode

Private Readonly _onDidChange

Type declaration

Optional orthogonalSize?: number

Optional size?: number

Private Readonly _onDidMaximizedNodeChange

Private Readonly _onDidViewVisibilityChange

Private _root

Private Readonly disposable

Readonly element

Readonly onDidChange

Type declaration

Optional orthogonalSize?: number

Optional size?: number

Readonly onDidMaximizedNodeChange

Readonly onDidViewVisibilityChange

Readonly proportionalLayout

Readonly styles

Accessors

height

Returns number

length

Returns number

locked

Returns boolean

Parameters

value: boolean

Returns void

margin

Returns number

Parameters

value: number

Returns void

maximumHeight

Returns number

maximumWidth

Returns number

minimumHeight

Returns number

minimumWidth

Returns number

orientation

Returns Orientation

Parameters

orientation: Orientation

Returns void

Private root

Returns BranchNode

Parameters

root: BranchNode

Returns void

width

Returns number

Methods

Private _deserialize

Parameters

root: ISerializedBranchNode

orientation: Orientation

`Optional` locked: boolean

`Optional` margin: number

`Private` _locked

`Private` _margin

`Private` _maximizedNode

`Private` `Readonly` _onDidChange

`Optional` orthogonalSize?: number

`Optional` size?: number

`Private` `Readonly` _onDidMaximizedNodeChange

`Private` `Readonly` _onDidViewVisibilityChange

`Private` _root

`Private` `Readonly` disposable

`Readonly` element

`Readonly` onDidChange

`Optional` orthogonalSize?: number

`Optional` size?: number

`Readonly` onDidMaximizedNodeChange

`Readonly` onDidViewVisibilityChange

`Readonly` proportionalLayout

`Readonly` styles

`Private` root

`Private` _deserialize

`Private` _deserializeNode

`Private` _getViews

`Optional` cachedVisibleSize: number

`Private` getNode

`Optional` location: number[]