Class GridviewComponent

Hierarchy (View Summary)

BaseGrid<GridviewPanel>
- GridviewComponent

Implements

IGridviewComponent

Constructors

constructor

new GridviewComponent(
container: HTMLElement,
options: GridviewComponentOptions,
): GridviewComponent
Parameters
- container: HTMLElement
- options: GridviewComponentOptions
Returns GridviewComponent
Overrides BaseGrid.constructor
- Defined in gridview/gridviewComponent.ts:116

Properties

`Protected`_activeGroup

_activeGroup: GridviewPanel<GridviewPanelApiImpl> | undefined

`Protected` `Readonly`_bufferOnDidLayoutChange

_bufferOnDidLayoutChange: AsapEvent = ...

`Protected` `Readonly`_groups

_groups: Map<string, IValueDisposable<GridviewPanel<GridviewPanelApiImpl>>> = ...

`Protected` `Readonly`_onDidAddGroup

_onDidAddGroup: DockviewEmitter<GridviewPanel<GridviewPanelApiImpl>> = ...

`Protected` `Readonly`gridview

gridview: Gridview

`Readonly`onDidActiveChange

onDidActiveChange: DockviewEvent<
GridviewPanel<GridviewPanelApiImpl>
| undefined,
> = ...

`Readonly`onDidActiveGroupChange

onDidActiveGroupChange: DockviewEvent<
GridviewPanel<GridviewPanelApiImpl>
| undefined,
> = ...

`Readonly`onDidAdd

onDidAdd: DockviewEvent<GridviewPanel<GridviewPanelApiImpl>> = ...

`Readonly`onDidAddGroup

onDidAddGroup: DockviewEvent<GridviewPanel<GridviewPanelApiImpl>> = ...

`Readonly`onDidLayoutChange

onDidLayoutChange: DockviewEvent<void> = ...

`Readonly`onDidLayoutFromJSON

onDidLayoutFromJSON: DockviewEvent<void> = ...

`Readonly`onDidMaximizedChange

onDidMaximizedChange: DockviewEvent<
MaximizedChanged<GridviewPanel<GridviewPanelApiImpl>>,
> = ...

`Readonly`onDidRemove

onDidRemove: DockviewEvent<GridviewPanel<GridviewPanelApiImpl>> = ...

`Readonly`onDidRemoveGroup

onDidRemoveGroup: DockviewEvent<GridviewPanel<GridviewPanelApiImpl>> = ...

`Readonly`onDidViewVisibilityChangeMicroTaskQueue

onDidViewVisibilityChangeMicroTaskQueue: DockviewEvent<void> = ...

Accessors

activeGroup

get activeGroup(): T | undefined
Returns T | undefined
Implementation of IGridviewComponent.activeGroup
Inherited from BaseGrid.activeGroup
- Defined in gridview/baseComponentGridview.ts:149

deserializer

get deserializer(): IPanelDeserializer | undefined
Returns IPanelDeserializer | undefined
- Defined in gridview/gridviewComponent.ts:108
set deserializer(value: IPanelDeserializer | undefined): void
Parameters
- value: IPanelDeserializer | undefined
Returns void
- Defined in gridview/gridviewComponent.ts:112

disableResizing

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

element

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

groups

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

height

get height(): number
Returns number
Implementation of IGridviewComponent.height
Inherited from BaseGrid.height
- Defined in gridview/baseComponentGridview.ts:132

id

get id(): string
Returns string
Implementation of IGridviewComponent.id
Inherited from BaseGrid.id
- Defined in gridview/baseComponentGridview.ts:116

isDisposed

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

locked

get locked(): boolean
Returns boolean
Inherited from BaseGrid.locked
- Defined in gridview/baseComponentGridview.ts:153
set locked(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from BaseGrid.locked
- Defined in gridview/baseComponentGridview.ts:157

maximumHeight

get maximumHeight(): number
Returns number
Implementation of IGridviewComponent.maximumHeight
Inherited from BaseGrid.maximumHeight
- Defined in gridview/baseComponentGridview.ts:139

maximumWidth

get maximumWidth(): number
Returns number
Implementation of IGridviewComponent.maximumWidth
Inherited from BaseGrid.maximumWidth
- Defined in gridview/baseComponentGridview.ts:145

minimumHeight

get minimumHeight(): number
Returns number
Implementation of IGridviewComponent.minimumHeight
Inherited from BaseGrid.minimumHeight
- Defined in gridview/baseComponentGridview.ts:136

minimumWidth

get minimumWidth(): number
Returns number
Implementation of IGridviewComponent.minimumWidth
Inherited from BaseGrid.minimumWidth
- Defined in gridview/baseComponentGridview.ts:142

options

get options(): GridviewComponentOptions
Returns GridviewComponentOptions
- Defined in gridview/gridviewComponent.ts:104

orientation

get orientation(): Orientation
Returns Orientation
Implementation of IGridviewComponent.orientation
- Defined in gridview/gridviewComponent.ts:96
set orientation(value: Orientation): void
Parameters
- value: Orientation
Returns void
Implementation of IGridviewComponent.orientation
- Defined in gridview/gridviewComponent.ts:100

size

get size(): number
Returns number
Implementation of IGridviewComponent.size
Inherited from BaseGrid.size
- Defined in gridview/baseComponentGridview.ts:120

width

get width(): number
Returns number
Implementation of IGridviewComponent.width
Inherited from BaseGrid.width
- Defined in gridview/baseComponentGridview.ts:128

Methods

activateNext

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

activatePrevious

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

addDisposables

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

addPanel

addPanel<T extends object = Parameters>(
options: AddGridviewComponentOptions<T>,
): IGridviewPanel
Type Parameters
- T extends object = Parameters
Parameters
- options: AddGridviewComponentOptions<T>
Returns IGridviewPanel
Implementation of IGridviewComponent.addPanel
- Defined in gridview/gridviewComponent.ts:322

clear

clear(): void
Returns void
Implementation of IGridviewComponent.clear
Overrides BaseGrid.clear
- Defined in gridview/gridviewComponent.ts:274

dispose

dispose(): void
Returns void
Implementation of IGridviewComponent.dispose
Overrides BaseGrid.dispose
- Defined in gridview/gridviewComponent.ts:447

`Protected`doAddGroup

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

`Protected`doRemoveGroup

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

doSetGroupActive

doSetGroupActive(group: GridviewPanel<GridviewPanelApiImpl> | undefined): void
Parameters
- group: GridviewPanel<GridviewPanelApiImpl> | undefined
Returns void
Inherited from BaseGrid.doSetGroupActive
- Defined in gridview/baseComponentGridview.ts:319

exitMaximizedGroup

exitMaximizedGroup(): void
Returns void
Implementation of IGridviewComponent.exitMaximizedGroup
Inherited from BaseGrid.exitMaximizedGroup
- Defined in gridview/baseComponentGridview.ts:266

focus

focus(): void
Returns void
Implementation of IGridviewComponent.focus
- Defined in gridview/gridviewComponent.ts:194

`Protected`forceRelayout

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

fromJSON

fromJSON(serializedGridview: SerializedGridviewComponent): void
Parameters
- serializedGridview: SerializedGridviewComponent
Returns void
Implementation of IGridviewComponent.fromJSON
Overrides BaseGrid.fromJSON
- Defined in gridview/gridviewComponent.ts:198

getPanel

getPanel(id: string): GridviewPanel<GridviewPanelApiImpl> | undefined
Parameters
- id: string
Returns GridviewPanel<GridviewPanelApiImpl> | undefined
Implementation of IGridviewComponent.getPanel
Inherited from BaseGrid.getPanel
- Defined in gridview/baseComponentGridview.ts:315

hasMaximizedGroup

hasMaximizedGroup(): boolean
Returns boolean
Implementation of IGridviewComponent.hasMaximizedGroup
Inherited from BaseGrid.hasMaximizedGroup
- Defined in gridview/baseComponentGridview.ts:270

isMaximizedGroup

isMaximizedGroup(panel: GridviewPanel): boolean
Parameters
- panel: GridviewPanel
Returns boolean
Implementation of IGridviewComponent.isMaximizedGroup
Inherited from BaseGrid.isMaximizedGroup
- Defined in gridview/baseComponentGridview.ts:262

isVisible

isVisible(panel: GridviewPanel): boolean
Parameters
- panel: GridviewPanel
Returns boolean
Implementation of IGridviewComponent.isVisible
Inherited from BaseGrid.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 IGridviewComponent.layout
Inherited from BaseGrid.layout
- Defined in gridview/baseComponentGridview.ts:372

maximizeGroup

maximizeGroup(panel: GridviewPanel): void
Parameters
- panel: GridviewPanel
Returns void
Implementation of IGridviewComponent.maximizeGroup
Inherited from BaseGrid.maximizeGroup
- Defined in gridview/baseComponentGridview.ts:257

moveGroup

moveGroup(
    referenceGroup: IGridPanelComponentView,
    groupId: string,
    target: Position,
): void
Parameters
- referenceGroup: IGridPanelComponentView
- groupId: string
- target: Position
Returns void
- Defined in gridview/gridviewComponent.ts:394

movePanel

movePanel(
panel: GridviewPanel,
options: { direction: Direction; reference: string; size?: number },
): void
Parameters
- panel: GridviewPanel
- options: { direction: Direction; reference: string; size?: number }
Returns void
Implementation of IGridviewComponent.movePanel
- Defined in gridview/gridviewComponent.ts:290

removeDisposable

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

removeGroup

removeGroup(group: GridviewPanel): void
Parameters
- group: GridviewPanel
Returns void
Overrides BaseGrid.removeGroup
- Defined in gridview/gridviewComponent.ts:443

removePanel

removePanel(panel: GridviewPanel): void
Parameters
- panel: GridviewPanel
Returns void
Implementation of IGridviewComponent.removePanel
- Defined in gridview/gridviewComponent.ts:161

setActive

setActive(panel: GridviewPanel): void
Parameters
- panel: GridviewPanel
Returns void
Implementation of IGridviewComponent.setActive
- Defined in gridview/gridviewComponent.ts:188

setVisible

setVisible(panel: GridviewPanel, visible: boolean): void
Parameters
- panel: GridviewPanel
- visible: boolean
Returns void
Implementation of IGridviewComponent.setVisible
Overrides BaseGrid.setVisible
- Defined in gridview/gridviewComponent.ts:184

toJSON

toJSON(): SerializedGridviewComponent
Serialize the current state of the layout

Returns SerializedGridviewComponent
A JSON respresentation of the layout
Implementation of IGridviewComponent.toJSON
Overrides BaseGrid.toJSON
- Defined in gridview/gridviewComponent.ts:170

updateOptions

updateOptions(options: Partial<GridviewComponentOptions>): void
Parameters
- options: Partial<GridviewComponentOptions>
Returns void
Implementation of IGridviewComponent.updateOptions
Overrides BaseGrid.updateOptions
- Defined in gridview/gridviewComponent.ts:145

Class GridviewComponent

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns GridviewComponent

Properties

Protected_activeGroup

Protected Readonly_bufferOnDidLayoutChange

Protected Readonly_groups

Protected Readonly_onDidAddGroup

Protected Readonlygridview

ReadonlyonDidActiveChange

ReadonlyonDidActiveGroupChange

ReadonlyonDidAdd

ReadonlyonDidAddGroup

ReadonlyonDidLayoutChange

ReadonlyonDidLayoutFromJSON

ReadonlyonDidMaximizedChange

ReadonlyonDidRemove

ReadonlyonDidRemoveGroup

ReadonlyonDidViewVisibilityChangeMicroTaskQueue

Accessors

activeGroup

Returns T | undefined

deserializer

Returns IPanelDeserializer | undefined

Parameters

Returns void

disableResizing

Returns boolean

Parameters

Returns void

element

Returns HTMLElement

groups

Returns T[]

height

Returns number

id

Returns string

isDisposed

Returns boolean

locked

Returns boolean

Parameters

Returns void

maximumHeight

Returns number

maximumWidth

Returns number

minimumHeight

Returns number

minimumWidth

Returns number

options

Returns GridviewComponentOptions

orientation

Returns Orientation

Parameters

Returns void

size

Returns number

width

Returns number

Methods

activateNext

Parameters

Returns void

activatePrevious

Parameters

Returns void

addDisposables

Parameters

`Protected`_activeGroup

`Protected` `Readonly`_bufferOnDidLayoutChange

`Protected` `Readonly`_groups

`Protected` `Readonly`_onDidAddGroup

`Protected` `Readonly`gridview

`Readonly`onDidActiveChange

`Readonly`onDidActiveGroupChange

`Readonly`onDidAdd

`Readonly`onDidAddGroup

`Readonly`onDidLayoutChange

`Readonly`onDidLayoutFromJSON

`Readonly`onDidMaximizedChange

`Readonly`onDidRemove

`Readonly`onDidRemoveGroup

`Readonly`onDidViewVisibilityChangeMicroTaskQueue

`Protected`doAddGroup

`Protected`doRemoveGroup

`Protected`forceRelayout