Class DockviewPanel

constructor

• new DockviewPanel(id, component, tabComponent, accessor, containerApi, group, view, options): DockviewPanel

• Parameters

  • id: string

  • component: string

  • tabComponent: undefined | string

  • accessor: DockviewComponent

  • containerApi: DockviewApi

  • group: DockviewGroupPanel

  • view: IDockviewPanelModel

  • options: {
        renderer?: "onlyWhenVisible" | "always";
    } & Partial<Contraints>

  Returns DockviewPanel

Readonly api

Readonly id

Readonly view

group

• get group(): DockviewGroupPanel

• Returns DockviewGroupPanel

maximumHeight

• get maximumHeight(): undefined | number

• Returns undefined | number

maximumWidth

• get maximumWidth(): undefined | number

• Returns undefined | number

minimumHeight

• get minimumHeight(): undefined | number

• Returns undefined | number

minimumWidth

• get minimumWidth(): undefined | number

• Returns undefined | number

params

• get params(): undefined | Parameters

• Returns undefined | Parameters

renderer

• get renderer(): DockviewPanelRenderer

• Returns DockviewPanelRenderer

title

• get title(): undefined | string

• Returns undefined | string

dispose

• dispose(): void

• Returns void

focus

• focus(): void

• Returns void

init

• init(params): void

• Parameters

  • params: IGroupPanelInitParameters

  Returns void

layout

• layout(width, height): void

• Parameters

  • width: number

  • height: number

  Returns void

runEvents

• runEvents(): void

• Returns void

setRenderer

• setRenderer(renderer): void

• Parameters

  • renderer: DockviewPanelRenderer

  Returns void

setTitle

• setTitle(title): void

• Parameters

  • title: string

  Returns void

toJSON

• toJSON(): GroupviewPanelState

• Returns GroupviewPanelState

update

• update(event): void

• Parameters

  • event: PanelUpdateEvent<Parameters>

  Returns void

updateParentGroup

• updateParentGroup(group, options?): void

• Parameters

  • group: DockviewGroupPanel

  • Optional options: {
        skipSetActive?: boolean;
    }

    • Optional skipSetActive?: boolean

  Returns void