Skip to main content

%DeepSee.Component.SVG.scoreCardColumn

Class %DeepSee.Component.SVG.scoreCardColumn Extends %ZEN.Component.object [ System = 4 ]

Defines characteristics for a column within a %DeepSee.Component.SVG.scoreCard component.

Parameters​

NAMESPACE​

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

Properties​

label​

Property label As %ZEN.Datatype.caption;

Default header label displayed for column.

cellCaption​

Property cellCaption As %ZEN.Datatype.caption;

Caption to display within the cell for this column.

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.
"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.

summaryValue​

Property summaryValue As %ZEN.Datatype.string;

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 =).

width​

Property width As %ZEN.Datatype.length;

Width of column.

align​

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

Alignment of text (and footer) within this column. If not specified, a default alignment is used.

headerAlign​

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

Alignment of header text within this column. If not specified, a default alignment is used.

style​

Property style As %ZEN.Datatype.style;

Style to apply to cells in this column.
This is a CSS style string: e.g., "color: red;" Note that column style overrides row style.

display​

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

Specify what to display in this column.

showAs​

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

Specify how to display values for this column.
If "value" then the value for the column is displayed.
If "conditional" then the value for the column is displayed if the property this columns depends on exists.
If "sum" then the total of all values for the column 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.

format​

Property format As %ZEN.Datatype.string;

Specify how to format a numeric value for this property.

dataValue​

Property dataValue As %ZEN.Datatype.string;

Value used for this column.
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 =).

targetValue​

Property targetValue As %ZEN.Datatype.string;

Optional. Target value for this column. 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.

baseValue​

Property baseValue As %ZEN.Datatype.string;

Optional. Base value for this column. This is used for columns that display values graphically, such as a plotBox. If this is defined, then values are plotted against this base value. Typically this is set to 0 to display negative values as bars in the opposite direction. 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 column. 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 column. 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 column. 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 column. 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.