This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see How to Migrate to InterSystems IRIS, available on the WRC Distributions page (login required).

%CSP.Util.HTMLDashboardPane

class %CSP.Util.HTMLDashboardPane extends %CSP.Util.Pane

This class is used internally by Caché. 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.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

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

Properties

property MeterClasses as %String (XMLPROJECTION = "NONE") [ MultiDimensional ];
Transient list of Meter classes
Property methods: MeterClassesDisplayToLogical(), MeterClassesGet(), MeterClassesIsValid(), MeterClassesLogicalToDisplay(), MeterClassesLogicalToOdbc(), MeterClassesNormalize(), MeterClassesSet()
property MeterObjects as %String (XMLPROJECTION = "NONE") [ MultiDimensional ];
Transient list of Meter objects
Property methods: MeterObjectsDisplayToLogical(), MeterObjectsGet(), MeterObjectsIsValid(), MeterObjectsLogicalToDisplay(), MeterObjectsLogicalToOdbc(), MeterObjectsNormalize(), MeterObjectsSet()
property Meters as list of HTMLMeter (XMLPROJECTION = "ELEMENT", XMLTYPECONSTRAINT = "CHOICE");
List of meters displayed by this dashboard.
Property methods: MetersBuildValueArray(), MetersCollectionToDisplay(), MetersCollectionToOdbc(), MetersDisplayToCollection(), MetersGet(), MetersGetObject(), MetersGetObjectId(), MetersGetSwizzled(), MetersIsValid(), MetersOdbcToCollection(), MetersSet(), MetersSetObject(), MetersSetObjectId()
property MetricClass as %String (MAXLEN = 255) [ InitialExpression = "SYS.Metrics" ];
Name of class that defines the callback method to provide data for dashboard.
Property methods: MetricClassDisplayToLogical(), MetricClassGet(), MetricClassIsValid(), MetricClassLogicalToDisplay(), MetricClassLogicalToOdbc(), MetricClassNormalize(), MetricClassSet()
property MetricMethod as %String (MAXLEN = 64);
Name of callback method that provides data for dashboard.
Property methods: MetricMethodDisplayToLogical(), MetricMethodGet(), MetricMethodIsValid(), MetricMethodLogicalToDisplay(), MetricMethodLogicalToOdbc(), MetricMethodNormalize(), MetricMethodSet()
property Orientation as %String (MAXLEN = 10, VALUELIST = ",horizontal,vertical", XMLPROJECTION = "element") [ InitialExpression = "horizontal" ];
Direction in which to layout meters within this dashboard.
Property methods: OrientationDisplayToLogical(), OrientationGet(), OrientationIsValid(), OrientationLogicalToDisplay(), OrientationLogicalToOdbc(), OrientationNormalize(), OrientationSet()
property RefreshRate as %Integer [ InitialExpression = 5000 ];
Refresh rate for dashboard in milliseconds.
Property methods: RefreshRateDisplayToLogical(), RefreshRateGet(), RefreshRateIsValid(), RefreshRateLogicalToDisplay(), RefreshRateNormalize(), RefreshRateSet(), RefreshRateXSDToLogical()
property ShowIcons as %Boolean (XMLPROJECTION = "element") [ InitialExpression = 1 ];
Show dashboard icons
Property methods: ShowIconsDisplayToLogical(), ShowIconsGet(), ShowIconsIsValid(), ShowIconsLogicalToDisplay(), ShowIconsLogicalToXSD(), ShowIconsNormalize(), ShowIconsSet(), ShowIconsXSDToLogical()
property ShowLegend as %Boolean (XMLPROJECTION = "element") [ InitialExpression = 1 ];
Show dashboard legend
Property methods: ShowLegendDisplayToLogical(), ShowLegendGet(), ShowLegendIsValid(), ShowLegendLogicalToDisplay(), ShowLegendLogicalToXSD(), ShowLegendNormalize(), ShowLegendSet(), ShowLegendXSDToLogical()

Methods

private method BuildMeterLists()
Build list of meter objects and classes
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
Inherited description: 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

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Feedback