Home > Class Reference > ENSLIB namespace > CSPX.EnsDashboardPane

CSPX.EnsDashboardPane

class CSPX.EnsDashboardPane extends %CSP.Util.Pane

An AutoPage pane that displays an SVG dashboard

Property Inventory

Method Inventory

Parameters

parameter DOMAIN = Ensemble;
Use our own domain for localization

Properties

property Dashboard as %String (MAXLEN = 255);
Default dashboard to display
Property methods: DashboardDisplayToLogical(), DashboardGet(), DashboardIsValid(), DashboardLogicalToDisplay(), DashboardLogicalToOdbc(), DashboardNormalize(), DashboardSet()
property DefaultInstance as %String (MAXLEN = 255);
Default dashboard instance to display
Property methods: DefaultInstanceDisplayToLogical(), DefaultInstanceGet(), DefaultInstanceIsValid(), DefaultInstanceLogicalToDisplay(), DefaultInstanceLogicalToOdbc(), DefaultInstanceNormalize(), DefaultInstanceSet()

Methods

method DrawBODY(pInstance As %CSP.Util.PageInstance) as %Status [ Language = objectscript ]
Draw the BODY of the detail pane
method DrawHEAD(pInstance As %CSP.Util.PageInstance) as %Status [ Language = objectscript ]
Inherited description: Overwritten by subclasses to draw anything this pane needs for the HEAD section.
classmethod GetDefaultMetric(pDashClass As %String, Output pMetricName As %String) as %Status [ Language = objectscript ]
Returns name of default metric for the given dashboard.
classmethod GetInstanceMenu(pDashClass As %String, Output pMenu As %String, Output pCaption As %String, Output pSize As %Integer) as %Status [ Language = objectscript ]
Returns ordinal subscripted list of instance menu options.
method GetRefreshRate(pDashClass As %String) as %Integer [ Language = objectscript ]
Find refresh rate for this page
method OnGenerateCode() as %String [ Language = objectscript ]
Subclasses override this to generate code during CSP processing
classmethod RefreshDashboard(metricList As %String, dashClass As %String, clientTime As %String, defaultInstance As %String) [ Language = objectscript ]
Called from client to refresh the dashboard

Inherited Members

Inherited Properties

Inherited Methods