Class Reference
IRIS for UNIX 2024.1.2
 InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%DeepSee] >  [Component] >  [Widget] >  [meter]
Private  Storage   

class %DeepSee.Component.Widget.meter extends %DeepSee.Component.Widget.widget

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.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
23


Summary

Properties
%condition %definition %import %includeFiles
%page %resource align aux
backgroundColor cellAlign cellSize cellStyle
cellVAlign centerHeader children clickActions
clickActive clickFilterSpec clickTargetProperties clickTargets
colSpan colorToolbar composite containerStyle
controlIndices currFilterSpec currItemNo currSeriesNo
currValue currValueName dataSource disabled
dragEnabled dropEnabled enclosingClass enclosingStyle
error filterDefault filterState filterText
forceToolbar groupClass groupStyle hasInitialFilters
header headerLayout height hidden
hint hintClass hintStyle homeCol
homeRow id imageAppLogo imageAppLogoWidth
imageClose imageCloseHover imageCloseWidth imageContract
imageContractHover imageContractWidth imageExpand imageExpandHover
imageExpandWidth imageMaximize imageMaximizeHover imageMaximizeWidth
imageMinimize imageMinimizeHover imageMinimizeWidth imageResize
imageResizeSize index isClosed label
labelClass labelDisabledClass labelPosition labelStyle
layout linkWidgetKey maximized minWidth
moveEnabled name onafterdrag onbeforedrag
onclick onclosepending ondrag ondrop
onhide onrefresh onresize onshow
onupdate onwindowdrop onwindowgrab opacity
opacityToolbar parent prevHomeCol prevHomeRow
previewMode resizeEnabled rowSpan sessionCookie
settings showLabel showSidebar showToolbar
showToolbarBottomBorder showToolbarOnlyWhenMaximized sidebarContent sidebarWidth
slice subtype title tuple
valign visible widgetKey widgetLayout
width window

Methods
%AddChild %AddChildAfter %AddChildBefore %AddFooter
%AddSidebar %AddToSaveSet %Attr %BindExport
%ClassIsLatestVersion %ClassName %ConstructClone %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %DrawComponentHTML %DrawHTML
%DrawJSStrings %EnclosingDivId %Eval %EvalC
%Extends %FindComponent %ForceClientRender %GetCatalogInfo
%GetChildIndex %GetDataController %GetEventHandlers %GetParameter
%GetWidgetPropertyInfo %GetWidgetSettings %GetXMLName %IsA
%IsModified %MakeId %MakeWidgetId %New
%NormalizeObject %ObjectModified %OnAddToPageAfter %OnAddToPageBefore
%OnCreateControls %OnCreateWidget %OnDrawEnclosingDiv %OnDrawObjectProperties
%OnMutateChildren %OnObjectSynch %OnZENDeserialize %OriginalNamespace
%PackageName %QuoteValue %QuoteValueL10N %RemoveChild
%RemoveChildren %RemoveFromSaveSet %Self %SerializeObject
%SetModified %ValidateObject GetKpiFilterCaption ResolveText
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
abortClose addChild addChildAfter addChildBefore
adjustChildArea adjustContentSize adjustHandleWidth adjustResizeBox
adjustSizes animateIcon applyCSSSettings childrenMutated
close closeWidget compress constrainDragX
constrainDragY controlEventHandler disableCoverplate disableDrag
disableHeaderMaxToggle disableResize dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
enableCoverplate enableDrag enableHeaderMaxToggle enableResize
endDrag expand exportPDF exposeComponent
findComponent findElement fireOnUpdateEvent getChildDiv
getChildIndex getCoverplateDiv getDataController getDefinition
getEnclosingDiv getFilterTableForPrinting getHeaderDiv getHeaderUserDiv
getHidden getHintElement getLabelElement getMeter
getMeterCount getOverrideSkipList getOverrides getProperty
getSVGFrame getSettingDisplayValue getSettingLists getSettings
getState getSubtypeClass getType getWindowHeight
getWindowWidth hasOverrides initializeHomeRowCol invokeSuper
isCompressed isMasterWidget isMaximized isOfType
isResizeInProgress makeId maximize navCloseButtonClick
navDataArrange navDataChange navHeaderButtonClick navPopupAction
navSelectItem newDataProperty onCreate onDelete
onDisplayHandler onEndModalHandler onGrabHandler onPopupAction
onRefreshContents onReleaseHandler onSerialize onStartModalHandler
ondisabledHandler onloadHandler onresizeHandler onunloadHandler
onupdateHandler openWidget printSVGContent processAppMessage
raiseEventHandler refreshContents removeChild removeWindowChrome
render renderContents renderCoverplate renderHeader
renderResize renderSVG resetOverrides resetWindowChrome
resize restoreGeometry restoreState saveGeometry
selectWidget setAppLogo setBodyStyle setCenterLayout
setCloseIcon setContractIcon setExpandIcon setHeaderLayout
setHeaderStyle setHidden setIcon setMaximizeIcon
setMeterType setMinimizeIcon setModifiedIfDragged setOpacity
setOverlayMode setProperty setPropertyAll setToolbarProperty
showBreakdown showDimensions showGeoListing showListing
startDrag startProgressBar stopProgressBar syncObject
updateMenuBar verifyHeaderGeometry


Methods

• classmethod %GetCatalogInfo(Output pInfo As %List, Output pSubtypeList As %List) as %Status
Return information used to list this widget within the "widget catalog".
• method %GetDataController() as %ZEN.Auxiliary.abstractController
If this widget contains a data controller, return it.
• classmethod %GetWidgetPropertyInfo(pSubtype As %String, Output pInfo As %List) as %Status
Return information on additional "properties" supported by this widget for the given subtype.
• 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.
• method %OnCreateWidget(pGroup As %ZEN.Component.group) as %Status
This callback is responsible for creating the contents of the widget.
• method adjustContentSize(load, width, height) [ Language = javascript ]
Called when page is loaded or widget is resized.
• method exportPDF(printMultiple, preserveTempFiles) [ Language = javascript ]
PDF export for SVG using the svgImageProvider
• method getDataController() [ Language = javascript ]
If this widget contains a data controller, return it. This allows for generic capabilities in this base class.
• method getMeter(n) [ Language = javascript ]
Return the given meter object within this widget.
• method getMeterCount() [ Language = javascript ]
Return the number of meters displayed within this widget.
• method getOverrides() [ Language = javascript ]
Return an array of current style overrides for this widget. Used to save to a theme.
• method hasOverrides() [ Language = javascript ]
Test if there are any style overrides for this widget.
• method navCloseButtonClick(key) [ Language = javascript ]
Click on close button in navigator.
• method navDataChange(key, value, final) [ Language = javascript ]
Change of data value in navigator.
• method navHeaderButtonClick(key) [ Language = javascript ]
Click on header button in navigator.
• method navSelectItem(key, value, which) [ Language = javascript ]
Select of item in navigator.
• method newDataProperty() [ Language = javascript ]
• method resetOverrides(themeOnly) [ Language = javascript ]
Reset any style overrides for this widget.
• method setMeterType(svg, meter, type) [ Language = javascript ]
Set the type of the given meter.

Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.