Class GridviewComponent

Hierarchy (view full)

BaseGrid<GridviewPanel>
- GridviewComponent

Implements

IGridviewComponent

Index

Constructors

Properties

_activeGroup _bufferOnDidLayoutChange _deserializer _groups _onDidActiveGroupChange _onDidAddGroup _onDidLayoutfromJSON _onDidRemoveGroup _options gridview onDidActiveChange onDidActiveGroupChange onDidAdd onDidAddGroup onDidLayoutChange onDidLayoutFromJSON onDidRemove onDidRemoveGroup onDidViewVisibilityChangeMicroTaskQueue

Accessors

activeGroup deserializer disableResizing element groups height id isDisposed locked maximumHeight maximumWidth minimumHeight minimumWidth onDidMaximizedGroupChange options orientation size width

Constructors

constructor

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

Properties

`Protected` _activeGroup

_activeGroup: undefined | GridviewPanel<GridviewPanelApiImpl>

`Protected` `Readonly` _bufferOnDidLayoutChange

_bufferOnDidLayoutChange: AsapEvent = ...

`Private` _deserializer

_deserializer: undefined | IPanelDeserializer

`Protected` `Readonly` _groups

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

`Private` `Readonly` _onDidActiveGroupChange

_onDidActiveGroupChange: DockviewEmitter<undefined | GridviewPanel<GridviewPanelApiImpl>> = ...

`Protected` `Readonly` _onDidAddGroup

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

`Private` `Readonly` _onDidLayoutfromJSON

_onDidLayoutfromJSON: DockviewEmitter<void> = ...

`Private` `Readonly` _onDidRemoveGroup

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

`Private` _options

_options: GridviewComponentOptions

`Protected` `Readonly` gridview

gridview: Gridview

`Readonly` onDidActiveChange

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

`Readonly` onDidActiveGroupChange

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

`Readonly` onDidAdd

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

`Readonly` onDidAddGroup

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

`Readonly` onDidLayoutChange

onDidLayoutChange: DockviewEvent<void> = ...

`Readonly` onDidLayoutFromJSON

onDidLayoutFromJSON: DockviewEvent<void> = ...

`Readonly` onDidRemove

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

`Readonly` onDidRemoveGroup

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

`Readonly` onDidViewVisibilityChangeMicroTaskQueue

onDidViewVisibilityChangeMicroTaskQueue: DockviewEvent<void> = ...

Accessors

activeGroup

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

deserializer

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

disableResizing

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

element

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

groups

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

height

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

id

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

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:141
set locked(value): void
Parameters
- value: boolean
Returns void
Inherited from BaseGrid.locked
- Defined in gridview/baseComponentGridview.ts:145

maximumHeight

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

maximumWidth

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

minimumHeight

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

minimumWidth

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

onDidMaximizedGroupChange

get onDidMaximizedGroupChange(): DockviewEvent<void>
Returns DockviewEvent<void>
Implementation of IGridviewComponent.onDidMaximizedGroupChange
Inherited from BaseGrid.onDidMaximizedGroupChange
- Defined in gridview/baseComponentGridview.ts:253

options

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

orientation

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

size

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

width

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

Methods

addDisposables

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

addPanel

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

clear

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

dispose

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

`Protected` doAddGroup

doAddGroup(group, location?, size?): void
Parameters
- group: GridviewPanel<GridviewPanelApiImpl>
- location: number[] = ...
- Optional size: number
Returns void
Inherited from BaseGrid.doAddGroup
- Defined in gridview/baseComponentGridview.ts:257

`Protected` doRemoveGroup

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

doSetGroupActive

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

exitMaximizedGroup

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

focus

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

fromJSON

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

getPanel

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

hasMaximizedGroup

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

isMaximizedGroup

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

isVisible

isVisible(panel): boolean
Parameters
- panel: GridviewPanel<GridviewPanelApiImpl>
Returns boolean
Implementation of IGridviewComponent.isVisible
Inherited from BaseGrid.isVisible
- Defined in gridview/baseComponentGridview.ts:208

layout

layout(width, height, forceResize?): void
Parameters
- width: number
- height: number
- Optional forceResize: boolean
Returns void
Implementation of IGridviewComponent.layout
Inherited from BaseGrid.layout
- Defined in gridview/baseComponentGridview.ts:354

maximizeGroup

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

moveGroup

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

movePanel

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

moveToNext

moveToNext(options?): void
Parameters
- Optional options: MovementOptions2
Returns void
Inherited from BaseGrid.moveToNext
- Defined in gridview/baseComponentGridview.ts:322

moveToPrevious

moveToPrevious(options?): void
Parameters
- Optional options: MovementOptions2
Returns void
Inherited from BaseGrid.moveToPrevious
- Defined in gridview/baseComponentGridview.ts:338

`Private` registerPanel

registerPanel(panel): void
Parameters
- panel: GridviewPanel<GridviewPanelApiImpl>
Returns void
- Defined in gridview/gridviewComponent.ts:400

removeGroup

removeGroup(group): void
Parameters
- group: GridviewPanel<GridviewPanelApiImpl>
Returns void
Overrides BaseGrid.removeGroup
- Defined in gridview/gridviewComponent.ts:472

removePanel

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

setActive

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

setVisible

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

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:176

updateOptions

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

Class GridviewComponent

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

parentElement: HTMLElement

options: GridviewComponentOptions

Returns GridviewComponent

Properties

Protected _activeGroup

Protected Readonly _bufferOnDidLayoutChange

Private _deserializer

Protected Readonly _groups

Private Readonly _onDidActiveGroupChange

Protected Readonly _onDidAddGroup

Private Readonly _onDidLayoutfromJSON

Private Readonly _onDidRemoveGroup

Private _options

Protected Readonly gridview

Readonly onDidActiveChange

Readonly onDidActiveGroupChange

Readonly onDidAdd

Readonly onDidAddGroup

Readonly onDidLayoutChange

Readonly onDidLayoutFromJSON

Readonly onDidRemove

Readonly onDidRemoveGroup

Readonly onDidViewVisibilityChangeMicroTaskQueue

Accessors

activeGroup

Returns undefined | T

deserializer

Returns undefined | IPanelDeserializer

Parameters

value: undefined | IPanelDeserializer

Returns void

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

onDidMaximizedGroupChange

Returns DockviewEvent<void>

options

Returns GridviewComponentOptions

orientation

Returns Orientation

Parameters

value: Orientation

Returns void

size

`Protected` _activeGroup

`Protected` `Readonly` _bufferOnDidLayoutChange

`Private` _deserializer

`Protected` `Readonly` _groups

`Private` `Readonly` _onDidActiveGroupChange

`Protected` `Readonly` _onDidAddGroup

`Private` `Readonly` _onDidLayoutfromJSON

`Private` `Readonly` _onDidRemoveGroup

`Private` _options

`Protected` `Readonly` gridview

`Readonly` onDidActiveChange

`Readonly` onDidActiveGroupChange

`Readonly` onDidAdd

`Readonly` onDidAddGroup

`Readonly` onDidLayoutChange

`Readonly` onDidLayoutFromJSON

`Readonly` onDidRemove

`Readonly` onDidRemoveGroup

`Readonly` onDidViewVisibilityChangeMicroTaskQueue

`Rest` ...args: IDockviewDisposable[]

`Protected` doAddGroup

`Optional` size: number

`Protected` doRemoveGroup

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

`Optional` skipActive?: boolean

`Optional` skipDispose?: boolean

`Optional` forceResize: boolean