This class defines a how a specific dataProperty is displayed within a user-defined DeepSee dashboard widget. More...

Inheritance diagram for DataProperty:

[legend]

Collaboration diagram for DataProperty:

[legend]

Public Attributes
	align
	Alignment of column within the widget if appropriate. More...

	baseValue
	Optional. More...

	dataValue
	Value used for this property. More...

	display
	Specify what to display for this property. More...

	format
	Specify how to format the value for this property. More...

	label
	Label displayed for this item within the widget. More...

	name
	Identifying name for this dataProperty. More...

	override
	Optional. More...

	rangeLower
	Optional. More...

	rangeUpper
	Optional. More...

	showAs
	Specify how to display values for this property (when displayed in a scoreCard). More...

	style
	Style to apply to this property if appropriate. More...

	subtype
	For some widget types, such as meters, this lets an individual meter override the overall subtype. More...

	summary
	Type of summary to display for this column. More...

	summaryValue
	Value to use for the summary of the column (if <property>summary</property> is "value"). More...

	targetValue
	Optional. More...

	thresholdLower
	Optional. More...

	thresholdUpper
	Optional. More...

	valueColumn
	If true, then this column supplies the logical value used to identify a row. More...

	width
	Width of column within the widget if appropriate. More...

Private Member Functions
_.Library.Status	CopyTo (pTarget)
	Copy contents of this data property to pTarget.

_.Library.Status	CopyToDao (_.Library.DynamicObject pTarget)
	Copy the contents of this definition to an Dao.

_.Library.Status	CopyToDef (_.DeepSee.Dashboard.DataProperty pTarget)
	Copy contents to a structured DataProperty definition.

Additional Inherited Members
Public Member Functions inherited from SwizzleObject
_.Library.Status	OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
	This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. More...

Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...

_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...

_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Member Functions inherited from Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. More...

Static Public Member Functions inherited from SerialObject
_.Library.String	LogicalToOdbc (_.Library.String val)
	Converts the serial state of this serial object to a delimited string. More...

_.Library.String	OdbcToLogical (_.Library.String val)
	Converts the value of an incoming delimited string to a serialized state. More...

Static Public Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...

_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...

_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...

_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...

Static Public Attributes inherited from SerialObject
	ODBCDELIMITER = None
	A serial object is converted to a delimited string containing the. More...

	SERIALDELIMITER = None
	This parameter specifies the delimiter character used when created a serialized. More...

	VALIDIFNULL = None
	If true, ValidateObject will return $$$OK for instances that are null as determined by IsNull(). More...

Static Public Attributes inherited from SwizzleObject
	DEFAULTCONCURRENCY = None
	DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...

	JOURNALSTREAM = None
	If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...

	OBJJOURNAL = None
	if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More...

Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...

	JAVATYPE = None
	The Java type to be used when exported.

	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Static Public Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...

	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...

	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...

	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...

	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...

	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...

	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...

	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...

	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...

	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...

	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...

	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...

	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...

	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...

	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...

	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...

	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...

	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...

	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...

	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Detailed Description

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.

Member Data Documentation

◆ align

align

Alignment of column within the widget if appropriate.

◆ baseValue

baseValue

Optional.

Base value for this property.

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

◆ dataValue

dataValue

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

◆ display

display

Specify what to display for this property.

◆ format

format

Specify how to format the value for this property.

◆ label

label

Label displayed for this item within the widget.

◆ name

name

Identifying name for this dataProperty.

This is used to logically identify it.

◆ override

override

Optional.

Style override for this property.

This is an object state (as JSON) for the client object that visualizes this property.

◆ rangeLower

rangeLower

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

rangeUpper

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.

◆ showAs

showAs

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.

◆ style

style

Style to apply to this property if appropriate.

This is a CSS style string: e.g., "color: red;"

◆ subtype

subtype

For some widget types, such as meters, this lets an individual meter override the overall subtype.

◆ summary

summary

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 <property>summaryValue</property> property.

◆ summaryValue

summaryValue

Value to use for the summary of the column (if <property>summary</property> 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 =).

◆ targetValue

targetValue

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

thresholdLower

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

thresholdUpper

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.

◆ valueColumn

valueColumn

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.

◆ width

width

Width of column within the widget if appropriate.

Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Member Data Documentation

◆ align

◆ baseValue

◆ dataValue

◆ display

◆ format

◆ label

◆ name

◆ override

◆ rangeLower

◆ rangeUpper

◆ showAs

◆ style

◆ subtype

◆ summary

◆ summaryValue

◆ targetValue

◆ thresholdLower

◆ thresholdUpper

◆ valueColumn

◆ width