class CSPX.Dashboard.Meter
extends %RegisteredObject, %XML.Adaptor
Base class for SVG-based dashboard meters.
• 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.
• property DefList
as %String(MAXLEN=200,XMLPROJECTION="NONE");
Contains list of properties using default values.
• property Description
as %String(MAXLEN=250,XMLPROJECTION="ELEMENT");
Description for the meter.
• 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 IsRunning
as %Boolean(XMLPROJECTION="NONE");
Indicates that the production providing the metrics for this meter is running.
• property Label
as %String(MAXLEN=250,XMLPROJECTION="ATTRIBUTE");
The label displayed for the meter.
• property Level
as %Float(XMLPROJECTION="NONE") [ InitialExpression = 0 ];
Represents the initial level of the meter.
• property Link
as %String(MAXLEN=128,XMLPROJECTION="ATTRIBUTE");
If present, the link (URL) used to drill into details for this meter.
• property MeterId
as %Integer(XMLPROJECTION="NONE");
Id used when meter is placed on client page
• property Method
as %String(MAXLEN=128,XMLPROJECTION="ATTRIBUTE");
Optional method, within the Dashboard class, used to transform
the Property value
• property Metric
as %String(MAXLEN=128,XMLPROJECTION="ATTRIBUTE");
Business Metric service (config name) providing the metric for this meter.
• property Property
as %String(MAXLEN=128,XMLPROJECTION="ATTRIBUTE");
Metric property providing the metric for this meter.
• property PropertyCount
as %Integer(XMLPROJECTION="NONE") [ InitialExpression = 1 ];
Number of properties displayed by this meter
• property RangeLower
as %Float(XMLPROJECTION="ATTRIBUTE");
Represents the lower value of the meter range.
• property RangeUpper
as %Float(XMLPROJECTION="ATTRIBUTE");
Represents the upper value of the meter range.
• 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 ShowLabel
as %Boolean(XMLPROJECTION="NONE") [ InitialExpression = ..#SHOWLABEL,ReadOnly ];
Indicates that the label should be displayed for this meter.
• property ThresholdLower
as %Float(XMLPROJECTION="ATTRIBUTE");
Represents the lower threshold level for the meter.
• property ThresholdUpper
as %Float(XMLPROJECTION="ATTRIBUTE");
Represents the upper threshold level for the meter.
• 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 XPos
as %Integer(XMLPROJECTION="NONE") [ InitialExpression = 0 ];
X Position, in logical units, of this meter.
• property YPos
as %Integer(XMLPROJECTION="NONE") [ InitialExpression = 0 ];
Y Position, in logical units, of this meter.
• 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
This is a Set accessor method for the Height property.
• 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
This is a Set accessor method for the Width property.
