serial class %DeepSee.Dashboard.DataProperty
extends %SerialObject, %XML.Adaptor
This class defines a how a specific dataProperty is displayed within a user-defined DeepSee dashboard widget.
Many of the properties are only used by specific widget types.
This is what is saved to disk, not part of the actual visual component.
• parameter NAMESPACE = "http://www.intersystems.com/deepsee/library";
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;
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 = "dataProperty";
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 align
as %String(MAXLEN=25,XMLPROJECTION="attribute");
Alignment of column within the widget if appropriate.
• property baseValue
as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Optional. Base value for this property.
This can contain an actual value (numeric) or the name of a property within the dataSource.
• property dataValue
as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Value used for this property.
This can be a number or the name of the property in data source that supplies the value for this column.
It can also contain a DeepSee formula (starting with "=").
• property display
as %ZEN.Datatype.string(VALUELIST=",itemNo,label,title,value,arrow,lamp,trendLine,plotBox,hidden",XMLPROJECTION="attribute");
Specify what to display for this property.
• property format
as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Specify how to format the value for this property.
• property label
as %ZEN.Datatype.caption(XMLPROJECTION="attribute");
Label displayed for this item within the widget.
• property name
as %String(MAXLEN=255,XMLPROJECTION="attribute");
Identifying name for this dataProperty. This is used to logically identify it.
• property rangeLower
as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Optional. Lower range value for this property.
If this is not supplied, the default value for the data source is used.
This can contain an actual value (numeric) or the name of a property within the dataSource.
• property rangeUpper
as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Optional. Upper range value for this property.
If this is not supplied, the default value for the data source is used.
This can contain an actual value (numeric) or the name of a property within the dataSource.
• property showAs
as %ZEN.Datatype.string(VALUELIST=",value,conditional,sum,target,target%,sum%",XMLPROJECTION="attribute");
Specify how to display values for this property (when displayed in a scoreCard).
If "value" then the value for the property is displayed.
If "conditional" then the value for the property is displayed if the property exists.
If "sum" then the total of all values for the property is displayed.
If "target" then the target value is displayed.
If "target%" then the value as a percentage of the target is displayed.
If "sum%" then the value as a percentage of the sum is displayed.
• property style
as %ZEN.Datatype.style(XMLPROJECTION="attribute");
Style to apply to this property if appropriate.
This is a CSS style string: e.g., "color: red;"
• property subtype
as %String(MAXLEN=255,XMLPROJECTION="attribute");
For some widget types, such as meters, this lets an individual meter override the overall subtype.
• property summary
as %ZEN.Datatype.string(VALUELIST=",sum,avg,min,max,value",XMLPROJECTION="attribute");
Type of summary to display for this column.
If "", then no summary is displayed.
"sum" computes and displays the sum of the values within the column.
"avg" computes and displays the average of the values within the column.
"min" finds and displays the minimum of the values within the column.
"max" finds and displays the maximum of values within the column.
"value" evaluates and displays the value of the summaryValue property.
• property summaryValue
as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Value to use for the summary of the column (if summary is "value").
This can be a literal number, a literal string (enclosed within ""),
the name of the property in data source that supplies the value for this column,
or an expression (starting with =).
• property targetValue
as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Optional. Target value for this property.
This is used for columns that display a target value. If this is not supplied,
the default target value for the data source is used.
This can contain an actual value (numeric) or the name of a property within the dataSource.
• property thresholdLower
as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Optional. Lower threshold value for this property.
If this is not supplied, the default value for the data source is used.
This can contain an actual value (numeric) or the name of a property within the dataSource.
• property thresholdUpper
as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Optional. Upper threshold value for this property.
If this is not supplied, the default value for the data source is used.
This can contain an actual value (numeric) or the name of a property within the dataSource.
• property valueColumn
as %ZEN.Datatype.boolean(XMLPROJECTION="attribute");
If true, then this column supplies the logical value used to identify a row
within the score card. This may be used to tie actions to the scorecard.
• property width
as %ZEN.Datatype.length(XMLPROJECTION="attribute");
Width of column within the widget if appropriate.
