This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

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


class CSPX.Dashboard.ChartSeries extends %Library.RegisteredObject, %XML.Adaptor

Defines a series for a Dashboard chart. This class is for internal use only.

Property Inventory


property Color as %String (MAXLEN = 50, XMLPROJECTION = "ATTRIBUTE");
SVG Color used to display this series.
Property methods: ColorDisplayToLogical(), ColorGet(), ColorIsValid(), ColorLogicalToDisplay(), ColorLogicalToOdbc(), ColorNormalize(), ColorSet()
property Data as %String (MAXLEN = 10000, XMLPROJECTION = "NONE");
Holder for initial data for series.
Property methods: DataDisplayToLogical(), DataGet(), DataIsValid(), DataLogicalToDisplay(), DataLogicalToOdbc(), DataNormalize(), DataSet()
property Instance as %String (MAXLEN = 128, XMLPROJECTION = "ATTRIBUTE");
(Optional) Metric instance name providing the data for this series.
Property methods: InstanceDisplayToLogical(), InstanceGet(), InstanceIsValid(), InstanceLogicalToDisplay(), InstanceLogicalToOdbc(), InstanceNormalize(), InstanceSet()
property Label as %String (MAXLEN = 128, XMLPROJECTION = "ATTRIBUTE");
Label displayed for this series; If not specified, Property is used.
Property methods: LabelDisplayToLogical(), LabelGet(), LabelIsValid(), LabelLogicalToDisplay(), LabelLogicalToOdbc(), LabelNormalize(), LabelSet()
property Property as %String (MAXLEN = 128, XMLPROJECTION = "ATTRIBUTE");
Metric property providing the metric for this series. The Metric class is defined by the chart.
Property methods: PropertyDisplayToLogical(), PropertyGet(), PropertyIsValid(), PropertyLogicalToDisplay(), PropertyLogicalToOdbc(), PropertyNormalize(), PropertySet()
property RangeLower as %Float (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = 0 ];
Lower range value for this series. Only used if the chart has SharedScale set to false.
Property methods: RangeLowerDisplayToLogical(), RangeLowerGet(), RangeLowerIsValid(), RangeLowerLogicalToDisplay(), RangeLowerNormalize(), RangeLowerSet(), RangeLowerXSDToLogical()
property RangeUpper as %Float (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = 100 ];
Upper range value for this series. Only used if the chart has SharedScale set to false.
Property methods: RangeUpperDisplayToLogical(), RangeUpperGet(), RangeUpperIsValid(), RangeUpperLogicalToDisplay(), RangeUpperNormalize(), RangeUpperSet(), RangeUpperXSDToLogical()
property ScaleFactor as %Float (XMLPROJECTION = "ATTRIBUTE") [ InitialExpression = 1 ];
Scale factor for this series. Only used if the chart has SharedScale set to false.
Property methods: ScaleFactorDisplayToLogical(), ScaleFactorGet(), ScaleFactorIsValid(), ScaleFactorLogicalToDisplay(), ScaleFactorNormalize(), ScaleFactorSet(), ScaleFactorXSDToLogical()

Inherited Members

Inherited Methods