Skip to main content

%DeepSee.Component.dataPropertyDefinition

Class %DeepSee.Component.dataPropertyDefinition Extends %ZEN.Component.object [ System = 3 ]

Defines a dataProperty definition within a Dashboard widget definition. This is used by the Widget editor. It is not the saved state of the dataProperty.

Parameters​

NAMESPACE​

Parameter NAMESPACE = "http://www.intersystems.com/deepsee";

Properties​

label​

Property label As %ZEN.Datatype.caption;

Label displayed for this item within the widget.

format​

Property format As %ZEN.Datatype.string;

Specify how to format the value for this item.

subtype​

Property subtype As %ZEN.Datatype.string;

Local override of widget subtype (used by meters).

width​

Property width As %ZEN.Datatype.length;

Width of column within the widget if appropriate.

align​

Property align As %ZEN.Datatype.string(VALUELIST = ",left,right,center");

Alignment of text within a column within the widget if appropriate. If not specified, a default alignment is used.

valueColumn​

Property valueColumn As %ZEN.Datatype.boolean;

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.

summary​

Property summary As %ZEN.Datatype.string(VALUELIST = ",sum,avg,min,max,value");

Type of summary to display for this column. If "", then no summary is displayed.

summaryValue​

Property summaryValue As %ZEN.Datatype.string(VALUELIST = ",sum,avg,min,max,value");

Value to use for summary (if summary is "value").

style​

Property style As %ZEN.Datatype.style;

Style to apply to this property if appropriate.
This is a CSS style string: e.g., "color: red;"

display​

Property display As %ZEN.Datatype.string(VALUELIST = ",itemNo,label,value,arrow,lamp,trendLine,plotBox,hidden");

Specify what to display for this property.

showAs​

Property showAs As %ZEN.Datatype.string(VALUELIST = ",value,sum,target,target%,sum%");

Specify how to display values for this property.
If "value" then the value for the property is displayed.
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.

dataValue​

Property dataValue As %ZEN.Datatype.string;

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.

targetValue​

Property targetValue As %ZEN.Datatype.string;

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.

thresholdLower​

Property thresholdLower As %ZEN.Datatype.string;

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.

thresholdUpper​

Property thresholdUpper As %ZEN.Datatype.string;

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.

rangeLower​

Property rangeLower As %ZEN.Datatype.string;

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.

rangeUpper​

Property rangeUpper As %ZEN.Datatype.string;

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.

baseValue​

Property baseValue As %ZEN.Datatype.string;

Optional. Base value for this property. This can contain an actual value (numeric) or the name of a property within the dataSource.