Class DockviewGroupPanel

Hierarchy (view full)

GridviewPanel<DockviewGroupPanelApiImpl>
- DockviewGroupPanel

Implements

IDockviewGroupPanel

Index

Constructors

Properties

_model _params? api component id onDidChange part?

Accessors

activePanel element header height isActive isDisposed isVisible locked maximumHeight maximumWidth minimumHeight minimumWidth model panels params priority size snap width

Methods

addDisposables dispose focus getComponent init initialize layout setActive setVisible toJSON update

Constructors

constructor

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

Properties

`Private` `Readonly` _model

_model: DockviewGroupPanelModel

`Protected` `Optional` _params

_params?: PanelInitParameters

`Readonly` api

api: DockviewGroupPanelApiImpl

`Protected` `Readonly` component

component: string

`Readonly` id

id: string

`Readonly` onDidChange

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

`Protected` `Optional` part

part?: IFrameworkPart

Accessors

activePanel

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

element

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

header

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

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

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

locked

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

maximumHeight

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

maximumWidth

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

minimumHeight

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

minimumWidth

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

model

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

panels

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

params

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

priority

get priority(): undefined | Low | High | Normal
Returns undefined | Low | High | Normal
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:73

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

addDisposables

addDisposables(...args): void
Parameters
- Rest ...args: IDockviewDisposable[]
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:148

focus

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

getComponent

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

init

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

initialize

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

layout

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

setActive

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

setVisible

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

toJSON

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

update

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

Generated using TypeDoc