This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %ZEN.SVGComponent.speedometer

%ZEN.SVGComponent.speedometer

class %ZEN.SVGComponent.speedometer extends %ZEN.SVGComponent.meter

SVG speedometer meter.
This displays a value within a representation of a speedometer.
Note: to get the older look of this component, set the stylized true.

Property Inventory (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

property highLampColor as %ZEN.Datatype.color [ InitialExpression = "url(#glow-red)" ];
Fill color used for high indicator lamp.
Property methods: highLampColorDisplayToLogical(), highLampColorGet(), highLampColorIsValid(), highLampColorLogicalToDisplay(), highLampColorLogicalToOdbc(), highLampColorNormalize(), highLampColorSet()
property highRangeStyle as %ZEN.Datatype.style;
Optional. Style applied to scale ring values above the low threshold value. This only applies to non-stylized views.
Property methods: highRangeStyleDisplayToLogical(), highRangeStyleGet(), highRangeStyleIsValid(), highRangeStyleLogicalToDisplay(), highRangeStyleLogicalToOdbc(), highRangeStyleNormalize(), highRangeStyleSet()
property independentOdometer as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, the odometer will show an independent value; if false, the odometer will show the same value as the needle.
Property methods: independentOdometerDisplayToLogical(), independentOdometerGet(), independentOdometerIsValid(), independentOdometerLogicalToDisplay(), independentOdometerLogicalToOdbc(), independentOdometerLogicalToXSD(), independentOdometerNormalize(), independentOdometerSet(), independentOdometerXSDToLogical()
property innerCircleStyle as %ZEN.Datatype.style;
Optional. Style applied to inner region.
Property methods: innerCircleStyleDisplayToLogical(), innerCircleStyleGet(), innerCircleStyleIsValid(), innerCircleStyleLogicalToDisplay(), innerCircleStyleLogicalToOdbc(), innerCircleStyleNormalize(), innerCircleStyleSet()
Text for logo displayed in center of dial (for stylized display only).
Property methods: logoDisplayToLogical(), logoGet(), logoIsValid(), logoLogicalToDisplay(), logoLogicalToOdbc(), logoNormalize(), logoSet()
property lowLampColor as %ZEN.Datatype.color [ InitialExpression = "url(#glow-red)" ];
Fill color used for low indicator lamp.
Property methods: lowLampColorDisplayToLogical(), lowLampColorGet(), lowLampColorIsValid(), lowLampColorLogicalToDisplay(), lowLampColorLogicalToOdbc(), lowLampColorNormalize(), lowLampColorSet()
property lowRangeStyle as %ZEN.Datatype.style;
Optional. Style applied to scale ring values below the low threshold value. This only applies to non-stylized views.
Property methods: lowRangeStyleDisplayToLogical(), lowRangeStyleGet(), lowRangeStyleIsValid(), lowRangeStyleLogicalToDisplay(), lowRangeStyleLogicalToOdbc(), lowRangeStyleNormalize(), lowRangeStyleSet()
property midCircleStyle as %ZEN.Datatype.style;
Optional. Style applied to mid-region circle (where tick marks appear in non-stylized view). This is beneath the "ring".
Property methods: midCircleStyleDisplayToLogical(), midCircleStyleGet(), midCircleStyleIsValid(), midCircleStyleLogicalToDisplay(), midCircleStyleLogicalToOdbc(), midCircleStyleNormalize(), midCircleStyleSet()
property needleStyle as %ZEN.Datatype.style;
Optional. Style applied to needle.
Property methods: needleStyleDisplayToLogical(), needleStyleGet(), needleStyleIsValid(), needleStyleLogicalToDisplay(), needleStyleLogicalToOdbc(), needleStyleNormalize(), needleStyleSet()
property nubStyle as %ZEN.Datatype.style;
Optional. Style applied to nub (circle over center of needle).
Property methods: nubStyleDisplayToLogical(), nubStyleGet(), nubStyleIsValid(), nubStyleLogicalToDisplay(), nubStyleLogicalToOdbc(), nubStyleNormalize(), nubStyleSet()
property odometerBoxStyle as %ZEN.Datatype.style;
Optional. Style applied to odometer box.
Property methods: odometerBoxStyleDisplayToLogical(), odometerBoxStyleGet(), odometerBoxStyleIsValid(), odometerBoxStyleLogicalToDisplay(), odometerBoxStyleLogicalToOdbc(), odometerBoxStyleNormalize(), odometerBoxStyleSet()
property odometerFormat as %ZEN.Datatype.string;
Numeric format string to apply to the odometer value.
Property methods: odometerFormatDisplayToLogical(), odometerFormatGet(), odometerFormatIsValid(), odometerFormatLogicalToDisplay(), odometerFormatLogicalToOdbc(), odometerFormatNormalize(), odometerFormatSet()
property odometerTextStyle as %ZEN.Datatype.style;
Optional. Style applied to odometer value.
Property methods: odometerTextStyleDisplayToLogical(), odometerTextStyleGet(), odometerTextStyleIsValid(), odometerTextStyleLogicalToDisplay(), odometerTextStyleLogicalToOdbc(), odometerTextStyleNormalize(), odometerTextStyleSet()
property odometerValue as %ZEN.Datatype.string;
If independentOdometer is true, then this is the value displayed in the odometer.
Property methods: odometerValueDisplayToLogical(), odometerValueGet(), odometerValueIsValid(), odometerValueLogicalToDisplay(), odometerValueLogicalToOdbc(), odometerValueNormalize(), odometerValueSet()
property outerCircleStyle as %ZEN.Datatype.style;
Optional. Style applied to outer region.
Property methods: outerCircleStyleDisplayToLogical(), outerCircleStyleGet(), outerCircleStyleIsValid(), outerCircleStyleLogicalToDisplay(), outerCircleStyleLogicalToOdbc(), outerCircleStyleNormalize(), outerCircleStyleSet()
property ringStyle as %ZEN.Datatype.style;
Optional. Style applied to mid-region ring (where tick marks appear in non-stylized view).
Property methods: ringStyleDisplayToLogical(), ringStyleGet(), ringStyleIsValid(), ringStyleLogicalToDisplay(), ringStyleLogicalToOdbc(), ringStyleNormalize(), ringStyleSet()
property separatorStyle as %ZEN.Datatype.style;
Optional. Style applied to lines between value labels.
Property methods: separatorStyleDisplayToLogical(), separatorStyleGet(), separatorStyleIsValid(), separatorStyleLogicalToDisplay(), separatorStyleLogicalToOdbc(), separatorStyleNormalize(), separatorStyleSet()
property stylized as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, render a stylized speedometer (the classic Zen visualization); if false, render a more baroque speedometer (the classic DeepSee visualization);
Property methods: stylizedDisplayToLogical(), stylizedGet(), stylizedIsValid(), stylizedLogicalToDisplay(), stylizedLogicalToOdbc(), stylizedLogicalToXSD(), stylizedNormalize(), stylizedSet(), stylizedXSDToLogical()
property thinNeedle as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, render a thin needle, otherwise use a wider needle.
Property methods: thinNeedleDisplayToLogical(), thinNeedleGet(), thinNeedleIsValid(), thinNeedleLogicalToDisplay(), thinNeedleLogicalToOdbc(), thinNeedleLogicalToXSD(), thinNeedleNormalize(), thinNeedleSet(), thinNeedleXSDToLogical()
property valueLabelStyle as %ZEN.Datatype.style;
Optional. Style applied to value labels.
Property methods: valueLabelStyleDisplayToLogical(), valueLabelStyleGet(), valueLabelStyleIsValid(), valueLabelStyleLogicalToDisplay(), valueLabelStyleLogicalToOdbc(), valueLabelStyleNormalize(), valueLabelStyleSet()

Methods (Including Private)

clientmethod getNumericAbbreviation(val, min, max) [ Language = javascript ]
Return a numeric abbreviation for a value. min and max are range that value falls within. E.g., 10K for 10000
clientmethod renderMeter() [ Language = javascript ]
Render the inner SVG contents of this component.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
clientmethod updateNeedle(animate) [ Language = javascript ]
Internal method: update position of needle

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window