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

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

A specialized DeepSee Dashboard widget that displays a worksheet.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
21


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 GetWorksheetContent
ResolveText XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType abortClose addChild addChildAfter
addChildBefore adjustChildArea adjustContentSize adjustHandleWidth
adjustResizeBox adjustSizes animateIcon applyCSSSettings
applyFilter applyModelToGrid 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 getCellOverride getChildDiv
getChildIndex getColumnDescriptors getCoverplateDiv getData
getDataByName getDataController getDefinition getDimSize
getEnclosingDiv getFilterTableForPrinting getGrid getHeaderDiv
getHeaderUserDiv getHidden getHintElement getLabel
getLabelElement getModel getOverrideSkipList getOverrides
getProperty getPropertyName getRowDescriptors 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
notifyController 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 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".
• 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.
• classmethod GetWorksheetContent(ByRef pParameters, Output pObject As %RegisteredObject) as %Status
Get content object for JSON provider.
• method adjustContentSize(load, width, height) [ Language = javascript ]
Called when page is loaded or widget is resized.
• method applyFilter(name, value) [ Language = javascript ]
Apply the given filter to this widget.
• method applyModelToGrid() [ Language = javascript ]
Apply saved attributes to the grid component.
• method exportPDF() [ Language = javascript ]
Export to pdf.
• method getCellOverride(row, col) [ Language = javascript ]
Get cell override.
• method getColumnDescriptors() [ Language = javascript ]
Return an array of column descriptors (or null).
• method getData(d1, d2, d3) [ Language = javascript ]
dataSet API Return the data contained in the specified location. Location is 0-based;
• method getDataByName(prop, series) [ Language = javascript ]
dataBag API Get a data value, by property name, from this dataController.
• method getDimSize(dim) [ Language = javascript ]
Controller API
• method getGrid() [ Language = javascript ]
Get the grid control.
• method getLabel(n, dim) [ Language = javascript ]
dataSet API Get the label at position n (0-based) in the given dimension (1,2, or 3).
• method getModel() [ Language = javascript ]
Get the json-supplied data model.
• method getPropertyName(n) [ Language = javascript ]
Given a 0-based index, return the corresponding property name.
• method getRowDescriptors() [ Language = javascript ]
Return an array of row descriptors (or null).
• method notifyController(source, reason, prop, value, row) [ Language = javascript ]
Notification from the dataGrid.

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