Class DockviewGroupPanel

Hierarchy (View Summary)

GridviewPanel<DockviewGroupPanelApiImpl>
- DockviewGroupPanel

Implements

IDockviewGroupPanel

Constructors

constructor

new DockviewGroupPanel(
    accessor: DockviewComponent,
    id: string,
    options: GroupOptions,
): DockviewGroupPanel
Parameters
- accessor: DockviewComponent
- id: string
- options: GroupOptions
Returns DockviewGroupPanel
Overrides GridviewPanel.constructor
- Defined in dockview/dockviewGroupPanel.ts:118

Properties

`Protected` `Optional`_params

_params?: PanelInitParameters

`Readonly`api

api: DockviewGroupPanelApiImpl

`Protected` `Readonly`component

component: string

`Readonly`id

id: string

`Readonly`onDidChange

onDidChange: DockviewEvent<IViewSize | undefined> = ...

`Protected` `Optional`part

part?: IFrameworkPart

Accessors

activePanel

get activePanel(): IDockviewPanel | undefined
Returns IDockviewPanel | undefined
Implementation of IDockviewGroupPanel.activePanel
- Defined in dockview/dockviewGroupPanel.ts:94

element

get element(): HTMLElement
Returns HTMLElement
Inherited from GridviewPanel.element
- Defined in gridview/basePanelView.ts:42

get header(): IHeader
Returns IHeader
- Defined in dockview/dockviewGroupPanel.ts:114

height

get height(): number
Returns number
Implementation of IDockviewGroupPanel.height
Inherited from GridviewPanel.height
- Defined in gridview/basePanelView.ts:50

isActive

get isActive(): boolean
Returns boolean
Inherited from GridviewPanel.isActive
- Defined in gridview/gridviewPanel.ts:164

isDisposed

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

isVisible

get isVisible(): boolean
Returns boolean
Inherited from GridviewPanel.isVisible
- Defined in gridview/gridviewPanel.ts:168

locked

get locked(): DockviewGroupPanelLocked
Returns DockviewGroupPanelLocked
Implementation of IDockviewGroupPanel.locked
- Defined in dockview/dockviewGroupPanel.ts:106
set locked(value: DockviewGroupPanelLocked): void
Parameters
- value: DockviewGroupPanelLocked
Returns void
Implementation of IDockviewGroupPanel.locked
- Defined in dockview/dockviewGroupPanel.ts:110

maximumHeight

get maximumHeight(): number
Returns number
Implementation of IDockviewGroupPanel.maximumHeight
Overrides GridviewPanel.maximumHeight
- Defined in dockview/dockviewGroupPanel.ts:78

maximumWidth

get maximumWidth(): number
Returns number
Implementation of IDockviewGroupPanel.maximumWidth
Overrides GridviewPanel.maximumWidth
- Defined in dockview/dockviewGroupPanel.ts:66

minimumHeight

get minimumHeight(): number
Returns number
Implementation of IDockviewGroupPanel.minimumHeight
Overrides GridviewPanel.minimumHeight
- Defined in dockview/dockviewGroupPanel.ts:54

minimumWidth

get minimumWidth(): number
Returns number
Implementation of IDockviewGroupPanel.minimumWidth
Overrides GridviewPanel.minimumWidth
- Defined in dockview/dockviewGroupPanel.ts:42

model

get model(): DockviewGroupPanelModel
Returns DockviewGroupPanelModel
Implementation of IDockviewGroupPanel.model
- Defined in dockview/dockviewGroupPanel.ts:102

panels

get panels(): IDockviewPanel[]
Returns IDockviewPanel[]
Implementation of IDockviewGroupPanel.panels
- Defined in dockview/dockviewGroupPanel.ts:90

params

get params(): Parameters | undefined
Returns Parameters | undefined
Implementation of IDockviewGroupPanel.params
Inherited from GridviewPanel.params
- Defined in gridview/basePanelView.ts:54

priority

get priority(): LayoutPriority | undefined
Returns LayoutPriority | undefined
Implementation of IDockviewGroupPanel.priority
Inherited from GridviewPanel.priority
- Defined in gridview/gridviewPanel.ts:68

size

get size(): number
Returns number
Implementation of IDockviewGroupPanel.size
- Defined in dockview/dockviewGroupPanel.ts:98

snap

get snap(): boolean
Returns boolean
Implementation of IDockviewGroupPanel.snap
Inherited from GridviewPanel.snap
- Defined in gridview/gridviewPanel.ts:72

width

get width(): number
Returns number
Implementation of IDockviewGroupPanel.width
Inherited from GridviewPanel.width
- Defined in gridview/basePanelView.ts:46

Methods

`Protected`__maximumHeight

__maximumHeight(): number
Returns number
Inherited from GridviewPanel.__maximumHeight
- Defined in gridview/gridviewPanel.ts:150

`Protected`__maximumWidth

__maximumWidth(): number
Returns number
Inherited from GridviewPanel.__maximumWidth
- Defined in gridview/gridviewPanel.ts:122

`Protected`__minimumHeight

__minimumHeight(): number
Returns number
Inherited from GridviewPanel.__minimumHeight
- Defined in gridview/gridviewPanel.ts:136

`Protected`__minimumWidth

__minimumWidth(): number
Returns number
Inherited from GridviewPanel.__minimumWidth
- Defined in gridview/gridviewPanel.ts:108

addDisposables

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

dispose

dispose(): void
Returns void
Inherited from GridviewPanel.dispose
- Defined in gridview/basePanelView.ts:146

focus

focus(): void
Returns void
Implementation of IDockviewGroupPanel.focus
Overrides GridviewPanel.focus
- Defined in dockview/dockviewGroupPanel.ts:182

getComponent

getComponent(): IFrameworkPart
Returns IFrameworkPart
Overrides GridviewPanel.getComponent
- Defined in dockview/dockviewGroupPanel.ts:211

init

init(parameters: GridviewInitParameters): void
Parameters
- parameters: GridviewInitParameters
Returns void
Inherited from GridviewPanel.init
- Defined in gridview/gridviewPanel.ts:264

initialize

initialize(): void
Returns void
- Defined in dockview/dockviewGroupPanel.ts:189

layout

layout(width: number, height: number): void
Parameters
- width: number
- height: number
Returns void
Overrides GridviewPanel.layout
- Defined in dockview/dockviewGroupPanel.ts:198

relayout

relayout(): void
Re-run the group's layout with its current dimensions, propagating a header-size change down to the content + active panel.

Returns void
- Defined in dockview/dockviewGroupPanel.ts:207

removeDisposable

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

setActive

setActive(isActive: boolean): void
Parameters
- isActive: boolean
Returns void
Overrides GridviewPanel.setActive
- Defined in dockview/dockviewGroupPanel.ts:193

setVisible

setVisible(isVisible: boolean): void
Parameters
- isVisible: boolean
Returns void
Inherited from GridviewPanel.setVisible
- Defined in gridview/gridviewPanel.ts:256

toJSON

toJSON(): any
Returns any
Implementation of IDockviewGroupPanel.toJSON
Overrides GridviewPanel.toJSON
- Defined in dockview/dockviewGroupPanel.ts:215

update

update(event: PanelUpdateEvent): void
Parameters
- event: PanelUpdateEvent
Returns void
Implementation of IDockviewGroupPanel.update
Inherited from GridviewPanel.update
- Defined in gridview/basePanelView.ts:114