Interface IDockablePaneApi

API for working with dockable panes in Studio Pro.

interface IDockablePaneApi {
    _apiId: "mendix.DockablePaneApi";
    addEventListener<K>(eventType: K, listener: EventHandler<{}, K>): DisposeListener;
    close(handle: DockablePaneHandle): Promise<void>;
    open(handle: DockablePaneHandle): Promise<void>;
    register(paneInfo: DockablePaneInfo, uiSpec: UISpec): Promise<DockablePaneHandle>;
    removeEventListener<K>(eventType: K, listener: EventHandler<{}, K>): void;
}

Hierarchy (view full)

IComponentApi
- IDockablePaneApi

Index

Properties

Methods

addEventListener close open register removeEventListener

Properties

_apiId

_apiId

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

Example: mendix.EditorsAPI, mycompany.MyFunkyAPI

Methods

addEventListener

addEventListener<K>(eventType, listener): 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.

Inherited from IComponentApi.addEventListener

close

close(handle): 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): 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, 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>(eventType, listener): 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
Inherited from IComponentApi.removeEventListener