Skip to main content

%DeepSee.Component.Widget.meter

Class %DeepSee.Component.Widget.meter Extends %DeepSee.Component.Widget.widget [ System = 4 ]

A specialized DeepSee Dashboard widget that displays a visual meter (such as a speedometer). There may be multiple meters displayed within the widget, each corresponding to a dataProperty in the widget definition's dataProperty list.

Properties​

meterCount​

Property meterCount As %ZEN.Datatype.integer(XMLPROJECTION = "none") [ Internal ];

Number of meters displayed in this widget (set automatically).

Methods​

%GetCatalogInfo​

ClassMethod %GetCatalogInfo(Output pInfo As %List, Output pSubtypeList As %List) As %Status

Return information used to list this widget within the "widget catalog".

%GetWidgetPropertyInfo​

ClassMethod %GetWidgetPropertyInfo(pSubtype As %String, Output pInfo As %List) As %Status

Return information on additional "properties" supported by this widget for the given subtype.

%OnCreateWidget​

Method %OnCreateWidget(pGroup As %ZEN.Component.group) As %Status

This callback is responsible for creating the contents of the widget.

%SubTypeToClass​

Method %SubTypeToClass(pSubtype As %String) As %String [ Private ]

Translate a subtype into a Meter class name.

adjustContentSize​

ClientMethod adjustContentSize(load, width, height) [ Language = javascript ]

Called when page is loaded or widget is resized.

getDataController​

ClientMethod getDataController() [ Language = javascript ]

If this widget contains a data controller, return it. This allows for generic capabilities in this base class.

getMeter​

ClientMethod getMeter(n) [ Language = javascript ]

Return the given meter object within this widget.

%GetDataController​

Method %GetDataController() As %ZEN.Auxiliary.abstractController

If this widget contains a data controller, return it.

ClientMethod navGetContentForLevel(level, key, value) [ Internal, Language = javascript ]

Return an object describing what to display for this level within the navigator. Invoked from dashboard viewer.

ClientMethod navSelectItem(key, value, which) [ Language = javascript ]

Select of item in navigator.

ClientMethod navHeaderButtonClick(key) [ Language = javascript ]

Click on header button in navigator.

ClientMethod navCloseButtonClick(key) [ Language = javascript ]

Click on close button in navigator.

ClientMethod navDataChange(key, value, final) [ Language = javascript ]

Change of data value in navigator.

hasOverrides​

ClientMethod hasOverrides() [ Language = javascript ]

Test if there are any style overrides for this widget.

resetOverrides​

ClientMethod resetOverrides(themeOnly) [ Language = javascript ]

Reset any style overrides for this widget.

getOverrides​

ClientMethod getOverrides() [ Language = javascript ]

Return an array of current style overrides for this widget. Used to save to a theme.

getMeterCount​

ClientMethod getMeterCount() [ Language = javascript ]

Return the number of meters displayed within this widget.

newDataProperty​

ClientMethod newDataProperty() [ Language = javascript ]

setMeterType​

ClientMethod setMeterType(svg, meter, type) [ Language = javascript ]

Set the type of the given meter.

onSetHighlight​

ClientMethod onSetHighlight(flag) [ Internal, Language = javascript ]

Notification that this widget is selected / unselected.

meterSelected​

ClientMethod meterSelected(meter) [ Internal, Language = javascript ]

Notification that a meter is selected.

exportPDF​

ClientMethod exportPDF(printMultiple, preserveTempFiles) [ Language = javascript ]

PDF export for SVG using the svgImageProvider

%OnCreateControls​

Method %OnCreateControls(pGroup As %ZEN.Component.group) As %Status

This callback is called just before controls are added to the top of the widget. pGroup is the header in which new Zen control can be added.