Class CSPX.Dashboard.TickerTape

class CSPX.Dashboard.TickerTape extends Meter

SVG-based TickerTape meter for Dashboard.
The TickerTape displays recent values of metric property as pieces of text sliding across a ticker tape display. Individual elements are colored differently in order to visually differentiate them. Repeating values are not displayed. There is no guarantee that any specific element will be displayed; that is function of when the metric property is updated and when the dashboard refreshes itself.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
2	1	4

Summary

Properties
DefList	Description	Height	IsRunning	Label
Level	Link	MeterId	Method	Metric
Property	PropertyCount	RangeLower	RangeUpper	ScaleFactor
ShowLabel	TextStyle	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 MINHEIGHT = 25;

Minimum height, in logical units, of this meter.

• parameter MINWIDTH = 10;

Minimum width, in logical units, of this meter.

Properties

• property TextStyle as %String(MAXLEN=100,XMLPROJECTION="ATTRIBUTE");

CSS Style applied to ticker text. E.g. "fill: blue;"

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 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