dataPropertyDefinition Class Reference

Defines a dataProperty definition within a Dashboard widget definition. More...

Inheritance diagram for dataPropertyDefinition:

Collaboration diagram for dataPropertyDefinition:

Public Attributes
	align
	Alignment of text within a 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 item. More...
	label
	Label displayed for this item within the widget. More...
	rangeLower
	Optional. More...
	rangeUpper
	Optional. More...
	showAs
	Specify how to display values for this property. More...
	style
	Style to apply to this property if appropriate. More...
	subtype
	Local override of widget subtype (used by meters). More...
	summary
	Type of summary to display for this column. More...
	summaryValue
	Value to use for summary (if summary 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...
Public Attributes inherited from object
	aux
	@qualifier final This is an auxiliary property that is provided More...
	composite
	@qualifier final For components that are created as part of a composite component, More...
	id
	@qualifier final This is a unique identifier that is used to distinguish this object More...
	index
	@qualifier final System-assigned index number used internally to identify this component. More...
	name
	@qualifier final Name of this object. More...
	onupdate
	onupdate event handler: More...
	parent
	@qualifier final Link to the component that contains this object More...
	tuple
	@qualifier final Special property indicating which tuple of a More...
	visible
	This property indicates whether a component is visible and thus layed out. More...
	window
	@qualifier final This is a client-only property that refers to the JavaScript More...

Additional Inherited Members
Public Member Functions inherited from object
_.Library.Status	OnNew (_.Library.RawString initvalue)
	Constructor for Zen objects. More...
	findElement (subid)
	Client-side utility method that finds an HTML element with a. More...
	fireOnUpdateEvent ()
	This is called when an object is updated from the server. More...
_.Library.String	getProperty (property, key)
	Return the value of a named property (i.e. More...
	getSettings (settings)
	Client-side method that returns a list of this component's. More...
	getType ()
	Returns the component type of this object. More...
	invokeSuper (method, args)
	Invoke the superclass method method of the current. More...
	isOfType (type)
	Returns true if this object is of the given component type. More...
	makeId (subid)
	client-side utility method that constructs a component-specific id More...
	onCreate ()
	This client method, if present, is called when this component is. More...
	onDelete ()
	This client method, if present, is called when this component is. More...
	onSerialize ()
	This client event, if present, is fired before a component. More...
	onloadHandler ()
	This client event, if present, is fired when the page is loaded.
	onunloadHandler ()
	This client event, if present, is fired when the page is unloaded. More...
	onupdateHandler ()
	This client method, if present, is fired when the object is updated from the server.
	render ()
	This causes a component that draws its contents dynamically. More...
	renderContents ()
	This method, if present, is called when this component. More...
	renderSVG (document, parent)
	This method is only needed for SVG components. More...
	setProperty (property, value, value2)
	Set the value of a named property (i.e., a setting). 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 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 object
	DEFAULTVISIBLE = None
	Subclasses can set this to change default visibilty for a component.
	INCLUDEFILES = None
	CSV list of additional include files (either .js or .css) that. More...
	MODULE = None
	If set, this indicates that this system component should be. More...
	NAMESPACE = None
	This is the XML namespace used for library components.
	POSTCOMPILEACTIONS = None
	This is a comma-delimited list of which post-compile actions this component. More...
	USECOMMONDIRECTORY = None
	If true, then the include files generated for this component, are placed in the. More...
	XMLFORMAT = None
	If XMLFORMAT="Literal", then only support for literal format import and export is generated. More...
	XMLIGNOREINVALIDATTRIBUTE = None
	By setting this to 0, we disallow use of invalid attribute names in Zen XML documents.
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

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.

Member Data Documentation

align

align

Alignment of text within a column within the widget if appropriate.

If not specified, a default alignment is used.  

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.  

display

display

Specify what to display for this property.

 

format

format

Specify how to format the value for this item.

 

label

label

Label displayed for this item within the widget.

 

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.

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.
 

style

style

Style to apply to this property if appropriate.

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

subtype

subtype

Local override of widget subtype (used by meters).

 

summary

summary

Type of summary to display for this column.

If "", then no summary is displayed.  

summaryValue

summaryValue

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

 

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.