Class GridviewPanel<T>`Abstract`

Type Parameters

T extends GridviewPanelApiImpl = GridviewPanelApiImpl

Hierarchy (view full)

BasePanelView<T>
- GridviewPanel
  - DockviewGroupPanel

Implements

Constructors

constructor

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

Properties

`Private` _evaluatedMaximumHeight

_evaluatedMaximumHeight: number = Number.MAX_SAFE_INTEGER

`Private` _evaluatedMaximumWidth

_evaluatedMaximumWidth: number = Number.MAX_SAFE_INTEGER

`Private` _evaluatedMinimumHeight

_evaluatedMinimumHeight: number = 0

`Private` _evaluatedMinimumWidth

_evaluatedMinimumWidth: number = 0

`Private` _maximumHeight

_maximumHeight: FunctionOrValue<number> = Number.MAX_SAFE_INTEGER

`Private` _maximumWidth

_maximumWidth: FunctionOrValue<number> = Number.MAX_SAFE_INTEGER

`Private` _minimumHeight

_minimumHeight: FunctionOrValue<number> = 0

`Private` _minimumWidth

_minimumWidth: FunctionOrValue<number> = 0

`Private` `Readonly` _onDidChange

_onDidChange: DockviewEmitter<undefined | IViewSize> = ...

`Protected` `Optional` _params

_params?: PanelInitParameters

`Private` `Optional` _priority

_priority?: Low | High | Normal

`Private` _snap

_snap: boolean = false

`Readonly` api

api: T

`Protected` `Readonly` component

component: string

`Readonly` id

id: string

`Readonly` onDidChange

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

`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:164

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

maximumHeight

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

maximumWidth

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

minimumHeight

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

minimumWidth

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

params

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

priority

get priority(): undefined | Low | High | Normal
Returns undefined | Low | High | Normal
Implementation of IGridviewPanel.priority
- Defined in gridview/gridviewPanel.ts:68

snap

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

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

`Protected` __maximumWidth

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

`Protected` __minimumHeight

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

`Protected` __minimumWidth

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

addDisposables

addDisposables(...args): void
Parameters
- Rest ...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): void
Parameters
- parameters: GridviewInitParameters
Returns void
Implementation of IGridPanelComponentView.init
Overrides BasePanelView.init
- Defined in gridview/gridviewPanel.ts:256

layout

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

setActive

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

setVisible

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

toJSON

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

update

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

`Private` updateConstraints

updateConstraints(): void
Returns void
- Defined in gridview/gridviewPanel.ts:280

Class GridviewPanel<T>Abstract

Type Parameters

T extends GridviewPanelApiImpl = GridviewPanelApiImpl

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends GridviewPanelApiImpl = GridviewPanelApiImpl

Parameters

id: string

component: string

Optional options: { maximumHeight?: number; maximumWidth?: number; minimumHeight?: number; minimumWidth?: number; }

Optional maximumHeight?: number

Optional maximumWidth?: number

Optional minimumHeight?: number

Optional minimumWidth?: number

Optional api: T

Returns GridviewPanel<T>

Properties

Private _evaluatedMaximumHeight

Private _evaluatedMaximumWidth

Private _evaluatedMinimumHeight

Private _evaluatedMinimumWidth

Private _maximumHeight

Private _maximumWidth

Private _minimumHeight

Private _minimumWidth

Private Readonly _onDidChange

Protected Optional _params

Private Optional _priority

Private _snap

Readonly api

Protected Readonly component

Readonly id

Readonly onDidChange

Protected Optional part

Accessors

element

Returns HTMLElement

height

Returns number

isActive

Returns boolean

isDisposed

Returns boolean

isVisible

Returns boolean

maximumHeight

Returns number

maximumWidth

Returns number

minimumHeight

Returns number

minimumWidth

Returns number

params

Returns undefined | Parameters

priority

Returns undefined | Low | High | Normal

snap

Returns boolean

width

Returns number

Methods

Protected __maximumHeight

Returns number

Protected __maximumWidth

Returns number

Protected __minimumHeight

Returns number

Protected __minimumWidth

Returns number

addDisposables

Parameters

Class GridviewPanel<T>`Abstract`

`Optional` options: {
maximumHeight?: number;
maximumWidth?: number;
minimumHeight?: number;
minimumWidth?: number;
}

`Optional` maximumHeight?: number

`Optional` maximumWidth?: number

`Optional` minimumHeight?: number

`Optional` minimumWidth?: number

`Optional` api: T

`Private` _evaluatedMaximumHeight

`Private` _evaluatedMaximumWidth

`Private` _evaluatedMinimumHeight

`Private` _evaluatedMinimumWidth

`Private` _maximumHeight

`Private` _maximumWidth

`Private` _minimumHeight

`Private` _minimumWidth

`Private` `Readonly` _onDidChange

`Protected` `Optional` _params

`Private` `Optional` _priority

`Private` _snap

`Readonly` api

`Protected` `Readonly` component

`Readonly` id

`Readonly` onDidChange

`Protected` `Optional` part

`Protected` __maximumHeight

`Protected` __maximumWidth

`Protected` __minimumHeight

`Protected` __minimumWidth

`Rest` ...args: DockviewIDisposable[]

`Protected` `Abstract` getComponent

`Private` updateConstraints