Class DockviewComponent

Hierarchy (view full)

BaseGrid<DockviewGroupPanel>
- DockviewComponent

Implements

IDockviewComponent

Index

Constructors

Properties

_activeGroup _api _bufferOnDidLayoutChange _deserializer _floatingGroups _groups _moving _onDidActiveGroupChange _onDidActivePanelChange _onDidAddGroup _onDidAddPanel _onDidDrop _onDidLayoutFromJSON _onDidMaximizedGroupChange _onDidMovePanel _onDidOpenPopoutWindowFail _onDidOptionsChange _onDidPopoutGroupPositionChange _onDidPopoutGroupSizeChange _onDidRemoveGroup _onDidRemovePanel _onUnhandledDragOverEvent _onWillDragGroup _onWillDragPanel _onWillDrop _onWillShowOverlay _options _popoutGroups _popoutRestorationPromise _rootDropTarget _themeClassnames _watermark gridview nextGroupId onDidActiveChange onDidActiveGroupChange onDidActivePanelChange onDidAdd onDidAddGroup onDidAddPanel onDidDrop onDidLayoutChange onDidLayoutFromJSON onDidMaximizedChange onDidMaximizedGroupChange onDidMovePanel onDidOpenPopoutWindowFail onDidOptionsChange onDidPopoutGroupPositionChange onDidPopoutGroupSizeChange onDidRemove onDidRemoveGroup onDidRemovePanel onDidViewVisibilityChangeMicroTaskQueue onUnhandledDragOverEvent onWillDragGroup onWillDragPanel onWillDrop onWillShowOverlay overlayRenderContainer popupService rootDropTargetContainer

Constructors

constructor

new DockviewComponent(container, options): DockviewComponent
Parameters
- container: HTMLElement
- options: DockviewComponentOptions
Returns DockviewComponent
Overrides BaseGrid.constructor
- Defined in dockview/dockviewComponent.ts:420

Properties

`Protected` _activeGroup

_activeGroup: undefined | DockviewGroupPanel

`Private` `Readonly` _api

_api: DockviewApi

`Protected` `Readonly` _bufferOnDidLayoutChange

_bufferOnDidLayoutChange: AsapEvent = ...

`Private` `Readonly` _deserializer

_deserializer: DefaultDockviewDeserialzier = ...

`Private` `Readonly` _floatingGroups

_floatingGroups: DockviewFloatingGroupPanel[] = []

`Protected` `Readonly` _groups

_groups: Map<string, IValueDisposable<DockviewGroupPanel>> = ...

`Private` _moving

_moving: boolean = false

`Private` `Readonly` _onDidActiveGroupChange

_onDidActiveGroupChange: DockviewEmitter<undefined | DockviewGroupPanel> = ...

`Private` `Readonly` _onDidActivePanelChange

_onDidActivePanelChange: DockviewEmitter<undefined | IDockviewPanel> = ...

`Private` `Readonly` _onDidLayoutFromJSON

_onDidLayoutFromJSON: DockviewEmitter<void> = ...

`Private` `Readonly` _onDidMaximizedGroupChange

_onDidMaximizedGroupChange: DockviewEmitter<DockviewMaximizedGroupChanged> = ...

`Private` `Readonly` _onDidMovePanel

_onDidMovePanel: DockviewEmitter<MovePanelEvent> = ...

`Private` `Readonly` _onDidOpenPopoutWindowFail

_onDidOpenPopoutWindowFail: DockviewEmitter<void> = ...

`Private` `Readonly` _onDidOptionsChange

_onDidOptionsChange: DockviewEmitter<void> = ...

`Private` `Readonly` _onDidPopoutGroupPositionChange

_onDidPopoutGroupPositionChange: DockviewEmitter<PopoutGroupChangePositionEvent> = ...

`Private` `Readonly` _onDidPopoutGroupSizeChange

_onDidPopoutGroupSizeChange: DockviewEmitter<PopoutGroupChangeSizeEvent> = ...

`Private` `Readonly` _onDidRemoveGroup

_onDidRemoveGroup: DockviewEmitter<DockviewGroupPanel> = ...

`Private` `Readonly` _onDidRemovePanel

_onDidRemovePanel: DockviewEmitter<IDockviewPanel> = ...

`Private` `Readonly` _onUnhandledDragOverEvent

_onUnhandledDragOverEvent: DockviewEmitter<DockviewDndOverlayEvent> = ...

`Private` `Readonly` _onWillDragGroup

_onWillDragGroup: DockviewEmitter<GroupDragEvent> = ...

`Private` `Readonly` _onWillDragPanel

_onWillDragPanel: DockviewEmitter<TabDragEvent> = ...

`Private` `Readonly` _onWillDrop

_onWillDrop: DockviewEmitter<DockviewWillDropEvent> = ...

`Private` `Readonly` _onWillShowOverlay

_onWillShowOverlay: DockviewEmitter<WillShowOverlayLocationEvent> = ...

`Private` _options

_options: DockviewComponentOptions

`Private` `Readonly` _popoutGroups

_popoutGroups: {
    disposable: {
        dispose: (() => undefined | DockviewGroupPanel);
    };
    popoutGroup: DockviewGroupPanel;
    referenceGroup?: string;
    window: PopoutWindow;
}[] = []

Type declaration

disposable: {
dispose: (() => undefined | DockviewGroupPanel);
}
- dispose: (() => undefined | DockviewGroupPanel)
  - - (): undefined | DockviewGroupPanel
    - Returns undefined | DockviewGroupPanel
popoutGroup: DockviewGroupPanel
Optional referenceGroup?: string
window: PopoutWindow

`Private` _popoutRestorationPromise

_popoutRestorationPromise: Promise<void> = ...

`Private` `Readonly` _rootDropTarget

_rootDropTarget: Droptarget

`Private` `Readonly` _themeClassnames

_themeClassnames: Classnames

`Private` _watermark

_watermark: null | IWatermarkRenderer = null

`Protected` `Readonly` gridview

gridview: Gridview

`Private` `Readonly` nextGroupId

nextGroupId: {
next: (() => string);
} = ...

Type declaration

next: (() => string)
- - (): string
  - Returns string

`Readonly` onDidActiveChange

onDidActiveChange: DockviewEvent<undefined | DockviewGroupPanel> = ...

`Readonly` onDidActiveGroupChange

onDidActiveGroupChange: DockviewEvent<undefined | DockviewGroupPanel> = ...

`Readonly` onDidActivePanelChange

onDidActivePanelChange: DockviewEvent<undefined | IDockviewPanel> = ...

`Readonly` onDidAdd

onDidAdd: DockviewEvent<DockviewGroupPanel> = ...

`Readonly` onDidAddGroup

onDidAddGroup: DockviewEvent<DockviewGroupPanel> = ...

`Readonly` onDidAddPanel

onDidAddPanel: DockviewEvent<IDockviewPanel> = ...

`Readonly` onDidDrop

onDidDrop: DockviewEvent<DockviewDidDropEvent> = ...

`Readonly` onDidLayoutChange

onDidLayoutChange: DockviewEvent<void> = ...

`Readonly` onDidLayoutFromJSON

onDidLayoutFromJSON: DockviewEvent<void> = ...

`Readonly` onDidMaximizedChange

onDidMaximizedChange: DockviewEvent<MaximizedChanged<DockviewGroupPanel>> = ...

`Readonly` onDidMaximizedGroupChange

onDidMaximizedGroupChange: DockviewEvent<DockviewMaximizedGroupChanged> = ...

`Readonly` onDidMovePanel

onDidMovePanel: DockviewEvent<MovePanelEvent> = ...

`Readonly` onDidOpenPopoutWindowFail

onDidOpenPopoutWindowFail: DockviewEvent<void> = ...

`Readonly` onDidOptionsChange

onDidOptionsChange: DockviewEvent<void> = ...

`Readonly` onDidPopoutGroupPositionChange

onDidPopoutGroupPositionChange: DockviewEvent<PopoutGroupChangePositionEvent> = ...

`Readonly` onDidPopoutGroupSizeChange

onDidPopoutGroupSizeChange: DockviewEvent<PopoutGroupChangeSizeEvent> = ...

`Readonly` onDidRemove

onDidRemove: DockviewEvent<DockviewGroupPanel> = ...

`Readonly` onDidRemoveGroup

onDidRemoveGroup: DockviewEvent<DockviewGroupPanel> = ...

`Readonly` onDidRemovePanel

onDidRemovePanel: DockviewEvent<IDockviewPanel> = ...

`Readonly` onDidViewVisibilityChangeMicroTaskQueue

onDidViewVisibilityChangeMicroTaskQueue: DockviewEvent<void> = ...

`Readonly` onUnhandledDragOverEvent

onUnhandledDragOverEvent: DockviewEvent<DockviewDndOverlayEvent> = ...

`Readonly` onWillDragGroup

onWillDragGroup: DockviewEvent<GroupDragEvent> = ...

`Readonly` onWillDragPanel

onWillDragPanel: DockviewEvent<TabDragEvent> = ...

`Readonly` onWillDrop

onWillDrop: DockviewEvent<DockviewWillDropEvent> = ...

`Readonly` onWillShowOverlay

onWillShowOverlay: DockviewEvent<WillShowOverlayLocationEvent> = ...

`Readonly` overlayRenderContainer

overlayRenderContainer: OverlayRenderContainer

`Readonly` popupService

popupService: PopupService

`Readonly` rootDropTargetContainer

rootDropTargetContainer: DropTargetAnchorContainer

Accessors

activeGroup

get activeGroup(): undefined | T
Returns undefined | T
Implementation of IDockviewComponent.activeGroup
Inherited from BaseGrid.activeGroup
- Defined in gridview/baseComponentGridview.ts:149

activePanel

get activePanel(): undefined | IDockviewPanel
Returns undefined | IDockviewPanel
Implementation of IDockviewComponent.activePanel
- Defined in dockview/dockviewComponent.ts:390

api

get api(): DockviewApi
Returns DockviewApi
- Defined in dockview/dockviewComponent.ts:404

disableResizing

get disableResizing(): boolean
Returns boolean
Inherited from BaseGrid.disableResizing
- Defined in resizable.ts:12
set disableResizing(value): void
Parameters
- value: boolean
Returns void
Inherited from BaseGrid.disableResizing
- Defined in resizable.ts:16

element

get element(): HTMLElement
Returns HTMLElement
Implementation of IDockviewComponent.element
Inherited from BaseGrid.element
- Defined in resizable.ts:8

floatingGroups

get floatingGroups(): DockviewFloatingGroupPanel[]
Returns DockviewFloatingGroupPanel[]
- Defined in dockview/dockviewComponent.ts:408

groups

get groups(): T[]
Returns T[]
Implementation of IDockviewComponent.groups
Inherited from BaseGrid.groups
- Defined in gridview/baseComponentGridview.ts:124

height

get height(): number
Returns number
Implementation of IDockviewComponent.height
Inherited from BaseGrid.height
- Defined in gridview/baseComponentGridview.ts:132

id

get id(): string
Returns string
Implementation of IDockviewComponent.id
Inherited from BaseGrid.id
- Defined in gridview/baseComponentGridview.ts:116

isDisposed

get isDisposed(): boolean
Returns boolean
Inherited from BaseGrid.isDisposed
- Defined in lifecycle.ts:30

locked

get locked(): boolean
Returns boolean
Inherited from BaseGrid.locked
- Defined in gridview/baseComponentGridview.ts:153
set locked(value): void
Parameters
- value: boolean
Returns void
Inherited from BaseGrid.locked
- Defined in gridview/baseComponentGridview.ts:157

maximumHeight

get maximumHeight(): number
Returns number
Implementation of IDockviewComponent.maximumHeight
Inherited from BaseGrid.maximumHeight
- Defined in gridview/baseComponentGridview.ts:139

maximumWidth

get maximumWidth(): number
Returns number
Implementation of IDockviewComponent.maximumWidth
Inherited from BaseGrid.maximumWidth
- Defined in gridview/baseComponentGridview.ts:145

minimumHeight

get minimumHeight(): number
Returns number
Implementation of IDockviewComponent.minimumHeight
Inherited from BaseGrid.minimumHeight
- Defined in gridview/baseComponentGridview.ts:136

minimumWidth

get minimumWidth(): number
Returns number
Implementation of IDockviewComponent.minimumWidth
Inherited from BaseGrid.minimumWidth
- Defined in gridview/baseComponentGridview.ts:142

options

get options(): DockviewComponentOptions
Returns DockviewComponentOptions
Implementation of IDockviewComponent.options
- Defined in dockview/dockviewComponent.ts:386

orientation

get orientation(): Orientation
Returns Orientation
Implementation of IDockviewComponent.orientation
- Defined in dockview/dockviewComponent.ts:374

panels

get panels(): IDockviewPanel[]
Returns IDockviewPanel[]
Implementation of IDockviewComponent.panels
- Defined in dockview/dockviewComponent.ts:382

popoutRestorationPromise

get popoutRestorationPromise(): Promise<void>
Promise that resolves when all popout groups from the last fromJSON call are restored. Useful for tests that need to wait for delayed popout creation.

Returns Promise<void>
- Defined in dockview/dockviewComponent.ts:416

renderer

get renderer(): DockviewPanelRenderer
Returns DockviewPanelRenderer
- Defined in dockview/dockviewComponent.ts:400

size

get size(): number
Returns number
Implementation of IDockviewComponent.size
Inherited from BaseGrid.size
- Defined in gridview/baseComponentGridview.ts:120

totalPanels

get totalPanels(): number
Returns number
Implementation of IDockviewComponent.totalPanels
- Defined in dockview/dockviewComponent.ts:378

width

get width(): number
Returns number
Implementation of IDockviewComponent.width
Inherited from BaseGrid.width
- Defined in gridview/baseComponentGridview.ts:128

Methods

addDisposables

addDisposables(...args): void
Parameters
- Rest ...args: DockviewIDisposable[]
Returns void
Inherited from BaseGrid.addDisposables
- Defined in lifecycle.ts:38

addFloatingGroup

addFloatingGroup(item, options?): void
Parameters
- item: DockviewGroupPanel | DockviewPanel
- Optional options: FloatingGroupOptionsInternal
Returns void
Implementation of IDockviewComponent.addFloatingGroup
- Defined in dockview/dockviewComponent.ts:1016

addGroup

addGroup(options?): DockviewGroupPanel
Parameters
- Optional options: AddGroupOptionsWithGroup & GroupOptions | AddGroupOptionsWithPanel & GroupOptions | AbsolutePosition & GroupOptions
Returns DockviewGroupPanel
Implementation of IDockviewComponent.addGroup
- Defined in dockview/dockviewComponent.ts:1915

addPanel

addPanel<T>(options): DockviewPanel
Type Parameters
- T extends object = Parameters
Parameters
- options: AddPanelOptions<T>
Returns DockviewPanel
Implementation of IDockviewComponent.addPanel
- Defined in dockview/dockviewComponent.ts:1652

addPopoutGroup

addPopoutGroup(itemToPopout, options?): Promise<boolean>
Parameters
- itemToPopout: DockviewGroupPanel | DockviewPanel
- Optional options: DockviewPopoutGroupOptions
Returns Promise<boolean>
Implementation of IDockviewComponent.addPopoutGroup
- Defined in dockview/dockviewComponent.ts:670

clear

clear(): void
Returns void
Implementation of IDockviewComponent.clear
Overrides BaseGrid.clear
- Defined in dockview/dockviewComponent.ts:1627

closeAllGroups

closeAllGroups(): void
Returns void
Implementation of IDockviewComponent.closeAllGroups
- Defined in dockview/dockviewComponent.ts:1644

createGroup

createGroup(options?): DockviewGroupPanel
Parameters
- Optional options: GroupOptions
Returns DockviewGroupPanel
- Defined in dockview/dockviewComponent.ts:2578

`Private` createGroupAtLocation

createGroupAtLocation(location, size?, options?): DockviewGroupPanel
Parameters
- location: number[]
- Optional size: number
- Optional options: GroupOptions
Returns DockviewGroupPanel
- Defined in dockview/dockviewComponent.ts:2720

`Private` createPanel

createPanel(options, group): DockviewPanel
Parameters
- options: AddPanelOptions
- group: DockviewGroupPanel
Returns DockviewPanel
- Defined in dockview/dockviewComponent.ts:2680

createWatermarkComponent

createWatermarkComponent(): IWatermarkRenderer
Returns IWatermarkRenderer
Implementation of IDockviewComponent.createWatermarkComponent
- Defined in dockview/dockviewComponent.ts:1881

dispose

dispose(): void
Returns void
Implementation of IDockviewComponent.dispose
Inherited from BaseGrid.dispose
- Defined in gridview/baseComponentGridview.ts:385

`Protected` doAddGroup

doAddGroup(group, location?, size?): void
Parameters
- group: DockviewGroupPanel
- location: number[] = ...
- Optional size: number
Returns void
Inherited from BaseGrid.doAddGroup
- Defined in gridview/baseComponentGridview.ts:274

`Protected` doRemoveGroup

doRemoveGroup(group, options?): DockviewGroupPanel
Parameters
- group: DockviewGroupPanel
- Optional options: {
      skipActive?: boolean;
      skipDispose?: boolean;
      skipPopoutAssociated?: boolean;
      skipPopoutReturn?: boolean;
  }
  - Optional skipActive?: boolean
  - Optional skipDispose?: boolean
  - Optional skipPopoutAssociated?: boolean
  - Optional skipPopoutReturn?: boolean
Returns DockviewGroupPanel
Overrides BaseGrid.doRemoveGroup
- Defined in dockview/dockviewComponent.ts:2012

doSetGroupActive

doSetGroupActive(group): void
Parameters
- group: undefined | DockviewGroupPanel
Returns void
Implementation of IDockviewComponent.doSetGroupActive
Overrides BaseGrid.doSetGroupActive
- Defined in dockview/dockviewComponent.ts:2535

doSetGroupAndPanelActive

doSetGroupAndPanelActive(group): void
Parameters
- group: undefined | DockviewGroupPanel
Returns void
- Defined in dockview/dockviewComponent.ts:2548

exitMaximizedGroup

exitMaximizedGroup(): void
Returns void
Implementation of IDockviewComponent.exitMaximizedGroup
Inherited from BaseGrid.exitMaximizedGroup
- Defined in gridview/baseComponentGridview.ts:266

`Private` findGroup

findGroup(panel): undefined | DockviewGroupPanel
Parameters
- panel: IDockviewPanel
Returns undefined | DockviewGroupPanel
- Defined in dockview/dockviewComponent.ts:2730

focus

focus(): void
Returns void
Implementation of IDockviewComponent.focus
- Defined in dockview/dockviewComponent.ts:1326

fromJSON

fromJSON(data): void
Parameters
- data: SerializedDockview
Returns void
Implementation of IDockviewComponent.fromJSON
Overrides BaseGrid.fromJSON
- Defined in dockview/dockviewComponent.ts:1437

getGroupPanel

getGroupPanel(id): undefined | IDockviewPanel
Parameters
- id: string
Returns undefined | IDockviewPanel
Implementation of IDockviewComponent.getGroupPanel
- Defined in dockview/dockviewComponent.ts:1330

`Private` getLocationOrientation

getLocationOrientation(location): Orientation
Parameters
- location: number[]
Returns Orientation
- Defined in dockview/dockviewComponent.ts:1991

`Private` getNextGroupId

getNextGroupId(): string
Returns string
- Defined in dockview/dockviewComponent.ts:2569

getPanel

getPanel(id): undefined | DockviewGroupPanel
Parameters
- id: string
Returns undefined | DockviewGroupPanel
Implementation of IDockviewComponent.getPanel
Inherited from BaseGrid.getPanel
- Defined in gridview/baseComponentGridview.ts:314

hasMaximizedGroup

hasMaximizedGroup(): boolean
Returns boolean
Implementation of IDockviewComponent.hasMaximizedGroup
Inherited from BaseGrid.hasMaximizedGroup
- Defined in gridview/baseComponentGridview.ts:270

isMaximizedGroup

isMaximizedGroup(panel): boolean
Parameters
- panel: DockviewGroupPanel
Returns boolean
Implementation of IDockviewComponent.isMaximizedGroup
Inherited from BaseGrid.isMaximizedGroup
- Defined in gridview/baseComponentGridview.ts:262

isVisible

isVisible(panel): boolean
Parameters
- panel: DockviewGroupPanel
Returns boolean
Implementation of IDockviewComponent.isVisible
Inherited from BaseGrid.isVisible
- Defined in gridview/baseComponentGridview.ts:229

layout

layout(width, height, forceResize?): void
Parameters
- width: number
- height: number
- Optional forceResize: boolean
Returns void
Implementation of IDockviewComponent.layout
Overrides BaseGrid.layout
- Defined in dockview/dockviewComponent.ts:1304

maximizeGroup

maximizeGroup(panel): void
Parameters
- panel: DockviewGroupPanel
Returns void
Implementation of IDockviewComponent.maximizeGroup
Inherited from BaseGrid.maximizeGroup
- Defined in gridview/baseComponentGridview.ts:257

moveGroup

moveGroup(options): void
Parameters
- options: MoveGroupOptions
Returns void
Implementation of IDockviewComponent.moveGroup
- Defined in dockview/dockviewComponent.ts:2351

moveGroupOrPanel

moveGroupOrPanel(options): void
Parameters
- options: MoveGroupOrPanelOptions
Returns void
Implementation of IDockviewComponent.moveGroupOrPanel
- Defined in dockview/dockviewComponent.ts:2135

moveToNext

moveToNext(options?): void
Parameters
- options: MovementOptions = {}
Returns void
Implementation of IDockviewComponent.moveToNext
Overrides BaseGrid.moveToNext
- Defined in dockview/dockviewComponent.ts:1339

moveToPrevious

moveToPrevious(options?): void
Parameters
- options: MovementOptions = {}
Returns void
Implementation of IDockviewComponent.moveToPrevious
Overrides BaseGrid.moveToPrevious
- Defined in dockview/dockviewComponent.ts:1362

movingLock

movingLock<T>(func): T
Type Parameters
- T
Parameters
- func: (() => T)
  - - (): T
    - Returns T
Returns T
- Defined in dockview/dockviewComponent.ts:2124

`Private` orientationAtLocation

orientationAtLocation(location): Orientation
Parameters
- location: number[]
Returns Orientation
- Defined in dockview/dockviewComponent.ts:2736

`Private` orthogonalize

orthogonalize(position, options?): DockviewGroupPanel
Parameters
- position: Position
- Optional options: GroupOptions
Returns DockviewGroupPanel
- Defined in dockview/dockviewComponent.ts:1216

removeGroup

removeGroup(group, options?): void
Parameters
- group: DockviewGroupPanel
- Optional options: {
      skipActive?: boolean;
      skipDispose?: boolean;
      skipPopoutAssociated?: boolean;
      skipPopoutReturn?: boolean;
  }
  - Optional skipActive?: boolean
  - Optional skipDispose?: boolean
  - Optional skipPopoutAssociated?: boolean
  - Optional skipPopoutReturn?: boolean
Returns void
Implementation of IDockviewComponent.removeGroup
Overrides BaseGrid.removeGroup
- Defined in dockview/dockviewComponent.ts:1998

removePanel

removePanel(panel, options?): void
Parameters
- panel: IDockviewPanel
- options: {
      removeEmptyGroup: boolean;
      skipDispose?: boolean;
      skipSetActiveGroup?: boolean;
  } = ...
  - removeEmptyGroup: boolean
  - Optional skipDispose?: boolean
  - Optional skipSetActiveGroup?: boolean
Returns void
Implementation of IDockviewComponent.removePanel
- Defined in dockview/dockviewComponent.ts:1849

setActivePanel

setActivePanel(panel): void
Parameters
- panel: IDockviewPanel
Returns void
Implementation of IDockviewComponent.setActivePanel
- Defined in dockview/dockviewComponent.ts:1334

setVisible

setVisible(panel, visible): void
Parameters
- panel: DockviewGroupPanel
- visible: boolean
Returns void
Implementation of IDockviewComponent.setVisible
Overrides BaseGrid.setVisible
- Defined in dockview/dockviewComponent.ts:644

toJSON

toJSON(): SerializedDockview
Serialize the current state of the layout

Returns SerializedDockview
A JSON respresentation of the layout
Implementation of IDockviewComponent.toJSON
Overrides BaseGrid.toJSON
- Defined in dockview/dockviewComponent.ts:1389

`Private` updateDragAndDropState

updateDragAndDropState(): void
Returns void
- Defined in dockview/dockviewComponent.ts:1319

`Private` updateDropTargetModel

updateDropTargetModel(options): void
Parameters
- options: Partial<DockviewComponentOptions>
Returns void
- Defined in dockview/dockviewComponent.ts:2743

updateOptions

updateOptions(options): void
Parameters
- options: Partial<DockviewComponentOptions>
Returns void
Implementation of IDockviewComponent.updateOptions
Overrides BaseGrid.updateOptions
- Defined in dockview/dockviewComponent.ts:1260

`Private` updateTheme

updateTheme(): void
Returns void
- Defined in dockview/dockviewComponent.ts:2766

`Private` updateWatermark

updateWatermark(): void
Returns void
- Defined in dockview/dockviewComponent.ts:1888

Class DockviewComponent

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

container: HTMLElement

options: DockviewComponentOptions

Returns DockviewComponent

Properties

Protected _activeGroup

Private Readonly _api

Protected Readonly _bufferOnDidLayoutChange

Private Readonly _deserializer

Private Readonly _floatingGroups

Protected Readonly _groups

Private _moving

Private Readonly _onDidActiveGroupChange

Private Readonly _onDidActivePanelChange

Protected Readonly _onDidAddGroup

Private Readonly _onDidAddPanel

Private Readonly _onDidDrop

Private Readonly _onDidLayoutFromJSON

Private Readonly _onDidMaximizedGroupChange

Private Readonly _onDidMovePanel

Private Readonly _onDidOpenPopoutWindowFail

Private Readonly _onDidOptionsChange

Private Readonly _onDidPopoutGroupPositionChange

Private Readonly _onDidPopoutGroupSizeChange

Private Readonly _onDidRemoveGroup

Private Readonly _onDidRemovePanel

Private Readonly _onUnhandledDragOverEvent

Private Readonly _onWillDragGroup

Private Readonly _onWillDragPanel

Private Readonly _onWillDrop

Private Readonly _onWillShowOverlay

Private _options

Private Readonly _popoutGroups

Type declaration

disposable: { dispose: (() => undefined | DockviewGroupPanel); }

dispose: (() => undefined | DockviewGroupPanel)

Returns undefined | DockviewGroupPanel

popoutGroup: DockviewGroupPanel

Optional referenceGroup?: string

window: PopoutWindow

Private _popoutRestorationPromise

Private Readonly _rootDropTarget

Private Readonly _themeClassnames

Private _watermark

Protected Readonly gridview

Private Readonly nextGroupId

Type declaration

next: (() => string)

Returns string

Readonly onDidActiveChange

Readonly onDidActiveGroupChange

Readonly onDidActivePanelChange

Readonly onDidAdd

Readonly onDidAddGroup

Readonly onDidAddPanel

Readonly onDidDrop

Readonly onDidLayoutChange

Readonly onDidLayoutFromJSON

Readonly onDidMaximizedChange

Readonly onDidMaximizedGroupChange

Readonly onDidMovePanel

Readonly onDidOpenPopoutWindowFail

Readonly onDidOptionsChange

Readonly onDidPopoutGroupPositionChange

Readonly onDidPopoutGroupSizeChange

Readonly onDidRemove

Readonly onDidRemoveGroup

Readonly onDidRemovePanel

Readonly onDidViewVisibilityChangeMicroTaskQueue

Readonly onUnhandledDragOverEvent

`Protected` _activeGroup

`Private` `Readonly` _api

`Protected` `Readonly` _bufferOnDidLayoutChange

`Private` `Readonly` _deserializer

`Private` `Readonly` _floatingGroups

`Protected` `Readonly` _groups

`Private` _moving

`Private` `Readonly` _onDidActiveGroupChange

`Private` `Readonly` _onDidActivePanelChange

`Protected` `Readonly` _onDidAddGroup

`Private` `Readonly` _onDidAddPanel

`Private` `Readonly` _onDidDrop

`Private` `Readonly` _onDidLayoutFromJSON

`Private` `Readonly` _onDidMaximizedGroupChange

`Private` `Readonly` _onDidMovePanel

`Private` `Readonly` _onDidOpenPopoutWindowFail

`Private` `Readonly` _onDidOptionsChange

`Private` `Readonly` _onDidPopoutGroupPositionChange

`Private` `Readonly` _onDidPopoutGroupSizeChange

`Private` `Readonly` _onDidRemoveGroup

`Private` `Readonly` _onDidRemovePanel

`Private` `Readonly` _onUnhandledDragOverEvent

`Private` `Readonly` _onWillDragGroup

`Private` `Readonly` _onWillDragPanel

`Private` `Readonly` _onWillDrop

`Private` `Readonly` _onWillShowOverlay

`Private` _options

`Private` `Readonly` _popoutGroups

disposable: {
dispose: (() => undefined | DockviewGroupPanel);
}

`Optional` referenceGroup?: string

`Private` _popoutRestorationPromise

`Private` `Readonly` _rootDropTarget

`Private` `Readonly` _themeClassnames

`Private` _watermark

`Protected` `Readonly` gridview

`Private` `Readonly` nextGroupId

`Readonly` onDidActiveChange

`Readonly` onDidActiveGroupChange

`Readonly` onDidActivePanelChange

`Readonly` onDidAdd

`Readonly` onDidAddGroup

`Readonly` onDidAddPanel

`Readonly` onDidDrop

`Readonly` onDidLayoutChange

`Readonly` onDidLayoutFromJSON

`Readonly` onDidMaximizedChange

`Readonly` onDidMaximizedGroupChange

`Readonly` onDidMovePanel

`Readonly` onDidOpenPopoutWindowFail

`Readonly` onDidOptionsChange

`Readonly` onDidPopoutGroupPositionChange

`Readonly` onDidPopoutGroupSizeChange

`Readonly` onDidRemove

`Readonly` onDidRemoveGroup

`Readonly` onDidRemovePanel

`Readonly` onDidViewVisibilityChangeMicroTaskQueue

`Readonly` onUnhandledDragOverEvent

`Readonly` onWillDragGroup

`Readonly` onWillDragPanel

`Readonly` onWillDrop

`Readonly` onWillShowOverlay

`Readonly` overlayRenderContainer

`Readonly` popupService

`Readonly` rootDropTargetContainer

`Rest` ...args: DockviewIDisposable[]

`Optional` options: FloatingGroupOptionsInternal