Interface IDockviewPanel

interface IDockviewPanel {
    api: DockviewPanelApi;
    group: DockviewGroupPanel;
    id: string;
    maximumHeight?: number;
    maximumWidth?: number;
    minimumHeight?: number;
    minimumWidth?: number;
    params: undefined | Parameters;
    title: undefined | string;
    view: IDockviewPanelModel;
    dispose(): void;
    focus(): void;
    init(params): void;
    layout(width, height): void;
    runEvents(): void;
    setTitle(title): void;
    toJSON(): GroupviewPanelState;
    update(event): void;
    updateParentGroup(group, options?): void;
}

Hierarchy (view full)

IDockviewDisposable
IPanel
- IDockviewPanel

Implemented by

DockviewPanel

Index

Properties

api group id maximumHeight? maximumWidth? minimumHeight? minimumWidth? params title view

Methods

dispose focus init layout runEvents setTitle toJSON update updateParentGroup

Properties

`Readonly` api

api: DockviewPanelApi

`Readonly` group

group: DockviewGroupPanel

`Readonly` id

id: string

`Optional` `Readonly` maximumHeight

maximumHeight?: number

`Optional` `Readonly` maximumWidth

maximumWidth?: number

`Optional` `Readonly` minimumHeight

minimumHeight?: number

`Optional` `Readonly` minimumWidth

minimumWidth?: number

`Readonly` params

params: undefined | Parameters

`Readonly` title

title: undefined | string

`Readonly` view

view: IDockviewPanelModel

Methods

dispose

dispose(): void
Returns void
Inherited from IPanel.dispose
- Defined in lifecycle.ts:2

focus

focus(): void
Returns void
Inherited from IPanel.focus
- Defined in panel/types.ts:25

init

init(params): void
Parameters
- params: IGroupPanelInitParameters
Returns void
Overrides IPanel.init
- Defined in dockview/dockviewPanel.ts:30

layout

layout(width, height): void
Parameters
- width: number
- height: number
Returns void
Inherited from IPanel.layout
- Defined in panel/types.ts:22

runEvents

runEvents(): void
Returns void
- Defined in dockview/dockviewPanel.ts:34

setTitle

setTitle(title): void
Parameters
- title: string
Returns void
- Defined in dockview/dockviewPanel.ts:32

toJSON

toJSON(): GroupviewPanelState
Returns GroupviewPanelState
Overrides IPanel.toJSON
- Defined in dockview/dockviewPanel.ts:31

update

update(event): void
Parameters
- event: PanelUpdateEvent<Parameters>
Returns void
Overrides IPanel.update
- Defined in dockview/dockviewPanel.ts:33

updateParentGroup

updateParentGroup(group, options?): void
Parameters
- group: DockviewGroupPanel
- Optional options: {
  skipSetActive?: boolean;
  }
  - Optional skipSetActive?: boolean
Returns void
- Defined in dockview/dockviewPanel.ts:26

Generated using TypeDoc