Interface IDockablePaneApi

_apiId

addEventListener

• addEventListener<K extends never>(
      eventType: K,
      listener: EventHandler<{}, K>,
  ): DisposeListener

  Adds an event listener for the specified event type.

  Type Parameters

  • K extends never

  Parameters

  • eventType: K

    The type of event to listen for.
  • listener: EventHandler<{}, K>

    The event listener to add.

  Returns DisposeListener

  A function that can be called to remove the event listener.

close

• close(handle: DockablePaneHandle): Promise<void>

  Closes a dockable pane by passing a pane handle received from the register method.

  Parameters

  • handle: DockablePaneHandle

    a handle to the pane that was registered.

  Returns Promise<void>

open

• open(handle: DockablePaneHandle): Promise<void>

  Opens a dockable pane by passing a pane handle received from the register method.

  Parameters

  • handle: DockablePaneHandle

    a handle to the pane that was registered.

  Returns Promise<void>

register

• register(
      paneInfo: DockablePaneInfo,
      uiSpec: UISpec,
  ): Promise<DockablePaneHandle>

  Registers a new dockable pane with Studio Pro.

  Parameters

  • paneInfo: DockablePaneInfo

    information like title and initial position required by Studio Pro to register the pane
  • uiSpec: UISpec

    UI specification of the UI to show inside the pane

  Returns Promise<DockablePaneHandle>

  a pane handle which can be used to interact with the pane via IDockablePaneApi.open and IDockablePaneApi.close methods

removeEventListener

• removeEventListener<K extends never>(
      eventType: K,
      listener: EventHandler<{}, K>,
  ): void

  Removes an event listener for the specified event type.

  Type Parameters

  • K extends never

  Parameters

  • eventType: K

    The type of event to remove the listener from.
  • listener: EventHandler<{}, K>

    The event listener to remove.

  Returns void