Home > Class Reference > %SYS namespace > %CSP.Util.HTMLMeter


class %CSP.Util.HTMLMeter extends %Library.RegisteredObject, %XML.Adaptor

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.

Base class for HTML-based dashboard meters.

Property Inventory (Including Private)

Method Inventory (Including Private)


parameter DOMAIN = %Utility;
Default domain for the Portal's localization.
parameter HEIGHT = 20;
Default height, in logical units, of this meter.
parameter MINHEIGHT = 0;
Minimum height, in logical units, of this meter.
parameter MINWIDTH = 0;
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 Dashboard as HTMLDashboardPane (XMLPROJECTION = "NONE");
Dashboard this meter is part of
Property methods: DashboardGet(), DashboardGetSwizzled(), DashboardIsValid(), DashboardNewObject(), DashboardSet()
property Description as %String (MAXLEN = 250, XMLPROJECTION = "ELEMENT");
Description for the meter.
Property methods: DescriptionDisplayToLogical(), DescriptionGet(), DescriptionIsValid(), DescriptionLogicalToDisplay(), DescriptionLogicalToOdbc(), DescriptionNormalize(), DescriptionSet()
property Detail as %String (MAXLEN = 500, XMLPROJECTION = "ATTRIBUTE");
Optional details text (as HTML) for the meter.
Property methods: DetailDisplayToLogical(), DetailGet(), DetailIsValid(), DetailLogicalToDisplay(), DetailLogicalToOdbc(), DetailNormalize(), DetailSet()
property FullProperty as %String (MAXLEN = 500, XMLPROJECTION = "NONE");
The resolved full property name.
Property methods: FullPropertyDisplayToLogical(), FullPropertyGet(), FullPropertyIsValid(), FullPropertyLogicalToDisplay(), FullPropertyLogicalToOdbc(), FullPropertyNormalize(), FullPropertySet()
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 InitialStatus as %String (MAXLEN = 50, XMLPROJECTION = "NONE");
The initial status of the meter.
Property methods: InitialStatusDisplayToLogical(), InitialStatusGet(), InitialStatusIsValid(), InitialStatusLogicalToDisplay(), InitialStatusLogicalToOdbc(), InitialStatusNormalize(), InitialStatusSet()
property InitialValue as %String (MAXLEN = 500, XMLPROJECTION = "NONE");
The initial value of the meter.
Property methods: InitialValueDisplayToLogical(), InitialValueGet(), InitialValueIsValid(), InitialValueLogicalToDisplay(), InitialValueLogicalToOdbc(), InitialValueNormalize(), InitialValueSet()
property Label as %String (MAXLEN = 50, XMLPROJECTION = "ATTRIBUTE");
The label displayed for the meter.
Property methods: LabelDisplayToLogical(), LabelGet(), LabelIsValid(), LabelLogicalToDisplay(), LabelLogicalToOdbc(), LabelNormalize(), LabelSet()
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 Parent as HTMLMeter (XMLPROJECTION = "NONE");
Parent meter for grouped elements
Property methods: ParentGet(), ParentGetSwizzled(), ParentIsValid(), ParentNewObject(), ParentSet()
property Property as %String (MAXLEN = 128, XMLPROJECTION = "ATTRIBUTE");
Metric property providing the metric for this meter.
Property methods: PropertyDisplayToLogical(), PropertyGet(), PropertyIsValid(), PropertyLogicalToDisplay(), PropertyLogicalToOdbc(), PropertyNormalize(), PropertySet()
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()

Methods (Including Private)

method DrawSelector() [ Language = objectscript ]
Draw standard selector / indicator box for meter
method GenerateCode(pCode As %CharacterStream, pLevel As %Integer = 1) as %Status [ Language = objectscript ]
Called by Dashboard class to generate code to create an instace of this object. The object instance is called tMeter.
method HeightSet(%val As %Integer) as %Status [ Language = objectscript ]
method OnHTMLBody() [ Language = objectscript ]
Draw the body of this HTML meter
classmethod OnHTMLHead() [ Language = objectscript ]
Called before any scripts, styles, defs are written Usually used to pick up include files
method OnHTMLInitJS() [ Language = objectscript ]
Generate JavaScript to initialize client-side meter object
classmethod OnHTMLScript() [ Language = objectscript ]
Draw the script section of this HTML meter
classmethod OnHTMLStyle() [ Language = objectscript ]
Draw the style section of this HTML meter
method WidthSet(%val As %Integer) as %Status [ Language = objectscript ]

Inherited Members

Inherited Methods (Including Private)