Package com.morpheusdata.core.dashboard

Interface DashboardItemTypeProvider

All Superinterfaces:

PluginProvider, UIExtensionProvider

All Known Implementing Classes:

AbstractDashboardItemTypeProvider

public interface DashboardItemTypeProvider
extends UIExtensionProvider

Provides an interface and standard set of methods for creating custom dashboard item types

Since:

0.13

Nested Class Summary

Nested classes/interfaces inherited from interface com.morpheusdata.core.providers.PluginProvider

PluginProvider.EventSubscriberFacet<E extends Event>

Method Summary

Modifier and Type	Method	Description
String	getDashboardItemScriptPath(DashboardItem dashboardItem, Map<String,Object> opts)	Returns the relative path of a script for this dashboard item
DashboardItemType	getDashboardItemType()	the dashboard item model representing the dashboard item
HTMLResponse	renderDashboardItem(DashboardItem dashboardItem, Map<String,Object> opts)	Presents the HTML Rendered output of a dashboard item.

Methods inherited from interface com.morpheusdata.core.providers.PluginProvider

getCode, getMorpheus, getName, getPlugin, isPlugin

Methods inherited from interface com.morpheusdata.core.providers.UIExtensionProvider

getContentSecurityPolicy, getRenderer

Method Details

getDashboardItemType

DashboardItemType getDashboardItemType()

the dashboard item model representing the dashboard item

Returns:

the Dasbhaord item model

renderDashboardItem

HTMLResponse renderDashboardItem(DashboardItem dashboardItem,
 Map<String,Object> opts)

Presents the HTML Rendered output of a dashboard item. This can use different Renderer implementations. The preferred is to use server side handlebars rendering with HandlebarsRenderer

Example Render:

    ViewModel model = new ViewModel()
 	  model.object = reportRowsBySection
 	  getRenderer().renderTemplate("hbs/instanceReport", model)
 

Parameters:

dashboardItem - the dashboard item to render

opts - map of input options

Returns:

result of rendering an item

getDashboardItemScriptPath

String getDashboardItemScriptPath(DashboardItem dashboardItem,
 Map<String,Object> opts)

Returns the relative path of a script for this dashboard item

Parameters:

dashboardItem - the dashboard item to render

opts - map of input options

Returns:

result of rendering an item