Home > Class Reference > ENSLIB namespace > CSPX.Dashboard.Icon

CSPX.Dashboard.Icon

class CSPX.Dashboard.Icon extends CSPX.Dashboard.Meter

SVG-based Icon meter for Ensemble 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

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter HEIGHT = 100;
Inherited description: Default height, in logical units, of this meter.
parameter MINHEIGHT = 25;
Inherited description: Minimum height, in logical units, of this meter.
parameter MINWIDTH = 50;
Inherited description: Minimum width, in logical units, of this meter.
parameter SHOWLABEL = 0;
Inherited description: Should this meter display the standard label
parameter WIDTH = 100;
Inherited description: Default width, in logical units, of this meter.

Properties (Including Private)

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 methods: ImageHighDisplayToLogical(), ImageHighGet(), ImageHighIsValid(), ImageHighLogicalToDisplay(), ImageHighLogicalToOdbc(), ImageHighNormalize(), ImageHighSet()
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 methods: ImageLowDisplayToLogical(), ImageLowGet(), ImageLowIsValid(), ImageLowLogicalToDisplay(), ImageLowLogicalToOdbc(), ImageLowNormalize(), ImageLowSet()
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).
Property methods: ImageNormalDisplayToLogical(), ImageNormalGet(), ImageNormalIsValid(), ImageNormalLogicalToDisplay(), ImageNormalLogicalToOdbc(), ImageNormalNormalize(), ImageNormalSet()

Methods (Including Private)

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()
Inherited description: Draw the style section of this SVG meter

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)