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