Uses of Interface
net.pricefx.server.dto.calculation.dashboard.DashboardApi
Package
Description
Provides API related to scripting, including interface
PublicGroovyAPI
, that represents what can be reached in the Groovy element syntax as api
.Provides Dashboard API classes.
-
Uses of DashboardApi in net.pricefx.formulaengine.scripting
Modifier and TypeMethodDescriptionReturns aDashboardApi
instance for a dashboard of the specified name. -
Uses of DashboardApi in net.pricefx.server.dto.calculation.dashboard
Modifier and TypeMethodDescriptionDashboardApi.andCloseOn
(String eventName) Closes a tab or popup window when the specified event is triggered.DashboardApi.andRecalculateOn
(String eventName) Specifies on what event the embedded dashboard will be recalculated.Exposes event payload - attribute of the specified name - as a parameter that can be read in the embedded dashboard.DashboardApi.openInModalOrRecalculateOn
(String eventName) On specified event the embedded dashboard will be opened in a new modal window and recalculated.DashboardApi.openInTabOrRecalculateOn
(String eventName) On specified event the embedded dashboard will be opened in a new tab and recalculated.DashboardApi.openInWindowOrRecalculateOn
(String eventName) Deprecated.The main dashboard can provide input parameters to the embedded dashboard viaConvenience method to set a number of parameters at once.DashboardApi.setPortlet
(String portletName) Instead of embedding a whole dashboard, only the one requested portlet will be displayed.DashboardApi.showEmbedded()
Shows given dashboard as an embedded dashboard of another (main) dashboard.DashboardApi.withEmbeddedIconHidden()
Hides the icon which notifies users that a portlet is part of an embedded Dashboard.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.withInputsHidden
(boolean hidden) Optionally hides all embedded Dashboard input parameters from the Unity UI's inputs panel.DashboardApi.withPreferences
(Map<String, Object> prefs) Hides the preferences menu and use the provided properties map instead of loading any saved preferences.