Class: cPanel

cPanel(client)

Class containing code for managing the Canopy Panel UX

Constructor

new cPanel(client)

Instantiates a new Canopy Panel Management object
Parameters:
Name Type Description
client channel Parent client Management Object
Source:

Members

activePanel

Active Panel Object
Source:

activePanelCloseIcon

Active Panel Close Icon
Source:

activePanelDiv

Active Panel Container
Source:

activePanelDoc

Active Title Document Div
Source:

activePanelDragger

Click-Dragger object for re-sizable active panel
Source:

activePanelPinIcon

Active Panel Pin Icon
Source:

activePanelPopoutIcon

Active Panel Pop-Out Icon
Source:

activePanelTitle

Active Panel Title
Source:

client

Parent Client Management object
Source:

pinnedPanel

Pinned Panel Object
Source:

pinnedPanelCloseIcon

Pinned Panel Close Icon
Source:

pinnedPanelDiv

Pinned Panel Contianer
Source:

pinnedPanelDoc

Pinned Panel Document Div
Source:

pinnedPanelDragger

Click-Dragger object for re-sizable pinned panel
Source:

pinnedPanelPopoutIcon

Pinned Panel Pop-Out Icon
Source:

pinnedPanelTitle

Pinned Panel Title
Source:

pinnedPanelUnpinIcon

Pinned Panel Un-Pin Icon
Source:

poppedPanels

Popped Panel Objects
Source:

Methods

hideActivePanel(event, keepAlive)

Hides active panel
Parameters:
Name Type Default Description
event Event Event passed down from Input Handler
keepAlive Boolean false Prevents closing panel if true
Source:

hidePinnedPanel(event, keepAlive)

Hides pinned panel
Parameters:
Name Type Default Description
event Event Passed down input event
keepAlive Boolean false Prevents panel.closer() from running if true
Source:

pinPanel()

Pins active panel
Source:

popActivePanel()

Pop's out active panel
Source:

popPanel(panel, panelBody)

Pops a new pop-out panel
Parameters:
Name Type Description
panel panelObj panelObj to apply to the panel
panelBody String Raw HTML to inject into panel body, injects panel default if left to null
Source:

popPinnedPanel()

Pops pinned panel
Source:

(async) setActivePanel(panel, panelBody)

Sets Active Panel
Parameters:
Name Type Description
panel panelObj Panel Object to set as active
panelBody String innerHTML of Panel, pulls from panelObj.getPage() if empty
Source:

(async) setPinnedPanel(panel, panelBody)

Sets pinned panel
Parameters:
Name Type Description
panel panelObj Panel Object to apply to panel
panelBody String Raw HTML to inject into panel body, defaults to panel page if null
Source:

setupInput()

Defines input-related event listeners
Source:

unpinPanel()

Sets pinned panel to active
Source: