Interface ITabApi

_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(tabHandle: TabHandle): Promise<void>

  Closes the tab with the given handle.

  Parameters

  • tabHandle: TabHandle

    The handle of the tab to be closed

  Returns Promise<void>

open

• open(tabInfo: TabInfo, uiSpec: UISpec): Promise<TabHandle>

  Opens a new tab in the working area of Studio Pro.

  Parameters

  • tabInfo: TabInfo

    Information about the tab to be opened
  • uiSpec: UISpec

    UI specification of the UI to show inside the tab

  Returns Promise<TabHandle>

  A handle to the tab that can be used to close it

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