Class %DeepSee.Component.dataPropertyDefinition

class %DeepSee.Component.dataPropertyDefinition extends %ZEN.Component.object

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.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
1	18

Summary

Properties
%condition	%import	%includeFiles	%page	%resource
align	aux	baseValue	composite	dataValue
display	format	id	index	label
name	onupdate	parent	rangeLower	rangeUpper
showAs	style	subtype	summary	summaryValue
targetValue	thresholdLower	thresholdUpper	tuple	valueColumn
visible	width	window

Methods
%%OIDGet	%AddToSaveSet	%Attr	%BindExport
%ClassIsLatestVersion	%ClassName	%ConstructClone	%DispatchClassMethod
%DispatchGetModified	%DispatchGetProperty	%DispatchMethod	%DispatchSetModified
%DispatchSetMultidimProperty	%DispatchSetProperty	%DrawHTML	%DrawJSStrings
%Eval	%Extends	%ForceClientRender	%GetEventHandlers
%GetParameter	%GetXMLName	%IsA	%IsModified
%MakeId	%New	%NormalizeObject	%ObjectModified
%OnAddToPageAfter	%OnAddToPageBefore	%OnDrawObjectProperties	%OnObjectSynch
%OnZENDeserialize	%OriginalNamespace	%PackageName	%QuoteValue
%QuoteValueL10N	%RemoveFromSaveSet	%Self	%SerializeObject
%SetModified	%ValidateObject	XMLDTD	XMLExport
XMLExportToStream	XMLExportToString	XMLNew	XMLSchema
XMLSchemaNamespace	XMLSchemaType	findElement	fireOnUpdateEvent
getProperty	getSettings	getType	invokeSuper
isOfType	makeId	onCreate	onDelete
onSerialize	onloadHandler	onunloadHandler	onupdateHandler
render	renderContents	renderSVG	setProperty

Parameters

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

This is the XML namespace used for library components.

Properties

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

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

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

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

Specify what to display for this property.

• property format as %ZEN.Datatype.string;

Specify how to format the value for this item.

• property label as %ZEN.Datatype.caption;

Label displayed for this item within the widget.

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

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

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

• property style as %ZEN.Datatype.style;

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

• property subtype as %ZEN.Datatype.string;

Local override of widget subtype (used by meters).

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

• property summaryValue as %ZEN.Datatype.string(VALUELIST=",sum,avg,min,max,value");

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

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

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

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

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

• property width as %ZEN.Datatype.length;

Width of column within the widget if appropriate.


[BASEXML] > [%DeepSee] > [Component] > [dataPropertyDefinition]		Private Storage