Class DockviewPanel

constructor

• new DockviewPanel(
      id: string,
      component: string,
      tabComponent: string | undefined,
      accessor: DockviewComponent,
      containerApi: DockviewApi,
      group: DockviewGroupPanel,
      view: IDockviewPanelModel,
      options: { renderer?: DockviewPanelRenderer } & Partial<Constraints>,
  ): DockviewPanel

  Parameters

  • id: string
  • component: string
  • tabComponent: string | undefined
  • accessor: DockviewComponent
  • containerApi: DockviewApi
  • group: DockviewGroupPanel
  • view: IDockviewPanelModel
  • options: { renderer?: DockviewPanelRenderer } & Partial<Constraints>

  Returns DockviewPanel

Readonlyapi

Readonlyid

Readonlyview

group

• get group(): DockviewGroupPanel

  Returns DockviewGroupPanel

isPinned

• get isPinned(): boolean

  Returns boolean

maximumHeight

• get maximumHeight(): number | undefined

  Returns number | undefined

maximumWidth

• get maximumWidth(): number | undefined

  Returns number | undefined

minimumHeight

• get minimumHeight(): number | undefined

  Returns number | undefined

minimumWidth

• get minimumWidth(): number | undefined

  Returns number | undefined

params

• get params(): Parameters | undefined

  Returns Parameters | undefined

renderer

• get renderer(): DockviewPanelRenderer

  Returns DockviewPanelRenderer

title

• get title(): string | undefined

  Returns string | undefined

dispose

• dispose(): void

  Returns void

focus

• focus(): void

  Returns void

init

• init(params: IGroupPanelInitParameters): void

  Parameters

  • params: IGroupPanelInitParameters

  Returns void

layout

• layout(width: number, height: number): void

  Parameters

  • width: number
  • height: number

  Returns void

runEvents

• runEvents(): void

  Returns void

setPinned

• setPinned(pinned: boolean): void

  Low-level pinned-state mutation. Sets the flag and fires the panel-api event. The public, module-gated entry point is panel.api.setPinned → DockviewComponent.setPanelPinned, which decides whether pinning is active before reaching here; this method itself does not gate, so the ordering module and serialization can drive it directly.

  Parameters

  • pinned: boolean

  Returns void

setRenderer

• setRenderer(renderer: DockviewPanelRenderer): void

  Parameters

  • renderer: DockviewPanelRenderer

  Returns void

setTitle

• setTitle(title: string): void

  Parameters

  • title: string

  Returns void

toJSON

• toJSON(): GroupviewPanelState

  Returns GroupviewPanelState

update

• update(event: PanelUpdateEvent): void

  Parameters

  • event: PanelUpdateEvent

  Returns void

updateFromStateModel

• updateFromStateModel(state: GroupviewPanelState): void

  Parameters

  • state: GroupviewPanelState

  Returns void

updateParentGroup

• updateParentGroup(
      group: DockviewGroupPanel,
      options?: { skipSetActive?: boolean },
  ): void

  Parameters

  • group: DockviewGroupPanel
  • Optionaloptions: { skipSetActive?: boolean }

  Returns void