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 > %DeepSee.Dashboard.ChartDataSeries

%DeepSee.Dashboard.ChartDataSeries

serial class %DeepSee.Dashboard.ChartDataSeries extends %Library.SerialObject, %XML.Adaptor

This class defines options for a chart data series within a user-defined DeepSee dashboard widget. This lets the user customize the display of data series within a chart.

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter NAMESPACE = http://www.intersystems.com/deepsee/library;
Inherited description: NAMESPACE specifies the XML namespace to be used when projecting the class to XML. if NAMESPACE - "", the default namespace is used for the XML schema is used as the namespace for his class.
parameter XMLIGNORENULL = 1;
Inherited description: XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.
parameter XMLNAME = chartDataSeries;
Inherited description: This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties (Including Private)

property color as %String (MAXLEN = 255, XMLPROJECTION = "attribute");
Color for this data series.
Property methods: colorDisplayToLogical(), colorGet(), colorIsValid(), colorLogicalToDisplay(), colorLogicalToOdbc(), colorNormalize(), colorSet()
property hasLegend as %Boolean (XMLPROJECTION = "attribute") [ InitialExpression = 1 ];
If false, do not include this series in the chart legend.
Property methods: hasLegendDisplayToLogical(), hasLegendGet(), hasLegendIsValid(), hasLegendLogicalToDisplay(), hasLegendLogicalToXSD(), hasLegendNormalize(), hasLegendSet(), hasLegendXSDToLogical()
property markerShape as %String (MAXLEN = 255, VALUELIST = ",up,down,circle,square", XMLPROJECTION = "attribute");
Marker to display for this series (used by line Charts).
Property methods: markerShapeDisplayToLogical(), markerShapeGet(), markerShapeIsValid(), markerShapeLogicalToDisplay(), markerShapeLogicalToOdbc(), markerShapeNormalize(), markerShapeSet()
property type as %String (MAXLEN = 255, VALUELIST = ",bar,line,area", XMLPROJECTION = "attribute");
How to display this series (used by comboCharts).
Property methods: typeDisplayToLogical(), typeGet(), typeIsValid(), typeLogicalToDisplay(), typeLogicalToOdbc(), typeNormalize(), typeSet()
property yAxisIndex as %Integer (MINVAL = 0, XMLPROJECTION = "attribute") [ InitialExpression = 0 ];
yAxis (0-based) to use for this series.
Property methods: yAxisIndexDisplayToLogical(), yAxisIndexGet(), yAxisIndexIsValid(), yAxisIndexLogicalToDisplay(), yAxisIndexNormalize(), yAxisIndexSet(), yAxisIndexXSDToLogical()

Methods (Including Private)

method %CopyTo(pTarget As %DeepSee.Dashboard.ChartDataSeries) as %Status
Copy contents of this instance to pTarget.

Inherited Members

Inherited Methods (Including Private)