Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [CSPX] >  [Dashboard] >  [Group]
Private  Storage   

class CSPX.Dashboard.Group extends Meter

Base class for Groups within an Dashboard.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 2 6


Summary

Properties
DefList Description Height IsRunning Label
Level Link MeterId Meters Method
Metric Orientation 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
InsertMeter OnSVGBody OnSVGDefs OnSVGHead
OnSVGInitJS OnSVGScript OnSVGStyle SetClientProperties
WidthSet XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType


Parameters

• parameter HEIGHT = 0;
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 = 0;
Should this meter display the standard label
• parameter WIDTH = 0;
Default width, in logical units, of this meter.

Properties

• property Meters as list of Meter(XMLNAME="Meters",XMLPROJECTION="ELEMENT",XMLTYPECONSTRAINT="CHOICE");
Meters belonging to this group
• property Orientation as %String(MAXLEN=10,VALUELIST=",horizontal,vertical",XMLPROJECTION="attribute") [ InitialExpression = "horizontal" ];
Direction in which to layout meters within this group.

Methods

• 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. The generated code will be called in the context of the OnPage method of the CSPX.Dashboard.Page class.
• method InsertMeter(pMeter As Meter)
Insert a meter into this group
• method OnSVGBody()
Draw the body of this SVG meter
• method OnSVGInitJS()
Generate JavaScript to initialize client-side meter object
• classmethod OnSVGScript()
Draw the script section of this SVG meter
• classmethod OnSVGStyle()
Draw the style section of this SVG meter


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.