Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %DeepSee.Component.Widget.pivot
Private  Storage   


class %DeepSee.Component.Widget.pivot extends
%DeepSee.Component.Widget.widget, %ZEN.Auxiliary.ChartContent, %DeepSee.Component.PivotContent

A specialized DeepSee Dashboard widget that displays a pivot table (either as a table or a chart).


Parameters Properties Methods Queries Indices ForeignKeys Triggers
16 50


%condition %definition %import %includeFiles
%page %resource align aux
backgroundColor cellAlign cellSize cellStyle
cellVAlign centerHeader chartToggle 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 label
labelClass labelDisabledClass labelPosition labelStyle
labelsVisible layout legendPosition linkWidgetKey
maximized minWidth moveEnabled name
onafterdrag onbeforedrag onclick onclosepending
ondrag ondrop onhide onrefresh
onresize onshow onupdate onwindowdrop
onwindowgrab opacity opacityToolbar parent
pivotName previewMode resizeEnabled rowSpan
sessionCookie settings showLabel showSidebar
showToolbar showToolbarBottomBorder showToolbarOnlyWhenMaximized sidebarContent
sidebarWidth slice subtype title
tuple valign visible widgetKey
widgetLayout width window

%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 GenerateXSLFO GetKpiFilterCaption
ResolveText XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType abortClose addChild addChildAfter
addChildBefore adjustChildArea adjustContentSize adjustHandleWidth
adjustResizeBox adjustSizes animateIcon applyCSSSettings
cellClickHandler chartClickHandler chartCloseButtonClick chartCreateLength
chartDataArrange chartDataChange chartGetContentForLevel chartHeaderButtonClick
chartParseColorList chartParseLength chartRangeChange chartRenderHandler
chartSetChartType childrenMutated close componentSetDisabled
compress constrainDragX constrainDragY controlEventHandler
disableCoverplate disableDrag disableHeaderMaxToggle disableResize
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
drillHandler dropHandler dropStartHandler enableCoverplate
enableDrag enableHeaderMaxToggle enableResize endDrag
expand exportExcel exportPDF exposeComponent
findComponent findElement fireOnUpdateEvent getChildDiv
getChildIndex getCoverplateDiv getDataController getDefinition
getEnclosingDiv getFilterTableForPrinting getHeaderDiv getHeaderUserDiv
getHidden getHintElement getLabelElement getOverrideSkipList
getOverrides getPivot getProperty getSVGFrame
getSettingDisplayValue getSettingLists getSettings getState
getSubtypeClass getType getWindowHeight getWindowWidth
hasOverrides invokeSuper isCompressed isMasterWidget
isMaximized isOfType isResizeInProgress listingSelectHandler
makeId maximize navCloseButtonClick navDataArrange
navDataChange navHeaderButtonClick navPopupAction navSelectItem
onCreate onDelete onDisplayHandler onEndModalHandler
onGrabHandler onPopupAction onRefreshContents onReleaseHandler
onSerialize onStartModalHandler ondisabledHandler onloadHandler
onresizeHandler onunloadHandler onupdateHandler pivotTableCloseButtonClick
pivotTableDataArrange pivotTableDataChange pivotTableGetContentForLevel pivotTableHeaderButtonClick
printSVGContent processAppMessage raiseEventHandler realCellClickHandler
refreshContents removeChild removeWindowChrome render
renderContents renderCoverplate renderHeader renderResize
renderSVG resetOverrides resetPivot resetWindowChrome
resize restoreGeometry restoreState saveGeometry
selectWidget setAppLogo setBkgOpacity setBodyStyle
setCenterLayout setCloseIcon setContractIcon setExpandIcon
setHeaderLayout setHeaderStyle setHidden setIcon
setMaximizeIcon setMinimizeIcon setOpacity setOverlayMode
setProperty setPropertyAll setToolbarProperty showBreakdown
showDimensions showGeoListing showListing startDrag
startProgressBar stopProgressBar subtypeIsChart syncObject


• property chartToggle as %ZEN.Datatype.string(VALUELIST="table,chart,none",XMLPROJECTION="none") [ InitialExpression = "none" ];
Remember the chartToggle state. If "none", show either a chart or a table. If "chart", show the current chart type initially and a button to toggle. If "table", show the table initially and a button to toggle.
• property labelsVisible as %ZEN.Datatype.boolean(XMLPROJECTION="none");
Remember if chart labels are visible. When the widget is too small, we will hide these.
• property legendPosition as %ZEN.Datatype.string(VALUELIST="top,left,bottom,right,none",XMLPROJECTION="none");
Remember the legend position.
• property pivotName as %ZEN.Datatype.string(XMLPROJECTION="none");
Hold onto the name of the saved pivot (or KPI) that drives this widget.


• 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 GenerateXSLFO(pWidgetID, pUrl, pMode, pFileName="") as %Status [ ZenMethod ]
Create an XSLFO file used for merging many exports into a single report.
• method adjustContentSize(load, width, height) [ Language = javascript ]
Called when page is loaded or widget is resized.
• method cellClickHandler(pivot) [ Language = javascript ]
Cell click handler for pivot table.
• method chartClickHandler(chart) [ Language = javascript ]
Select element handler for pivot chart.
• method chartRangeChange(final) [ Language = javascript ]
Change of time range selector control.
• method chartRenderHandler() [ Language = javascript ]
RenderData handler for pivot chart.
• method componentSetDisabled(componentId, flag) [ Language = javascript ]
This is an API that can be called from a timer to perform a delayed disable/enable of a prticular component. The target component is referenced by componentId and if that component exists in the DOM, the method will call its
• method drillHandler(pivot) [ Language = javascript ]
Drill state change handler for pivot table.
• method exportExcel() [ Language = javascript ]
Export current query to excel
• method exportPDF(printMultiple, preserveTempFiles, filename) [ Language = javascript ]
Export current query to pdf. If we are in chart mode, export the chart.
• method getDataController() [ Language = javascript ]
If this widget contains a data controller, return it.
• method getOverrides() [ Language = javascript ]
Return an array of current style overrides for this widget. Used to save to a theme.
• method getPivot() [ Language = javascript ]
Find the pivot table within this widget.
• method getSubtypeClass() [ Language = javascript ]
Return the actual type used for a widget subtype (such as "barChart").
• method hasOverrides() [ Language = javascript ]
Test if there are any style overrides for this widget.
• method listingSelectHandler(pivot) [ Language = javascript ]
Listing select handler for pivot table.
• 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 navPopupAction(key, value) [ Language = javascript ]
Popup action in navigator.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method realCellClickHandler() [ Language = javascript ]
Cell click handler for pivot table.
• method resetOverrides(themeOnly, recreate) [ Language = javascript ]
Reset any style overrides for this widget.
• method resetPivot() [ Language = javascript ]
Go back to the previous pivot state.
• method setBkgOpacity(opacity) [ Language = javascript ]
• method setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
• method showBreakdown(analysisClass) [ Language = javascript ]
Launch the pivot analysis dialog.
• method showDimensions() [ Language = javascript ]
Perform a showDimensions action, if supported. This toggles the visibility of the dimensions tree control
• method showGeoListing(listing) [ Language = javascript ]
Perform a showGeoListing action.
• method showListing(listing) [ Language = javascript ]
Perform a showListing action, if supported.
• method subtypeIsChart(subtype) [ Language = javascript ]
Test if this pivot widget is a chart