new Sidepanel()
- See:
Members
id
isCollapsed
isDisabled
isEnabled
isExpanded
isHidden
isVisible
objectId
Methods
activate(options) → {*}
Parameters:
| Name | Type | Description |
|---|---|---|
options |
Returns:
- Type
- *
alter(status) → {Promise.<any>}
Parameters:
| Name | Type | Description |
|---|---|---|
status |
Returns:
- Type
- Promise.<any>
change(objectIds) → {*}
Parameters:
| Name | Type | Description |
|---|---|---|
objectIds |
Returns:
- Type
- *
closeSidePanel()
Handles closing of side panel depending on its initial state
collapse() → {*}
Returns:
- Type
- *
configure()
create(config, query)
Parameters:
| Name | Type | Description |
|---|---|---|
config |
||
query |
disable() → {*}
Returns:
- Type
- *
enable() → {*}
Returns:
- Type
- *
enableClick()
enableDrag()
expand() → {*}
Returns:
- Type
- *
expanded() → {Promise.<any>}
Returns:
- Type
- Promise.<any>
getDashboards()
Returns the Dashboard(s) in the open Sidepanel. Currently the Sidepanel can only hold one Dashboard at a time.
getObjectIds() → {*}
Returns:
- Type
- *
getOuterWidth($element) → {number}
Parameters:
| Name | Type | Description |
|---|---|---|
$element |
Returns:
- Type
- number
hide() → {*}
Returns:
- Type
- *
init()
layout()
open(objectIds, options) → {*}
Parameters:
| Name | Type | Description |
|---|---|---|
objectIds |
||
options |
Returns:
- Type
- *
openDashboard(dashboardRef, objectId)
Opens a dashboard in the sidepanel
Parameters:
| Name | Type | Description |
|---|---|---|
dashboardRef |
Dashboard to be opened |
|
objectId |
(optional) context object Id for the dashboard content |
openSidePanel(preCloseCallback)
Open side panel with predefined empty content containing header and section elements
Parameters:
| Name | Type | Description |
|---|---|---|
preCloseCallback |
Callback to be fired before closing the side panel |
reload(config, query) → {Promise.<(any|never|never)>}
Parameters:
| Name | Type | Description |
|---|---|---|
config |
||
query |
Returns:
- Type
- Promise.<(any|never|never)>
reopen(objectIds, opts) → {*}
Parameters:
| Name | Type | Description |
|---|---|---|
objectIds |
||
opts |
Returns:
- Type
- *
setLabel(iconClass, label)
Parameters:
| Name | Type | Description |
|---|---|---|
iconClass |
||
label |
setPanelStatus()
setup() → {*}
Returns:
- Type
- *
toggle() → {Promise.<(any|never)>}
Returns:
- Type
- Promise.<(any|never)>
unload() → {Promise.<(any|never)>}
Returns:
- Type
- Promise.<(any|never)>