This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > CSPX.Dashboard.Renderer


class CSPX.Dashboard.Renderer extends %Library.RegisteredObject, %XML.Adaptor

Defines a set of meters that form a Dashboard and generates the SVG framework needed to display the Dashboard.
Users should not work directly with this class.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter DOMAIN = Ensemble;
Use our own domain for localization
parameter XMLNAME = Dashboard;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties (Including Private)

property InstanceMenu as %String (MAXLEN = 50, XMLPROJECTION = "ATTRIBUTE");
If defined, the accompanying info pane will display a set of instances for the default Metric.
The value of this property is used as the Instance Menu caption.
Property methods: InstanceMenuDisplayToLogical(), InstanceMenuGet(), InstanceMenuIsValid(), InstanceMenuLogicalToDisplay(), InstanceMenuLogicalToOdbc(), InstanceMenuNormalize(), InstanceMenuSet()
property Label as %String (MAXLEN = 250, XMLPROJECTION = "ATTRIBUTE");
The label displayed for the dashboard.
Property methods: LabelDisplayToLogical(), LabelGet(), LabelIsValid(), LabelLogicalToDisplay(), LabelLogicalToOdbc(), LabelNormalize(), LabelSet()
property Meters as list of Meter (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 Metric as %String (MAXLEN = 128, XMLPROJECTION = "ATTRIBUTE");
Default Business Metric service (config name) for this dashboard.
Property methods: MetricDisplayToLogical(), MetricGet(), MetricIsValid(), MetricLogicalToDisplay(), MetricLogicalToOdbc(), MetricNormalize(), MetricSet()
property Orientation as %String (MAXLEN = 10, VALUELIST = ",horizontal,vertical", XMLPROJECTION = "attribute") [ InitialExpression = "horizontal" ];
Direction in which to layout meters within this dashboard.
Property methods: OrientationDisplayToLogical(), OrientationGet(), OrientationIsValid(), OrientationLogicalToDisplay(), OrientationLogicalToOdbc(), OrientationNormalize(), OrientationSet()
property RefreshRate as %Integer (MINVAL = 0, XMLPROJECTION = "attribute") [ InitialExpression = 10000 ];
Refresh rate, in milliseconds, for the dashboard.
Property methods: RefreshRateDisplayToLogical(), RefreshRateGet(), RefreshRateIsValid(), RefreshRateLogicalToDisplay(), RefreshRateNormalize(), RefreshRateSet(), RefreshRateXSDToLogical()
property Width as %Integer (XMLPROJECTION = "attribute") [ InitialExpression = 500 ];
Desired width, in logical units, of this dashboard.
Property methods: WidthDisplayToLogical(), WidthGet(), WidthIsValid(), WidthLogicalToDisplay(), WidthNormalize(), WidthSet(), WidthXSDToLogical()

Methods (Including Private)

classmethod EvalMetric(pMetric As %String, pDefaultInstance As %String = "") as %String
Evaluate a metric name and return a form suitable for the client.
method GenerateCode(pCode As %CharacterStream) as %Status
Called by Dashboard class to generate code to create an instance of this object. The object instance is called pDashboard.
method InsertMeter(pMeter As Meter)
Insert a meter into this dashboard
classmethod ParseMetric(pMetric As %String, pDefaultInstance As %String, Output pMetricName As %String, Output pInstance As %String) as %Status
Pull apart a Metric value into metric name and instance name.
method ProcessChartLabels(meter As Meter, tMetric As %String, tInstance As %String)
Special label and initial data processing for charts
method ProcessGridLabels(meter As Meter, tMetric As %String, tInstance As %String)
Special label and initial data processing for grids
method RenderSVG()
Render the SVG for the set of meters

Inherited Members

Inherited Methods (Including Private)