The KapBox component is a dashboard constructor.
This component is implemented by the Kap.Dashboard class. Component instance is created with the Kap.KapBox constructor.
Dashboard block is implemented with the Kap.JsBlock class.
The dashboard constructor looks as follows:
Example of the KapBox Component Layout
Method name | Brief description | |
addToNode | The addToNode method places a dashboard in the specified DOM node. | |
close | The close method closes a dashboard. | |
dispose | The dispose method removes an instance of opened dashboard from the page. | |
exportTo | The exportTo method exports dashboard to the specified format. | |
getAutoSyncNewDso | The getAutoSyncNewDso method determines whether dimensions auto syncing is enabled or disabled. | |
getBlock | The getBlock method returns dashboard block by its key. | |
getMeta | The getMeta method returns dashboard metadata. | |
getMode | The getMode method returns dashboard opening mode. | |
getMoniker | The getMoniker method returns dashboard moniker. | |
getMultiLanguage | The getMultiLanguage method determines whether multilanguage support is enabled for dashboard. | |
getNavBar | The getNavBar method returns navigation bar of dashboard designer. | |
getOpenDialog | The getOpenDialog method returns dialog box for opening an object from repository. | |
getRibbon | The getRibbon method returns dashboard designer ribbon. | |
getSaveDialog | The getOpenDialog method returns dialog box for saving repository object. | |
getSlidePanel | The getSlidePanel method returns slide panel of dashboard designer. | |
getSource | The getSource method returns dashboard source. | |
open | The open method opens dashboard. | |
The print method prints dashboard. | ||
setAutoSyncNewDso | The setAutoSyncNewDso method controls auto syncing of added blocks' dimensions. | |
setMultiLanguage | The setMultiLanguage method enables and disables dashboard multilanguage support. | |
setPageSettings | The setPageSettings method determines page settings. | |
toImage | The toImage method creates a dashboard screenshot. | |
updateSelection | The updateSelection method updates selection of dimension elements in dashboard blocks. |
See also: