Class BaseGrid<T>`Abstract`

Type Parameters

T extends IGridPanelView

Hierarchy (View Summary)

Resizable
- BaseGrid
  - DockviewComponent
  - GridviewComponent

Implements

IBaseGrid<T>

Constructors

constructor

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

Properties

`Protected`_activeGroup

_activeGroup: T | undefined

`Protected` `Readonly`_bufferOnDidLayoutChange

_bufferOnDidLayoutChange: AsapEvent = ...

`Protected` `Readonly`_groups

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

`Protected` `Readonly`gridview

gridview: Gridview

`Readonly`onDidActiveChange

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

`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(): T | undefined
Returns T | undefined
Implementation of IBaseGrid.activeGroup
- Defined in gridview/baseComponentGridview.ts:149

disableResizing

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

element

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

groups

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

height

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

id

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

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:153
set locked(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in gridview/baseComponentGridview.ts:157

maximumHeight

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

maximumWidth

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

minimumHeight

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

minimumWidth

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

size

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

width

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

Methods

activateNext

activateNext(options?: MovementOptions2): void
Parameters
- Optionaloptions: MovementOptions2
Returns void
- Defined in gridview/baseComponentGridview.ts:340

activatePrevious

activatePrevious(options?: MovementOptions2): void
Parameters
- Optionaloptions: MovementOptions2
Returns void
- Defined in gridview/baseComponentGridview.ts:354

addDisposables

addDisposables(...args: DockviewIDisposable[]): void
Parameters
- ...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:222

dispose

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

`Protected`doAddGroup

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

`Protected`doRemoveGroup

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

doSetGroupActive

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

exitMaximizedGroup

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

`Protected`forceRelayout

forceRelayout(): void
Returns void
- Defined in gridview/baseComponentGridview.ts:368

`Abstract`fromJSON

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

getPanel

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

hasMaximizedGroup

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

isMaximizedGroup

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

isVisible

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

layout

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

maximizeGroup

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

removeDisposable

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

removeGroup

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

setVisible

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

`Abstract`toJSON

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

updateOptions

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