Class CSPX.Dashboard.Icon

class CSPX.Dashboard.Icon extends Meter

SVG-based Icon meter for Dashboard.
The Icon meter displays a user defined icon. The icon is defined using SVG; You can define a normal icon and, in addition, you can define alternate images to display when the meter level is above or below its specified threshold value

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5	3	5

Summary

Properties
DefList	Description	Height	ImageHigh	ImageLow
ImageNormal	IsRunning	Label	Level	Link
MeterId	Method	Metric	Property	PropertyCount
RangeLower	RangeUpper	ScaleFactor	ShowLabel	ThresholdLower
ThresholdUpper	Width	XPos	YPos

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
GenerateCode	GetDefault	GetUnits	HeightSet
OnSVGBody	OnSVGDefs	OnSVGHead	OnSVGInitJS
OnSVGScript	OnSVGStyle	SetClientProperties	WidthSet
XMLDTD	XMLExport	XMLExportToStream	XMLExportToString
XMLNew	XMLSchema	XMLSchemaNamespace	XMLSchemaType

Parameters

• parameter HEIGHT = 100;

Default height, in logical units, of this meter.

• parameter MINHEIGHT = 25;

Minimum height, in logical units, of this meter.

• parameter MINWIDTH = 50;

Minimum width, in logical units, of this meter.

• parameter SHOWLABEL = 0;

Should this meter display the standard label

• parameter WIDTH = 100;

Default width, in logical units, of this meter.

Properties

• property ImageHigh as %XML.String(MAXLEN=20000,XMLPROJECTION="ELEMENT");

SVG (xml fragment) that defines the symbol to display for this meter in its high state (that is, when its value is above its threshold value).

• property ImageLow as %XML.String(MAXLEN=20000,XMLPROJECTION="ELEMENT");

SVG (xml fragment) that defines the symbol to display for this meter in its low state (that is, when its value is below its low threshold value).

• property ImageNormal as %XML.String(MAXLEN=20000,XMLPROJECTION="ELEMENT");

SVG (xml fragment) that defines the symbol to display for this meter in its normal state (that is, when its value is between the high and low threshold values).

Methods

• method GenerateCode(pCode As %CharacterStream, pLevel As %Integer = 1) as %Status

Called by Dashboard class to generate code to create an instance of this object. The object instance is called tMeter.

• method OnSVGBody()

Draw the body of this SVG meter

• classmethod OnSVGDefs()

Draw the defs section of this SVG meter

• classmethod OnSVGScript()

Draw the script section of this SVG meter

• classmethod OnSVGStyle()

Draw the style section of this SVG meter

Class Reference IRIS for UNIX 2024.1.2
Documentation Search