Class BaseGrid<T>`Abstract`

Constructors

constructor

new BaseGrid<T>(container, options): BaseGrid<T>
Type Parameters
- T extends IGridPanelView
Parameters
- container: HTMLElement
- options: BaseGridOptions
Returns BaseGrid<T>
Overrides Resizable.constructor
- Defined in gridview/baseComponentGridview.ts:158

Properties

`Protected` _activeGroup

_activeGroup: undefined | T

`Protected` `Readonly` _bufferOnDidLayoutChange

_bufferOnDidLayoutChange: AsapEvent = ...

`Private` `Readonly` _classNames

_classNames: Classnames

`Protected` `Readonly` _groups

_groups: Map<string, IValueDisposable<T>> = ...

`Private` `Readonly` _id

_id: string = ...

`Private` `Readonly` _onDidActiveChange

_onDidActiveChange: DockviewEmitter<undefined | T> = ...

`Private` `Readonly` _onDidAdd

_onDidAdd: DockviewEmitter<T> = ...

`Private` `Readonly` _onDidMaximizedChange

_onDidMaximizedChange: DockviewEmitter<MaximizedChanged<T>> = ...

`Private` `Readonly` _onDidRemove

_onDidRemove: DockviewEmitter<T> = ...

`Private` `Readonly` _onDidViewVisibilityChangeMicroTaskQueue

_onDidViewVisibilityChangeMicroTaskQueue: AsapEvent = ...

`Protected` `Readonly` gridview

gridview: Gridview

`Readonly` onDidActiveChange

onDidActiveChange: DockviewEvent<undefined | T> = ...

`Readonly` onDidAdd

onDidAdd: DockviewEvent<T> = ...

`Readonly` onDidLayoutChange

onDidLayoutChange: DockviewEvent<void> = ...

`Readonly` onDidMaximizedChange

onDidMaximizedChange: DockviewEvent<MaximizedChanged<T>> = ...

`Readonly` onDidRemove

onDidRemove: DockviewEvent<T> = ...

`Readonly` onDidViewVisibilityChangeMicroTaskQueue

onDidViewVisibilityChangeMicroTaskQueue: DockviewEvent<void> = ...

Accessors

activeGroup

get activeGroup(): undefined | T
Returns undefined | T
Implementation of IBaseGrid.activeGroup
- Defined in gridview/baseComponentGridview.ts:146

disableResizing

get disableResizing(): boolean
Returns boolean
Inherited from Resizable.disableResizing
- Defined in resizable.ts:12
set disableResizing(value): void
Parameters
- value: boolean
Returns void
Inherited from Resizable.disableResizing
- Defined in resizable.ts:16

element

get element(): HTMLElement
Returns HTMLElement
Implementation of IBaseGrid.element
Inherited from Resizable.element
- Defined in resizable.ts:8

groups

get groups(): T[]
Returns T[]
Implementation of IBaseGrid.groups
- Defined in gridview/baseComponentGridview.ts:121

height

get height(): number
Returns number
Implementation of IBaseGrid.height
- Defined in gridview/baseComponentGridview.ts:129

id

get id(): string
Returns string
Implementation of IBaseGrid.id
- Defined in gridview/baseComponentGridview.ts:113

isDisposed

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

locked

get locked(): boolean
Returns boolean
- Defined in gridview/baseComponentGridview.ts:150
set locked(value): void
Parameters
- value: boolean
Returns void
- Defined in gridview/baseComponentGridview.ts:154

maximumHeight

get maximumHeight(): number
Returns number
Implementation of IBaseGrid.maximumHeight
- Defined in gridview/baseComponentGridview.ts:136

maximumWidth

get maximumWidth(): number
Returns number
Implementation of IBaseGrid.maximumWidth
- Defined in gridview/baseComponentGridview.ts:142

minimumHeight

get minimumHeight(): number
Returns number
Implementation of IBaseGrid.minimumHeight
- Defined in gridview/baseComponentGridview.ts:133

minimumWidth

get minimumWidth(): number
Returns number
Implementation of IBaseGrid.minimumWidth
- Defined in gridview/baseComponentGridview.ts:139

size

get size(): number
Returns number
Implementation of IBaseGrid.size
- Defined in gridview/baseComponentGridview.ts:117

width

get width(): number
Returns number
Implementation of IBaseGrid.width
- Defined in gridview/baseComponentGridview.ts:125

Methods

addDisposables

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

`Abstract` clear

clear(): void
Returns void
Implementation of IBaseGrid.clear
- Defined in gridview/baseComponentGridview.ts:219

dispose

dispose(): void
Returns void
Implementation of IBaseGrid.dispose
Overrides Resizable.dispose
- Defined in gridview/baseComponentGridview.ts:382

`Protected` doAddGroup

doAddGroup(group, location?, size?): void
Parameters
- group: T
- location: number[] = ...
- Optional size: number
Returns void
- Defined in gridview/baseComponentGridview.ts:271

`Protected` doRemoveGroup

doRemoveGroup(group, options?): T
Parameters
- group: T
- Optional options: {
  skipActive?: boolean;
  skipDispose?: boolean;
  }
  - Optional skipActive?: boolean
  - Optional skipDispose?: boolean
Returns T
- Defined in gridview/baseComponentGridview.ts:281

doSetGroupActive

doSetGroupActive(group): void
Parameters
- group: undefined | T
Returns void
- Defined in gridview/baseComponentGridview.ts:315

exitMaximizedGroup

exitMaximizedGroup(): void
Returns void
Implementation of IBaseGrid.exitMaximizedGroup
- Defined in gridview/baseComponentGridview.ts:263

`Abstract` fromJSON

fromJSON(data): void
Parameters
- data: any
Returns void
Implementation of IBaseGrid.fromJSON
- Defined in gridview/baseComponentGridview.ts:217

getPanel

getPanel(id): undefined | T
Parameters
- id: string
Returns undefined | T
Implementation of IBaseGrid.getPanel
- Defined in gridview/baseComponentGridview.ts:311

hasMaximizedGroup

hasMaximizedGroup(): boolean
Returns boolean
Implementation of IBaseGrid.hasMaximizedGroup
- Defined in gridview/baseComponentGridview.ts:267

isMaximizedGroup

isMaximizedGroup(panel): boolean
Parameters
- panel: T
Returns boolean
Implementation of IBaseGrid.isMaximizedGroup
- Defined in gridview/baseComponentGridview.ts:259

isVisible

isVisible(panel): boolean
Parameters
- panel: T
Returns boolean
Implementation of IBaseGrid.isVisible
- Defined in gridview/baseComponentGridview.ts:226

layout

layout(width, height, forceResize?): void
Parameters
- width: number
- height: number
- Optional forceResize: boolean
Returns void
Implementation of IBaseGrid.layout
Overrides Resizable.layout
- Defined in gridview/baseComponentGridview.ts:368

maximizeGroup

maximizeGroup(panel): void
Parameters
- panel: T
Returns void
Implementation of IBaseGrid.maximizeGroup
- Defined in gridview/baseComponentGridview.ts:254

moveToNext

moveToNext(options?): void
Parameters
- Optional options: MovementOptions2
Returns void
- Defined in gridview/baseComponentGridview.ts:336

moveToPrevious

moveToPrevious(options?): void
Parameters
- Optional options: MovementOptions2
Returns void
- Defined in gridview/baseComponentGridview.ts:352

removeGroup

removeGroup(group): void
Parameters
- group: T
Returns void
- Defined in gridview/baseComponentGridview.ts:332

setVisible

setVisible(panel, visible): void
Parameters
- panel: T
- visible: boolean
Returns void
Implementation of IBaseGrid.setVisible
- Defined in gridview/baseComponentGridview.ts:221

`Abstract` toJSON

toJSON(): object
Returns object
Implementation of IBaseGrid.toJSON
- Defined in gridview/baseComponentGridview.ts:215

updateOptions

updateOptions(options): void
Parameters
- options: Partial<BaseGridOptions>
Returns void
- Defined in gridview/baseComponentGridview.ts:230

Class BaseGrid<T>Abstract

Type Parameters

T extends IGridPanelView

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends IGridPanelView

Parameters

container: HTMLElement

options: BaseGridOptions

Returns BaseGrid<T>

Properties

Protected _activeGroup

Protected Readonly _bufferOnDidLayoutChange

Private Readonly _classNames

Protected Readonly _groups

Private Readonly _id

Private Readonly _onDidActiveChange

Private Readonly _onDidAdd

Private Readonly _onDidMaximizedChange

Private Readonly _onDidRemove

Private Readonly _onDidViewVisibilityChangeMicroTaskQueue

Protected Readonly gridview

Readonly onDidActiveChange

Readonly onDidAdd

Readonly onDidLayoutChange

Readonly onDidMaximizedChange

Readonly onDidRemove

Readonly onDidViewVisibilityChangeMicroTaskQueue

Accessors

activeGroup

Returns undefined | T

disableResizing

Returns boolean

Parameters

value: boolean

Returns void

element

Returns HTMLElement

groups

Returns T[]

height

Returns number

id

Returns string

isDisposed

Returns boolean

locked

Returns boolean

Parameters

value: boolean

Returns void

maximumHeight

Returns number

maximumWidth

Returns number

minimumHeight

Returns number

minimumWidth

Returns number

size

Returns number

width

Returns number

Methods

addDisposables

Parameters

Rest ...args: DockviewIDisposable[]

Returns void

Abstract clear

Returns void

dispose

Returns void

Class BaseGrid<T>`Abstract`

`Protected` _activeGroup

`Protected` `Readonly` _bufferOnDidLayoutChange

`Private` `Readonly` _classNames

`Protected` `Readonly` _groups

`Private` `Readonly` _id

`Private` `Readonly` _onDidActiveChange

`Private` `Readonly` _onDidAdd

`Private` `Readonly` _onDidMaximizedChange

`Private` `Readonly` _onDidRemove

`Private` `Readonly` _onDidViewVisibilityChangeMicroTaskQueue

`Protected` `Readonly` gridview

`Readonly` onDidActiveChange

`Readonly` onDidAdd

`Readonly` onDidLayoutChange

`Readonly` onDidMaximizedChange

`Readonly` onDidRemove

`Readonly` onDidViewVisibilityChangeMicroTaskQueue

`Rest` ...args: DockviewIDisposable[]

`Abstract` clear

`Protected` doAddGroup

`Optional` size: number

`Protected` doRemoveGroup

`Optional` options: {
skipActive?: boolean;
skipDispose?: boolean;
}

`Optional` skipActive?: boolean

`Optional` skipDispose?: boolean

`Abstract` fromJSON

`Optional` forceResize: boolean

`Optional` options: MovementOptions2

`Optional` options: MovementOptions2

`Abstract` toJSON