Skip to main content


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).

Property Inventory

Method Inventory


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 methods: chartToggleDisplayToLogical(), chartToggleGet(), chartToggleIsValid(), chartToggleLogicalToDisplay(), chartToggleLogicalToOdbc(), chartToggleNormalize(), chartToggleSet()
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 methods: labelsVisibleDisplayToLogical(), labelsVisibleGet(), labelsVisibleIsValid(), labelsVisibleLogicalToDisplay(), labelsVisibleLogicalToOdbc(), labelsVisibleLogicalToXSD(), labelsVisibleNormalize(), labelsVisibleSet(), labelsVisibleXSDToLogical()
property legendPosition as %ZEN.Datatype.string (VALUELIST = "top,left,bottom,right,none", XMLPROJECTION = "none");
Remember the legend position.
Property methods: legendPositionDisplayToLogical(), legendPositionGet(), legendPositionIsValid(), legendPositionLogicalToDisplay(), legendPositionLogicalToOdbc(), legendPositionNormalize(), legendPositionSet()
property pivotName as %ZEN.Datatype.string (XMLPROJECTION = "none");
Hold onto the name of the saved pivot (or KPI) that drives this widget.
Property methods: pivotNameDisplayToLogical(), pivotNameGet(), pivotNameIsValid(), pivotNameLogicalToDisplay(), pivotNameLogicalToOdbc(), pivotNameNormalize(), pivotNameSet()


method %CreateExportDropdown(id, enabled, imgId, help, options) as %String
Get html to create an icon with an Excel/CSV dropdown menu.
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 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 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.
clientmethod adjustContentSize(load, width, height) [ Language = javascript ]
Called when page is loaded or widget is resized.
clientmethod cellClickHandler(pivot) [ Language = javascript ]
Cell click handler for pivot table.
clientmethod chartClickHandler(chart) [ Language = javascript ]
Select element handler for pivot chart.
clientmethod chartRangeChange(final) [ Language = javascript ]
Change of time range selector control.
clientmethod chartRenderHandler() [ Language = javascript ]
RenderData handler for pivot chart.
clientmethod closeExportMenu(menuId) [ Language = javascript ]
Close the Excel/CSV export menu and remove the mouse trap.This does nothing if the target menu is not open.
clientmethod 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
clientmethod drillHandler(pivot) [ Language = javascript ]
Drill state change handler for pivot table.
clientmethod exportCSV(simple) [ Language = javascript ]
Export current query to a CSV file
clientmethod exportExcel() [ Language = javascript ]
Export current query to excel
clientmethod exportPDF(printMultiple, preserveTempFiles, filename) [ Language = javascript ]
Export current query to pdf. If we are in chart mode, export the chart.
clientmethod getDataController() [ Language = javascript ]
If this widget contains a data controller, return it.
clientmethod getOverrides() [ Language = javascript ]
Return an array of current style overrides for this widget. Used to save to a theme.
clientmethod getPivot() [ Language = javascript ]
Find the pivot table within this widget.
clientmethod getSubtypeClass() [ Language = javascript ]
Return the actual type used for a widget subtype (such as "barChart").
clientmethod hasOverrides() [ Language = javascript ]
Test if there are any style overrides for this widget.
clientmethod listingSelectHandler(pivot) [ Language = javascript ]
Listing select handler for pivot table.
Click on close button in navigator.
Change of data value in navigator.
Click on header button in navigator.
Popup action in navigator.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod realCellClickHandler() [ Language = javascript ]
Cell click handler for pivot table.
clientmethod resetOverrides(themeOnly, recreate) [ Language = javascript ]
Reset any style overrides for this widget.
clientmethod resetPivot() [ Language = javascript ]
Go back to the previous pivot state.
clientmethod setBkgOpacity(opacity) [ Language = javascript ]
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
clientmethod showBreakdown(analysisClass) [ Language = javascript ]
Launch the pivot analysis dialog.
clientmethod showDimensions() [ Language = javascript ]
Perform a showDimensions action, if supported. This toggles the visibility of the dimensions tree control
clientmethod showGeoListing(listing) [ Language = javascript ]
Perform a showGeoListing action.
clientmethod showListing(listing) [ Language = javascript ]
Perform a showListing action, if supported.
clientmethod subtypeIsChart(subtype) [ Language = javascript ]
Test if this pivot widget is a chart
clientmethod toggleExportMenu(menuId) [ Language = javascript ]
Toggle the state of the target Excel/CSV export menu dropdown. When causing the menu to be displayed, the zenMouseTrap is also activated behind the menu to prevent other interactions.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab