WebPanels
Provides access to Confluence web panels provided by other apps. The placeholder can be used to add all web panels for a given location, or specific ones identified by their plugin module keys.
By default all web panels from the k15t.scroll-viewport.viewcontent
location are added. This can be changed by calling forLocation
.
This placeholder can be used multiple times to include web panels from different locations or multiple individual web panels.
Methods
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
$webPanels.forLocation(location) |
WebPanels |
Returns or renders a web panels placeholder for the specified location with the default web panel context. Returns: A web panels placeholder for all web panels from the specified location.
|
|||||||||
$webPanels.render() |
String |
Renders this web panels placeholder with the default web panel context. Returns: The HTML of all web panels represented by this placeholder. |
|||||||||
$webPanels.render(customContext) |
String |
Renders this web panels placeholder with the specified web panel context. Returns: The HTML of all web panels represented by this placeholder.
|
|||||||||
$webPanels.renderPanel(completeKey) |
String |
Renders a single web panel with the default web panel context. The location of the specified web panel is ignored. The referenced web panel module must be enabled. Returns: The HTML of the specified web panel.
|
|||||||||
$webPanels.renderPanel(completeKey, customContext) |
String |
Renders a single web panel with the specified web panel context map. The location of the specified web panel is ignored. The referenced web panel module must be enabled. Returns: The HTML of the specified web panel.
|
|||||||||
$webPanels.toString() |
String |
Renders this web panels placeholder with the default web panel context. Returns: The HTML of all web panels represented by this placeholder. |