Panel

Description

A container representing a panel on the edges of the editor window. You should not create a Panel directly, instead use Workspace::addTopPanel and friends to add panels.

Examples: status-bar and find-and-replace both use panels.

API documentation

Construction and Destruction

::destroy()

Destroy and remove this panel from the UI.

Event Subscription

::onDidChangeVisible(callback)

Invoke the given callback when the pane hidden or shown.

Argument Description
callback

Function to be called when the pane is destroyed.
visible

Boolean true when the panel has been shown
Return values

  • Returns a Disposable on which .dispose() can be called to unsubscribe.

::onDidDestroy(callback)

Invoke the given callback when the pane is destroyed.

Argument Description
callback

Function to be called when the pane is destroyed.
panel

Panel this panel
Return values

  • Returns a Disposable on which .dispose() can be called to unsubscribe.

Panel Details

::getItem()

Return values

  • Returns the panel's item.

::getPriority()

Return values

  • Returns a Number indicating this panel's priority.

::isVisible()

Return values

  • Returns a Boolean true when the panel is visible.

::hide()

Hide this panel

::show()

Show this panel