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.Meter

CSPX.Dashboard.Meter

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

Base class for SVG-based dashboard meters.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter DOMAIN = Ensemble;
Use our own domain for localization
parameter HEIGHT = 100;
Default height, in logical units, of this meter.
parameter MINHEIGHT = 100;
Minimum height, in logical units, of this meter.
parameter MINWIDTH = 100;
Minimum width, in logical units, of this meter.
parameter SHOWLABEL = 1;
Should this meter display the standard label
parameter WIDTH = 100;
Default width, in logical units, of this meter.

Properties (Including Private)

property DefList as %String (MAXLEN = 200, XMLPROJECTION = "NONE");
Contains list of properties using default values.
Property methods: DefListDisplayToLogical(), DefListGet(), DefListIsValid(), DefListLogicalToDisplay(), DefListLogicalToOdbc(), DefListNormalize(), DefListSet()
property Description as %String (MAXLEN = 250, XMLPROJECTION = "ELEMENT");
Description for the meter.
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property Height as %Integer (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = ..#HEIGHT ];
Height, in logical units, of this meter. Note, this value is determined by the HEIGHT class parameter.
Property methods: HeightDisplayToLogical(), HeightGet(), HeightIsValid(), HeightLogicalToDisplay(), HeightNormalize(), HeightSet(), HeightXSDToLogical()
property IsRunning as %Boolean (XMLPROJECTION = "NONE");
Indicates that the production providing the metrics for this meter is running.
Property methods: IsRunningDisplayToLogical(), IsRunningGet(), IsRunningIsValid(), IsRunningLogicalToDisplay(), IsRunningLogicalToXSD(), IsRunningNormalize(), IsRunningSet(), IsRunningXSDToLogical()
property Label as %String (MAXLEN = 250, XMLPROJECTION = "ATTRIBUTE");
The label displayed for the meter.
Property methods: LabelDisplayToLogical(), LabelGet(), LabelIsValid(), LabelLogicalToDisplay(), LabelLogicalToOdbc(), LabelNormalize(), LabelSet()
property Level as %Float (XMLPROJECTION = "NONE") [ InitialExpression = 0 ];
Represents the initial level of the meter.
Property methods: LevelDisplayToLogical(), LevelGet(), LevelIsValid(), LevelLogicalToDisplay(), LevelNormalize(), LevelSet(), LevelXSDToLogical()
If present, the link (URL) used to drill into details for this meter.
Property methods: LinkDisplayToLogical(), LinkGet(), LinkIsValid(), LinkLogicalToDisplay(), LinkLogicalToOdbc(), LinkNormalize(), LinkSet()
property MeterId as %Integer (XMLPROJECTION = "NONE");
Id used when meter is placed on client page
Property methods: MeterIdDisplayToLogical(), MeterIdGet(), MeterIdIsValid(), MeterIdLogicalToDisplay(), MeterIdNormalize(), MeterIdSet(), MeterIdXSDToLogical()
property Method as %String (MAXLEN = 128, XMLPROJECTION = "ATTRIBUTE");
Optional method, within the Dashboard class, used to transform the Property value
Property methods: MethodDisplayToLogical(), MethodGet(), MethodIsValid(), MethodLogicalToDisplay(), MethodLogicalToOdbc(), MethodNormalize(), MethodSet()
property Metric as %String (MAXLEN = 128, XMLPROJECTION = "ATTRIBUTE");
Business Metric service (config name) providing the metric for this meter.
Property methods: MetricDisplayToLogical(), MetricGet(), MetricIsValid(), MetricLogicalToDisplay(), MetricLogicalToOdbc(), MetricNormalize(), MetricSet()
property Property as %String (MAXLEN = 128, XMLPROJECTION = "ATTRIBUTE");
Metric property providing the metric for this meter.
Property methods: PropertyCountDisplayToLogical(), PropertyCountGet(), PropertyCountIsValid(), PropertyCountLogicalToDisplay(), PropertyCountNormalize(), PropertyCountSet(), PropertyCountXSDToLogical(), PropertyDisplayToLogical(), PropertyGet(), PropertyIsValid(), PropertyLogicalToDisplay(), PropertyLogicalToOdbc(), PropertyNormalize(), PropertySet()
property PropertyCount as %Integer (XMLPROJECTION = "NONE") [ InitialExpression = 1 ];
Number of properties displayed by this meter
Property methods: PropertyCountDisplayToLogical(), PropertyCountGet(), PropertyCountIsValid(), PropertyCountLogicalToDisplay(), PropertyCountNormalize(), PropertyCountSet(), PropertyCountXSDToLogical()
property RangeLower as %Float (XMLPROJECTION = "ATTRIBUTE");
Represents the lower value of the meter range.
Property methods: RangeLowerDisplayToLogical(), RangeLowerGet(), RangeLowerIsValid(), RangeLowerLogicalToDisplay(), RangeLowerNormalize(), RangeLowerSet(), RangeLowerXSDToLogical()
property RangeUpper as %Float (XMLPROJECTION = "ATTRIBUTE");
Represents the upper value of the meter range.
Property methods: RangeUpperDisplayToLogical(), RangeUpperGet(), RangeUpperIsValid(), RangeUpperLogicalToDisplay(), RangeUpperNormalize(), RangeUpperSet(), RangeUpperXSDToLogical()
property ScaleFactor as %Float (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = 1 ];
For numeric displays, the meter will multiply the current level by this amount before displaying it.
Property methods: ScaleFactorDisplayToLogical(), ScaleFactorGet(), ScaleFactorIsValid(), ScaleFactorLogicalToDisplay(), ScaleFactorNormalize(), ScaleFactorSet(), ScaleFactorXSDToLogical()
property ShowLabel as %Boolean (XMLPROJECTION = "NONE") [ InitialExpression = ..#SHOWLABEL , ReadOnly ];
Indicates that the label should be displayed for this meter.
Property methods: ShowLabelDisplayToLogical(), ShowLabelGet(), ShowLabelIsValid(), ShowLabelLogicalToDisplay(), ShowLabelLogicalToXSD(), ShowLabelNormalize(), ShowLabelXSDToLogical()
property ThresholdLower as %Float (XMLPROJECTION = "ATTRIBUTE");
Represents the lower threshold level for the meter.
Property methods: ThresholdLowerDisplayToLogical(), ThresholdLowerGet(), ThresholdLowerIsValid(), ThresholdLowerLogicalToDisplay(), ThresholdLowerNormalize(), ThresholdLowerSet(), ThresholdLowerXSDToLogical()
property ThresholdUpper as %Float (XMLPROJECTION = "ATTRIBUTE");
Represents the upper threshold level for the meter.
Property methods: ThresholdUpperDisplayToLogical(), ThresholdUpperGet(), ThresholdUpperIsValid(), ThresholdUpperLogicalToDisplay(), ThresholdUpperNormalize(), ThresholdUpperSet(), ThresholdUpperXSDToLogical()
property Width as %Integer (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = ..#WIDTH ];
Width, in logical units, of this meter. Note, this value is determined by the WIDTH class parameter.
Property methods: WidthDisplayToLogical(), WidthGet(), WidthIsValid(), WidthLogicalToDisplay(), WidthNormalize(), WidthSet(), WidthXSDToLogical()
property XPos as %Integer (XMLPROJECTION = "NONE") [ InitialExpression = 0 ];
X Position, in logical units, of this meter.
Property methods: XPosDisplayToLogical(), XPosGet(), XPosIsValid(), XPosLogicalToDisplay(), XPosNormalize(), XPosSet(), XPosXSDToLogical()
property YPos as %Integer (XMLPROJECTION = "NONE") [ InitialExpression = 0 ];
Y Position, in logical units, of this meter.
Property methods: YPosDisplayToLogical(), YPosGet(), YPosIsValid(), YPosLogicalToDisplay(), YPosNormalize(), YPosSet(), YPosXSDToLogical()

Methods (Including Private)

method GenerateCode(pCode As %CharacterStream, pLevel As %Integer = 1) as %Status
Called by Dashboard class to generate code to create an instace of this object. The object instance is called tMeter. The generated code will be called in the context of the OnPage method of the CSPX.Dashboard.Page class.
method GetDefault(pName As %String) as %String
Returns the default value (from the Metric class) for the given property (e.g., RangeLower, etc).
method GetUnits() as %String
Returns the units used for the metric associated with this meter. Units are a user-defined string specified (by the UNITS parameter) within the BusinessMetric class.
method HeightSet(%val As %Integer) as %Status
method OnSVGBody()
Draw the body of this SVG meter id is a run-time assigned id value that must be used to prefix any DOM identifiers within this meter
classmethod OnSVGDefs()
Draw the defs section of this SVG meter
classmethod OnSVGHead()
Called before any scripts, styles, defs are written Usually used to pick up include files
method OnSVGInitJS()
Generate JavaScript to initialize client-side meter object
classmethod OnSVGScript()
Draw the script section of this SVG meter
classmethod OnSVGStyle()
Draw the style section of this SVG meter
method SetClientProperties()
method WidthSet(%val As %Integer) as %Status

Inherited Members

Inherited Methods (Including Private)

Subclasses