Uses of Interface
net.pricefx.server.dto.calculation.dashboard.DashboardApi

Packages that use DashboardApi

Package	Description
net.pricefx.formulaengine.scripting	Root package of the public Groovy API available to Pricefx logics.
net.pricefx.server.dto.calculation.dashboard	Embedding one dashboard in another, so that the embedded one reacts to events.

Uses of DashboardApi in net.pricefx.formulaengine.scripting

Methods in net.pricefx.formulaengine.scripting that return DashboardApi

Modifier and Type	Method	Description
DashboardApi	PublicGroovyAPI.dashboard(String dashboardName)	Returns a DashboardApi instance for a dashboard of the specified name.

Uses of DashboardApi in net.pricefx.server.dto.calculation.dashboard

Methods in net.pricefx.server.dto.calculation.dashboard that return DashboardApi

Modifier and Type	Method	Description
DashboardApi	DashboardApi.andCloseOn(String eventName)	Closes a tab or popup window when the specified event is triggered.
DashboardApi	DashboardApi.andRecalculateOn(String eventName)	Specifies on what event the embedded dashboard will be recalculated.
DashboardApi	DashboardApi.asParam(String paramName)	Exposes event payload - attribute of the specified name - as a parameter that can be read in the embedded dashboard.
DashboardApi	DashboardApi.openInModalOrRecalculateOn(String eventName)	On specified event the embedded dashboard will be opened in a new modal window and recalculated.
DashboardApi	DashboardApi.openInTabOrRecalculateOn(String eventName)	On specified event the embedded dashboard will be opened in a new tab and recalculated.
DashboardApi	DashboardApi.openInWindowOrRecalculateOn(String eventName)	Deprecated. use openInModalOrRecalculateOn(String) instead
DashboardApi	DashboardApi.setParam(String paramName, Object value)	The main dashboard can provide input parameters to the embedded dashboard via
DashboardApi	DashboardApi.setParams(Map<String,Object> nameValueMap)	Convenience method to set a number of parameters at once.
DashboardApi	DashboardApi.setPortlet(String portletName)	Instead of embedding a whole dashboard, only the one requested portlet will be displayed.
DashboardApi	DashboardApi.showEmbedded()	Shows given dashboard as an embedded dashboard of another (main) dashboard.
DashboardApi	DashboardApi.showInClicSiderTab()	Opens the specified dashboard in the sider, in the Charts and Graphs tab for the currently-selected CLIC line item or header.
DashboardApi	DashboardApi.withEmbeddedIconHidden()	Hides the icon which notifies users that a portlet is part of an embedded Dashboard.
DashboardApi	DashboardApi.withEventDataAttr(String attrName)	Allows to expose event payload - attribute of the specified name - as a parameter that can be read in the embedded dashboard.
default DashboardApi	DashboardApi.withInputsHidden()	Optionally hides all embedded Dashboard input parameters from the Unity UI's inputs panel.
DashboardApi	DashboardApi.withInputsHidden(boolean hidden)	Optionally hides all embedded Dashboard input parameters from the Unity UI's inputs panel.
DashboardApi	DashboardApi.withPreferences(Map<String,Object> prefs)	Hides the preferences menu and use the provided properties map instead of loading any saved preferences.