Class CSPX.Dashboard.Grid

class CSPX.Dashboard.Grid extends Meter

Grid Meter for Dashboard. The Grid Meter displays a set of data as a simple table.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
2	13	6

Summary

Properties
CellStyle	ColLabels	Columns	DefList	Description
Height	IsRunning	Label	LabelHeight	LabelSource
LabelStyle	LabelWidth	Level	Link	MaxColumns
MaxRows	MeterId	Method	Metric	Property
PropertyCount	RangeLower	RangeUpper	RowHeight	RowLabels
Rows	ScaleFactor	ShowLabel	ThresholdLower	ThresholdUpper
Unsupported	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 = 75;

Minimum height, in logical units, of this meter.

• parameter MINWIDTH = 75;

Minimum width, in logical units, of this meter.

Properties

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

Default CSS Style applied to grid cells. E.g. "fill: blue;"

• property ColLabels as %String(MAXLEN=10000,XMLPROJECTION="NONE");

Internal holder for initial column labels.

• property Columns as GridDimension(XMLNAME="Columns",XMLPROJECTION="ELEMENT");

Data specification for grid columns.

• property LabelHeight as %Integer(MINVAL=0,XMLPROJECTION="ATTRIBUTE") [ InitialExpression = 10 ];

Display height (in logical units) of the upper labels in the grid.

• property LabelSource as %String(MAXLEN=64,XMLPROJECTION="NONE");

Not supported at this time.

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

CSS Style applied to grid labels. E.g. "fill: blue;"

• property LabelWidth as %Integer(MINVAL=0,XMLPROJECTION="ATTRIBUTE") [ InitialExpression = 25 ];

Display width (in logical units) of the side labels in the grid.

• property MaxColumns as %Integer(MINVAL=0,XMLPROJECTION="ATTRIBUTE") [ InitialExpression = 40 ];

Maximum number of columns to display in the grid.

• property MaxRows as %Integer(MINVAL=0,XMLPROJECTION="ATTRIBUTE") [ InitialExpression = 40 ];

Maximum number of rows to display in the grid.

• property RowHeight as %Integer(MINVAL=0,XMLPROJECTION="ATTRIBUTE") [ InitialExpression = 10 ];

Display height (in logical units) of each row in the grid.

• property RowLabels as %String(MAXLEN=10000,XMLPROJECTION="NONE");

Internal holder for initial row labels.

• property Rows as GridDimension(XMLNAME="Rows",XMLPROJECTION="ELEMENT");

Data specification for grid rows.

• property Unsupported as %Boolean(XMLPROJECTION="NONE") [ InitialExpression = 0 ];

Internal flag for unsupport row/columns combinations.

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 OnSVGHead()

Called before any scripts, styles, defs are written Usually used to pick up include files

• 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

Class Reference IRIS for UNIX 2024.1.2
Documentation Search