Class DockviewApi

Active group object.

Active panel object.

All group objects.

Height of the component.

The unique identifier for this instance. Used to manage scope of Drag'n'Drop events.

Maximum height of the component.

Maximum width of the component.

Minimum height of the component.

Minimum width of the component.

Invoked when the active group changes. May be undefined if no group is active.

Invoked when the active panel changes. May be undefined if no panel is active.

Invoked when a group is added. May be called multiple times when moving groups.

Invoked when a panel is added. May be called multiple times when moving panels.

Invoked when a Drag'n'Drop event occurs that the component was unable to handle. Exposed for custom Drag'n'Drop functionality.

Invoked when any layout change occures, an aggregation of many events.

Invoked after a layout is deserialzied using the fromJSON method.

Invoked when a group is removed. May be called multiple times when moving groups.

Invoked when a panel is removed. May be called multiple times when moving panels.

Invoked before a group is dragged.

Calling event.nativeEvent.preventDefault() will prevent the group drag starting.

Invoked before a panel is dragged.

Calling event.nativeEvent.preventDefault() will prevent the panel drag starting.

Invoked when a Drag'n'Drop event occurs but before dockview handles it giving the user an opportunity to intecept and prevent the event from occuring using the standard preventDefault() syntax.

Preventing certain events may causes unexpected behaviours, use carefully.

Invoked before an overlay is shown indicating a drop target.

Calling event.preventDefault() will prevent the overlay being shown and prevent the any subsequent drop event.

All panel objects.

Total number of groups.

Total number of panels.

Width of the component.

Add a floating group

Add a group and return the created object.

Add a panel and return the created object.

Add a popout group in a new Window

Reset the component back to an empty and default state.

Close all groups and panels.

Release resources and teardown component. Do not call when using framework versions of dockview.

Focus the component. Will try to focus an active panel if one exists.

Create a component from a serialized object.

Get a group object given a string id. May return undefined.

Get a panel object given a string id. May return undefined.

Force resize the component to an exact width and height. Read about auto-resizing before using.

Move the focus progmatically to the next panel or group.

Move the focus progmatically to the previous panel or group.

Remove a group and any panels within the group.

Remove a panel given the panel object.

Create a serialized object of the current component.