PanelAPI interface
An interface representing panel related APIs
Methods
| close(Close |
Closes panels |
| open(Open |
Opens a panel that loads the workload app |
Method Details
close(CloseUIConfig)
Closes panels
function close(config?: CloseUIConfig): Promise<CloseUIResult>Parameters
- config
- CloseUIConfig
The configuration for closing panels, including whether to close all panels or just the top panel, etc.
Returns
Promise<CloseUIResult>
A promise which resolves when panels are closed
open(OpenPanelConfig)
Opens a panel that loads the workload app
function open(config: OpenPanelConfig): Promise<OpenUIResult>Parameters
- config
- OpenPanelConfig
The configuration of the panel, including the name of the workload app providing the panel UI, the route to locate the panel UI in the workload app, the panel size, etc.
Returns
Promise<OpenUIResult>
A promise which resolves when the panel is opened