Home > Class Reference > ENSLIB namespace > %CSP.Util.HTMLDashboardPane


class %CSP.Util.HTMLDashboardPane extends %CSP.Util.Pane, %ZEN.Portal.abstractRefreshable

This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 9 5


Align CommandFormClass CommandFormObject CommandSubmitPage
Commands FrameStyle MeterClasses MeterObjects
Meters MetricClass MetricMethod Name
Orientation RefreshRate ShowIcons ShowLegend
Styles Text URL enableAutoRefresh
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
CalculatePropertyValues DrawBODY DrawCommandForm DrawCommands
DrawHEAD GenerateCode LocalizeText OnGenerateCode
QuoteCOS RefreshDashboard XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType


parameter DOMAIN = "%Utility";
Default domain for the Portal's localization.


property MeterClasses as %String(XMLPROJECTION="NONE") [ MultiDimensional ];
Transient list of Meter classes
property MeterObjects as %String(XMLPROJECTION="NONE") [ MultiDimensional ];
Transient list of Meter objects
List of meters displayed by this dashboard.
property MetricClass as %String(MAXLEN=255) [ InitialExpression = "SYS.Metrics" ];
Name of class that defines the callback method to provide data for dashboard.
property MetricMethod as %String(MAXLEN=64);
Name of callback method that provides data for dashboard.
property Orientation as %String(MAXLEN=10,VALUELIST=",horizontal,vertical",XMLPROJECTION="element") [ InitialExpression = "horizontal" ];
Direction in which to layout meters within this dashboard.
property RefreshRate as %Integer [ InitialExpression = 5000 ];
Refresh rate for dashboard in milliseconds.
property ShowIcons as %Boolean(XMLPROJECTION="element") [ InitialExpression = 1 ];
Show dashboard icons
property ShowLegend as %Boolean(XMLPROJECTION="element") [ InitialExpression = 1 ];
Show dashboard legend


classmethod CalculatePropertyValues(pID As %String, pLastCount As %Integer, pMetricClass As %String, pMetricMethod As %String, Output pValues As %String, Output pStatus As %String, Output pMsg As %String) as %Status
This callback is responsible for returning the set of property values for the dashboard.
On exit, pValues contains list of values indexed by property name.
pStatus contains list of status values indexed by property name.
pMsg contains a status message indexed by property name.
This invokes the callback specified by the MetricClass and MetricProperty properties.
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.
method OnGenerateCode() as %String
Subclasses override this to generate code during CSP processing
classmethod RefreshDashboard(pMetricClass As %String, pMetricMethod As %String, pID As %String, pLastCount As %String, metricList As %String)
Called from client to refresh the dashboard