Interface: PanelApi
PanelApi.PanelApi
Description
Contains APIs to allow panel expand and collapse
Properties
Properties
collapsePanels
- collapsePanels: (...
panels
: string
[]) => void
Type declaration
Parameters
Name |
Type |
Description |
...panels
|
string [] |
The name(s) of the panels to collapse |
Returns
void
Description
Allows the developer to collapse the panels specified
createComponentPanel
- createComponentPanel: (
panelName
: string
, panelTitle
: string
, panelIcon
: string
, component
: HTMLElement
, initialPosition?
: boolean
) => Promise
<string
>
Type declaration
- (
panelName
, panelTitle
, panelIcon
, component
, initialPosition?
): Promise
<string
>
Parameters
Name |
Type |
Description |
panelName
|
string
|
The name of the panel to create |
panelTitle
|
string
|
The title of the panel to create |
panelIcon
|
string
|
The icon of the panel to create |
component
|
HTMLElement
|
The HTMLElement of the content to display in the panel |
initialPosition?
|
boolean
|
- |
Returns
Promise
<string
>
A promise that resolves to the id of the panel when it has been created
Description
Allows the developer to create a new panel with a component as the content
createExternalPanel
- createExternalPanel: (
panelName
: string
, panelTitle
: string
, panelIcon
: string
, initialPanelURL
: string
, initialPosition?
: boolean
) => Promise
<string
>
Type declaration
- (
panelName
, panelTitle
, panelIcon
, initialPanelURL
, initialPosition?
): Promise
<string
>
Parameters
Name |
Type |
Description |
panelName
|
string
|
The name of the panel to create |
panelTitle
|
string
|
The title of the panel to create |
panelIcon
|
string
|
The icon of the panel to create |
initialPanelURL
|
string
|
The URL of the content to display in the panel |
initialPosition?
|
boolean
|
- |
Returns
Promise
<string
>
A promise that resolves to the id of the panel when it has been created
Description
Allows the developer to create a new panel where an iframe will display the content
expandPanels
- expandPanels: (...
panels
: string
[]) => void
Type declaration
Parameters
Name |
Type |
Description |
...panels
|
string [] |
The name(s) of the panels to expand |
Returns
void
Description
Allows the developer to expand the panels specified
hidePanels
- hidePanels: (...
panels
: string
[]) => void
Type declaration
Parameters
Name |
Type |
Description |
...panels
|
string [] |
The name(s) of the panels to hide |
Returns
void
Description
Allows the developer to hide the panels specified
showPanels
- showPanels: (...
panels
: string
[]) => void
Type declaration
Parameters
Name |
Type |
Description |
...panels
|
string [] |
The name(s) of the panels to show |
Returns
void
Description
Allows the developer to show the panels specified
updateExternalPanel
- updateExternalPanel: (
panelID
: string
, newPanelURL
: string
) => void
Type declaration
- (
panelID
, newPanelURL
): void
Parameters
Name |
Type |
Description |
panelID
|
string
|
The ID of the panel to update |
newPanelURL
|
string
|
The new URL of the panel |
Returns
void
Description
Allows the developer to change the URL of an external panel