%ZEN.SVGComponent.meter

abstract class %ZEN.SVGComponent.meter extends %ZEN.SVGComponent.svgComponent, %ZEN.Component.dataView

Base class for SVG meter components.
A meter is analogous to a control: it has a value as well as upper and lower ranges and thresholds. The display of the value is implemented by subclasses.

Property Inventory

Method Inventory

Parameters

parameter DEFAULTVIEWBOXHEIGHT = 100;
Default viewBoxHeight of this component. This is set to 100 to provide a fixed coordinate system for meters.
parameter DEFAULTVIEWBOXWIDTH = 100;
Default viewBoxWidth of this component. This is set to 100 to provide a default, fixed coordinate system for meters.

Properties

property animate as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If this meter supports animation, then this controls whether the animation is on or off.
Property methods: animateDisplayToLogical(), animateGet(), animateIsValid(), animateLogicalToDisplay(), animateLogicalToOdbc(), animateLogicalToXSD(), animateNormalize(), animateSet(), animateXSDToLogical()
property dataBinding as %ZEN.Datatype.string;
Optional. If this meter is associated with a %ZEN.Auxiliary.dataController, this specifies the name of the property within the dataController that will provide the value for this control.
Property methods: dataBindingDisplayToLogical(), dataBindingGet(), dataBindingIsValid(), dataBindingLogicalToDisplay(), dataBindingLogicalToOdbc(), dataBindingNormalize(), dataBindingSet()
property disabled as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, disable this meter.
Property methods: disabledDisplayToLogical(), disabledGet(), disabledIsValid(), disabledLogicalToDisplay(), disabledLogicalToOdbc(), disabledLogicalToXSD(), disabledNormalize(), disabledSet(), disabledXSDToLogical()
property label as %ZEN.Datatype.caption;
Label displayed by the meter.
Property methods: labelDisplayToLogical(), labelGet(), labelIsValid(), labelLogicalToDisplay(), labelLogicalToOdbc(), labelNormalize(), labelSet(), labelStyleDisplayToLogical(), labelStyleGet(), labelStyleIsValid(), labelStyleLogicalToDisplay(), labelStyleLogicalToOdbc(), labelStyleNormalize(), labelStyleSet()
property labelStyle as %ZEN.Datatype.svgStyle;
Optional: CSS style applied to the meter label.
Property methods: labelStyleDisplayToLogical(), labelStyleGet(), labelStyleIsValid(), labelStyleLogicalToDisplay(), labelStyleLogicalToOdbc(), labelStyleNormalize(), labelStyleSet()
property onchange as %ZEN.Datatype.eventHandler;
onchange event handler: For meters that allow user actions to modify their value, this event handler is called when the user changes the value of the slider.
Property methods: onchangeDisplayToLogical(), onchangeGet(), onchangeHandler(), onchangeIsValid(), onchangeLogicalToDisplay(), onchangeLogicalToOdbc(), onchangeNormalize(), onchangeSet()
property rangeLower as %ZEN.Datatype.string;
Represents the lower value of the meter range. If this value is numeric, then it is used as the value. If it is a string, then it is used as the name of a property within the data source connected to this meter.
Property methods: rangeLowerDisplayToLogical(), rangeLowerGet(), rangeLowerIsValid(), rangeLowerLogicalToDisplay(), rangeLowerLogicalToOdbc(), rangeLowerNormalize(), rangeLowerSet()
property rangeUpper as %ZEN.Datatype.string;
Represents the upper value of the meter range. If this value is numeric, then it is used as the value. If it is a string, then it is used as the name of a property within the data source connected to this meter.
Property methods: rangeUpperDisplayToLogical(), rangeUpperGet(), rangeUpperIsValid(), rangeUpperLogicalToDisplay(), rangeUpperLogicalToOdbc(), rangeUpperNormalize(), rangeUpperSet()
property scaleFactor as %ZEN.Datatype.float [ InitialExpression = 1 ];
The displayed value is determined by multiplying the actual value and this scaling factor.
Property methods: scaleFactorDisplayToLogical(), scaleFactorGet(), scaleFactorIsValid(), scaleFactorLogicalToDisplay(), scaleFactorLogicalToOdbc(), scaleFactorNormalize(), scaleFactorSet()
property showConditionally as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, hide this meter if it is bound to a non-existant data property.
Property methods: showConditionallyDisplayToLogical(), showConditionallyGet(), showConditionallyIsValid(), showConditionallyLogicalToDisplay(), showConditionallyLogicalToOdbc(), showConditionallyLogicalToXSD(), showConditionallyNormalize(), showConditionallySet(), showConditionallyXSDToLogical()
property targetValue as %ZEN.Datatype.string;
If defined, this is the target value for the meter. If this value is numeric, then it is used as the target value. If it is a string, then it is used as the name of a property within the data source connected to this meter.
Certain meters may display this value.
Property methods: targetValueDisplayToLogical(), targetValueGet(), targetValueIsValid(), targetValueLogicalToDisplay(), targetValueLogicalToOdbc(), targetValueNormalize(), targetValueSet()
property thresholdLower as %ZEN.Datatype.string;
Represents the lower threshold level for the meter. If this value is numeric, then it is used as the value. If it is a string, then it is used as the name of a property within the data source connected to this meter.
Property methods: thresholdLowerDisplayToLogical(), thresholdLowerGet(), thresholdLowerIsValid(), thresholdLowerLogicalToDisplay(), thresholdLowerLogicalToOdbc(), thresholdLowerNormalize(), thresholdLowerSet()
property thresholdUpper as %ZEN.Datatype.string;
Represents the upper threshold level for the meter. If this value is numeric, then it is used as the value. If it is a string, then it is used as the name of a property within the data source connected to this meter.
Property methods: thresholdUpperDisplayToLogical(), thresholdUpperGet(), thresholdUpperIsValid(), thresholdUpperLogicalToDisplay(), thresholdUpperLogicalToOdbc(), thresholdUpperNormalize(), thresholdUpperSet()
property value as %ZEN.Datatype.string [ InitialExpression = 0 ];
Current value of the meter.
Property methods: valueDisplayToLogical(), valueGet(), valueIsValid(), valueLogicalToDisplay(), valueLogicalToOdbc(), valueNormalize(), valueSet()

Methods

clientmethod acquireData() [ Language = javascript ]
Acquire data for this meter.
If the meter is connected to a dataController, then set the value of the meter to the current value of the dataController property specified by dataBinding.
clientmethod getLabelText() [ Language = javascript ]
Return the resolved label to display for this meter.
clientmethod getValue() [ Language = javascript ]
Short-cut method to get the current value of this meter.
clientmethod notifyViewHandler(reason, data1, data2, data3) [ Language = javascript ]
Notification that the dataController associated with this dataView has raised an event.
clientmethod onchangeHandler() [ Language = javascript ]
This built-in event handler is called by meters that allow user interaction. It raises notification that the meter's value has changed.
final clientmethod renderContents() [ Language = javascript ]
Render the inner SVG contents of this component.
clientmethod renderLabel(x, y) [ Language = javascript ]
Create the label displayed by this meter. Subclasses should call this from their render()x and y specify the midpoint of the label.
clientmethod renderMeter() [ Language = javascript ]
Render the inner SVG contents of this component. Subclasses should implement this method.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
clientmethod setValue(value) [ Language = javascript ]
Short-cut method to set the current value of this meter.

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

FeedbackOpens in a new window