Skip to main content


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

This class defines a formatting condition within a DeepSee saved pivot.
This is used to fill in the values of a pivotCondition within a DeepSee pivot table.

Property Inventory


parameter NAMESPACE =;
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 = formatRule;
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.


property icon as %ZEN.Datatype.uri (XMLPROJECTION = "attribute");
If defined, replace value with this icon.
Property methods: iconDisplayToLogical(), iconGet(), iconIsValid(), iconLogicalToDisplay(), iconLogicalToOdbc(), iconNormalize(), iconSet()
property iconCount as %ZEN.Datatype.integer (XMLPROJECTION = "attribute") [ InitialExpression = 1 ];
If defined and icon is defined, replace value with this number of icons.
Property methods: iconCountDisplayToLogical(), iconCountGet(), iconCountIsValid(), iconCountLogicalToDisplay(), iconCountLogicalToOdbc(), iconCountNormalize(), iconCountSet()
property operator as %ZEN.Datatype.string (VALUELIST = ",=,<>,>,<,>=,<=,BETWEEN,IN", XMLPROJECTION = "attribute");
Condition operator.
Property methods: operatorDisplayToLogical(), operatorGet(), operatorIsValid(), operatorLogicalToDisplay(), operatorLogicalToOdbc(), operatorNormalize(), operatorSet()
property range as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Range of cells for which this rule applies. This is comma-seperated list of integers. The list is of the form:
For now, only the start values are used.
Property methods: rangeDisplayToLogical(), rangeGet(), rangeIsValid(), rangeLogicalToDisplay(), rangeLogicalToOdbc(), rangeNormalize(), rangeSet()
property style as (XMLPROJECTION = "attribute");
CSS style to apply to cells that match this condition.
Property methods: styleDisplayToLogical(), styleGet(), styleIsValid(), styleLogicalToDisplay(), styleLogicalToOdbc(), styleNormalize(), styleSet()
property text as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
If defined, replace value with this text.
Property methods: textDisplayToLogical(), textGet(), textIsValid(), textLogicalToDisplay(), textLogicalToOdbc(), textNormalize(), textSet()
property value as %ZEN.Datatype.csv (XMLPROJECTION = "attribute");
Value (or values) to test. For IN and BETWEEN this is a comma-delimited list.
Property methods: valueDisplayToLogical(), valueGet(), valueIsValid(), valueLogicalToDisplay(), valueLogicalToOdbc(), valueNormalize(), valueSet()

Inherited Members

Inherited Methods

FeedbackOpens in a new tab