Home > Class Reference > ENSLIB namespace > %CSP.Util.HTMLMeter
Private  

%CSP.Util.HTMLMeter

class %CSP.Util.HTMLMeter extends %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.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
6 19 9

Summary

Properties
Dashboard Description Detail FullProperty Height
InitialStatus InitialValue Label Link MeterId
Parent Property RangeLower RangeUpper ScaleFactor
ShowLabel ThresholdLower ThresholdUpper Width
Methods
%AddToSaveSet %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OriginalNamespace %PackageName
%RemoveFromSaveSet %SerializeObject %SetModified %ValidateObject
DrawSelector GenerateCode HeightSet OnHTMLBody
OnHTMLHead OnHTMLInitJS OnHTMLScript OnHTMLStyle
WidthSet XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType
Subclasses
%CSP.Util.HTMLBarMeter %CSP.Util.HTMLGroup %CSP.Util.HTMLSpacer %CSP.Util.HTMLTableMeter
%CSP.Util.HTMLValueMeter

Parameters

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

property Dashboard as HTMLDashboardPane(XMLPROJECTION="NONE");
Dashboard this meter is part of
property Description as %String(MAXLEN=250,XMLPROJECTION="ELEMENT");
Description for the meter.
property Detail as %String(MAXLEN=500,XMLPROJECTION="ATTRIBUTE");
Optional details text (as HTML) for the meter.
property FullProperty as %String(MAXLEN=500,XMLPROJECTION="NONE");
The resolved full property name.
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 InitialStatus as %String(MAXLEN=50,XMLPROJECTION="NONE");
The initial status of the meter.
property InitialValue as %String(MAXLEN=500,XMLPROJECTION="NONE");
The initial value of the meter.
property Label as %String(MAXLEN=50,XMLPROJECTION="ATTRIBUTE");
The label displayed for 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 Parent as HTMLMeter(XMLPROJECTION="NONE");
Parent meter for grouped elements
property Property as %String(MAXLEN=128,XMLPROJECTION="ATTRIBUTE");
Metric property providing the metric for 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.

Methods

method DrawSelector()
Draw standard selector / indicator box for 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.
method HeightSet(%val As %Integer) as %Status
This is a Set accessor method for the Height property.
method OnHTMLBody()
Draw the body of this HTML meter
classmethod OnHTMLHead()
Called before any scripts, styles, defs are written Usually used to pick up include files
method OnHTMLInitJS()
Generate JavaScript to initialize client-side meter object
classmethod OnHTMLScript()
Draw the script section of this HTML meter
classmethod OnHTMLStyle()
Draw the style section of this HTML meter
method WidthSet(%val As %Integer) as %Status
This is a Set accessor method for the Width property.