Home > Class Reference > ENSLIB namespace > %DeepSee.Component.Widget.pivot

%DeepSee.Component.Widget.pivot

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 (Including Private)

Method Inventory (Including Private)

Properties (Including Private)

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

Methods (Including Private)

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.
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 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
setDisabled(flag)
clientmethod drillHandler(pivot) [ Language = javascript ]
Drill state change handler for pivot table.
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 ]