Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / CSPX.EnsDashboardPane
Private  Storage   

CSPX.EnsDashboardPane


class CSPX.EnsDashboardPane extends
%CSP.Util.Pane

An AutoPage pane that displays an SVG dashboard

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 2 7


Summary


Properties
Align CommandFormClass CommandFormObject CommandSubmitPage
Commands Dashboard DefaultInstance FrameStyle
Name Styles Text URL

Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
DrawBODY DrawCommandForm DrawCommands DrawHEAD
GenerateCode GetDefaultMetric GetInstanceMenu GetRefreshRate
LocalizeText OnGenerateCode QuoteCOS RefreshDashboard
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType


Parameters


• parameter DOMAIN = "Ensemble";
Use our own domain for localization

Properties


• property Dashboard as %String(MAXLEN=255);
Default dashboard to display
• property DefaultInstance as %String(MAXLEN=255);
Default dashboard instance to display

Methods


• method DrawBODY(pInstance As %CSP.Util.PageInstance) as %Status
Draw the BODY of the detail pane
• method DrawHEAD(pInstance As %CSP.Util.PageInstance) as %Status
Overwritten by subclasses to draw anything this pane needs for the HEAD section.
• classmethod GetDefaultMetric(pDashClass As %String, Output pMetricName As %String) as %Status
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
Returns ordinal subscripted list of instance menu options.
• method GetRefreshRate(pDashClass As %String) as %Integer
Find refresh rate for this page
• method OnGenerateCode() as %String
Subclasses override this to generate code during CSP processing
• classmethod RefreshDashboard(metricList As %String, dashClass As %String, clientTime As %String, defaultInstance As %String)
Called from client to refresh the dashboard