Class GridviewPanel<T>`Abstract`

Type Parameters

T extends GridviewPanelApiImpl = GridviewPanelApiImpl

Hierarchy (View Summary)

BasePanelView<T>
- GridviewPanel
  - DockviewGroupPanel

Implements

Index

Constructors

constructor

new GridviewPanel<T extends GridviewPanelApiImpl = GridviewPanelApiImpl>(
    id: string,
    component: string,
    options?: {
        maximumHeight?: number;
        maximumWidth?: number;
        minimumHeight?: number;
        minimumWidth?: number;
    },
    api?: T,
): GridviewPanel<T>
Type Parameters
- T extends GridviewPanelApiImpl = GridviewPanelApiImpl
Parameters
- id: string
- component: string
- Optionaloptions: {
      maximumHeight?: number;
      maximumWidth?: number;
      minimumHeight?: number;
      minimumWidth?: number;
  }
- Optionalapi: T
Returns GridviewPanel<T>
Overrides BasePanelView<T>.constructor
- Defined in gridview/gridviewPanel.ts:173

Properties

`Protected` `Optional`_params

_params?: PanelInitParameters

`Readonly`api

api: T

`Protected` `Readonly`component

component: string

`Readonly`id

id: string

`Readonly`onDidChange

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

`Protected` `Optional`part

part?: IFrameworkPart

Accessors

element

get element(): HTMLElement
Returns HTMLElement
Implementation of IGridPanelComponentView.element
Inherited from BasePanelView.element
- Defined in gridview/basePanelView.ts:42

height

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

isActive

get isActive(): boolean
Returns boolean
Implementation of IGridPanelComponentView.isActive
- Defined in gridview/gridviewPanel.ts:165

isDisposed

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

isVisible

get isVisible(): boolean
Returns boolean
Implementation of IGridPanelComponentView.isVisible
- Defined in gridview/gridviewPanel.ts:169

maximumHeight

get maximumHeight(): number
Returns number
Implementation of IGridviewPanel.maximumHeight
- Defined in gridview/gridviewPanel.ts:93

maximumWidth

get maximumWidth(): number
Returns number
Implementation of IGridviewPanel.maximumWidth
- Defined in gridview/gridviewPanel.ts:101

minimumHeight

get minimumHeight(): number
Returns number
Implementation of IGridviewPanel.minimumHeight
- Defined in gridview/gridviewPanel.ts:85

minimumWidth

get minimumWidth(): number
Returns number
Implementation of IGridviewPanel.minimumWidth
- Defined in gridview/gridviewPanel.ts:77

params

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

priority

get priority(): LayoutPriority | undefined
Returns LayoutPriority | undefined
Implementation of IGridviewPanel.priority
- Defined in gridview/gridviewPanel.ts:69

snap

get snap(): boolean
Returns boolean
Implementation of IGridviewPanel.snap
- Defined in gridview/gridviewPanel.ts:73

width

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

Methods

`Protected`__maximumHeight

__maximumHeight(): number
Returns number
- Defined in gridview/gridviewPanel.ts:151

`Protected`__maximumWidth

__maximumWidth(): number
Returns number
- Defined in gridview/gridviewPanel.ts:123

`Protected`__minimumHeight

__minimumHeight(): number
Returns number
- Defined in gridview/gridviewPanel.ts:137

`Protected`__minimumWidth

__minimumWidth(): number
Returns number
- Defined in gridview/gridviewPanel.ts:109

addDisposables

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

dispose

dispose(): void
Returns void
Implementation of IGridPanelComponentView.dispose
Inherited from BasePanelView.dispose
- Defined in gridview/basePanelView.ts:148

focus

focus(): void
Returns void
Implementation of IGridviewPanel.focus
Inherited from BasePanelView.focus
- Defined in gridview/basePanelView.ts:86

`Protected` `Abstract`getComponent

getComponent(): IFrameworkPart
Returns IFrameworkPart
Inherited from BasePanelView.getComponent
- Defined in gridview/basePanelView.ts:40

init

init(parameters: GridviewInitParameters): void
Parameters
- parameters: GridviewInitParameters
Returns void
Implementation of IGridPanelComponentView.init
Overrides BasePanelView.init
- Defined in gridview/gridviewPanel.ts:257

layout

layout(width: number, height: number): void
Parameters
- width: number
- height: number
Returns void
Implementation of IGridPanelComponentView.layout
Inherited from BasePanelView.layout
- Defined in gridview/basePanelView.ts:97

removeDisposable

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

setActive

setActive(isActive: boolean): void
Parameters
- isActive: boolean
Returns void
Implementation of IGridPanelComponentView.setActive
- Defined in gridview/gridviewPanel.ts:253

setVisible

setVisible(isVisible: boolean): void
Parameters
- isVisible: boolean
Returns void
Implementation of IGridPanelComponentView.setVisible
- Defined in gridview/gridviewPanel.ts:249

toJSON

toJSON(): GridPanelViewState
Returns GridPanelViewState
Implementation of IGridviewPanel.toJSON
Overrides BasePanelView.toJSON
- Defined in gridview/gridviewPanel.ts:290

update

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