Interface IDockviewPanel

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

Hierarchy (View Summary)

DockviewIDisposable
IPanel
- IDockviewPanel

Implemented by

DockviewPanel

Index

Properties

`Readonly`api

api: DockviewPanelApi

`Readonly`group

group: DockviewGroupPanel

`Readonly`id

id: string

`Readonly`isPinned

isPinned: boolean

`Optional` `Readonly`maximumHeight

maximumHeight?: number

`Optional` `Readonly`maximumWidth

maximumWidth?: number

`Optional` `Readonly`minimumHeight

minimumHeight?: number

`Optional` `Readonly`minimumWidth

minimumWidth?: number

`Readonly`params

params: Parameters | undefined

`Readonly`title

title: string | undefined

`Readonly`view

view: IDockviewPanelModel

Methods

dispose

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

focus

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

init

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

layout

layout(width: number, height: number): 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:37

setPinned

setPinned(pinned: boolean): void
Parameters
- pinned: boolean
Returns void
- Defined in dockview/dockviewPanel.ts:27

setTitle

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

toJSON

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

update

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

updateFromStateModel

updateFromStateModel(state: GroupviewPanelState): void
Parameters
- state: GroupviewPanelState
Returns void
- Defined in dockview/dockviewPanel.ts:32

updateParentGroup

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