Interface IEditorApi

_apiId

addEventListener

• addEventListener<K extends "activeDocumentChanged">(
      eventType: K,
      listener: EventHandler<EditorApiEventMap, K>,
  ): DisposeListener

  Adds an event listener for the specified event type.

  Type Parameters

  • K extends "activeDocumentChanged"

  Parameters

  • eventType: K

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

    The event listener to add.

  Returns DisposeListener

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

editDocument

• editDocument(documentId: string): Promise<void>

  Opens the editor for the document with the given ID in the working area of Studio Pro.

  Parameters

  • documentId: string

    the ID of the document that should be edited.

  Returns Promise<void>

getActiveDocument

• getActiveDocument(): Promise<null | ActiveDocumentInfo>

  Gets information about the document the user is currently editing, or null if no document is currently opened.

  Returns Promise<null | ActiveDocumentInfo>

removeEventListener

• removeEventListener<K extends "activeDocumentChanged">(
      eventType: K,
      listener: EventHandler<EditorApiEventMap, K>,
  ): void

  Removes an event listener for the specified event type.

  Type Parameters

  • K extends "activeDocumentChanged"

  Parameters

  • eventType: K

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

    The event listener to remove.

  Returns void