@mendix/extensions-api - v0.11.2
    Preparing search index...

    Interface IEditorApi

    API for retrieving information about, and opening documents in, the main working area of Studio Pro.

    interface IEditorApi {
        _apiId: "mendix.EditorApi";
        addEventListener<K extends keyof EditorApiEventMap>(
            eventType: K,
            listener: EventHandler<EditorApiEventMap, K>,
        ): DisposeListener;
        editDocument(document: TargetDocument): Promise<void>;
        editDocument(
            document: TargetDocument,
            element: TargetElement,
        ): Promise<void>;
        getActiveDocument(): Promise<DocumentInfo | null>;
        getOpenEditors(): Promise<DocumentInfo[]>;
        registerEditorForCustomDocument(
            options: CustomEditorOptions,
        ): Promise<void>;
        removeEventListener<K extends keyof EditorApiEventMap>(
            eventType: K,
            listener: EventHandler<EditorApiEventMap, K>,
        ): void;
    }

    Hierarchy (View Summary)

    Index

    Properties

    _apiId

    Methods

    addEventListener editDocument getActiveDocument getOpenEditors registerEditorForCustomDocument removeEventListener

    Properties

    _apiId

    _apiId: "mendix.EditorApi"

    Unique identifier that can be used to register or retrieve a specific API.

    Example: mendix.EditorsAPI, mycompany.MyFunkyAPI

    Methods

    • Adds an event listener for the specified event type.

      Type Parameters

      • K extends keyof EditorApiEventMap

      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.

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

      Parameters

      • document: TargetDocument

      Returns Promise<void>

    • Opens the editor for the document with the given ID in the working area of Studio Pro and focuses the specified element within that document.

      Parameters

      • document: TargetDocument

        the ID or SdkType+QualifiedName of the document that should be edited.

      • element: TargetElement

        the ID or identifier of the element within the document that should get the focus.

      Returns Promise<void>

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

      Returns Promise<DocumentInfo | null>

    • Registers an editor that will be opened when user interacts with a custom blob document of the specified type.

      Parameters

      Returns Promise<void>

      Will throw if the documentType is already registered by another editor.

    • Removes an event listener for the specified event type.

      Type Parameters

      • K extends keyof EditorApiEventMap

      Parameters

      • eventType: K

        The type of event to remove the listener from.

      • listener: EventHandler<EditorApiEventMap, K>

        The event listener to remove.

      Returns void

    Settings

    On This Page

    Properties
    Methods