Skip to main content

%DeepSee.Component.Widget.pivot

Class %DeepSee.Component.Widget.pivot Extends (%DeepSee.Component.Widget.widget, %ZEN.Auxiliary.ChartContent, %DeepSee.Component.PivotContent) [ System = 4 ]

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

Properties​

pivotName​

Property pivotName As %ZEN.Datatype.string(XMLPROJECTION = "none");

Hold onto the name of the saved pivot (or KPI) that drives this widget.

legendPosition​

Property legendPosition As %ZEN.Datatype.string(VALUELIST = "top,left,bottom,right,none", XMLPROJECTION = "none");

Remember the legend position.

labelsVisible​

Property labelsVisible As %ZEN.Datatype.boolean(XMLPROJECTION = "none");

Remember if chart labels are visible. When the widget is too small, we will hide these.

chartToggle​

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.

viewType​

Property viewType As %ZEN.Datatype.string(XMLPROJECTION = "none") [ InitialExpression = "pivot", Internal ];

Indicates the current display of the widget: "pivot" or "listing".

pivotView​

Property pivotView As %ZEN.Datatype.string(XMLPROJECTION = "none") [ InitialExpression = "table", Internal ];

When pivot is displayed, indicates how it should be displayed: "table" or "chart".

listingView​

Property listingView As %ZEN.Datatype.string(XMLPROJECTION = "none") [ InitialExpression = "table", Internal ];

When listing is displayed, indicates how it should be displayed: "table" or "map".

hasDimTree​

Property hasDimTree As %ZEN.Datatype.boolean(XMLPROJECTION = "none") [ InitialExpression = 1, Internal ];

When true, there is a dimension tree on this widget.

showDimTree​

Property showDimTree As %ZEN.Datatype.boolean(XMLPROJECTION = "none") [ InitialExpression = 0, Internal ];

If there is a dimension tree, this indicates if it is visible.

themeChartProperties​

Property themeChartProperties As %ZEN.Datatype.string(XMLPROJECTION = "none") [ InitialExpression = "backgroundStyle,plotAreaStyle,plotEdgeStyle,titleAlign,titleStyle,subtitleStyle,titleBoxStyle,borderStyle,stripesVisible,stripeStyle,seriesColorsOverride,seriesColorScheme,gridStyle,labelStyle,maxLabelLen,axisTitleStyle,valueLabelStyle,valueBoxStyle,plotStyle,lineStyle,markerStyle", Internal ];

List of chart properties that are saved to a theme.

dataColors​

Property dataColors As array Of %ZEN.Datatype.string(XMLPROJECTION = "none") [ Internal ];

Array of "data-based" colors keyed by name. Loaded from termlist.

hasDataColors​

Property hasDataColors As %ZEN.Datatype.boolean(XMLPROJECTION = "none") [ Internal ];

origChartTitle​

Property origChartTitle As %ZEN.Datatype.string(XMLPROJECTION = "none") [ Internal ];

Original value for chart title (before localization is applied).

origChartSubtitle​

Property origChartSubtitle As %ZEN.Datatype.string(XMLPROJECTION = "none") [ Internal ];

Original value for chart subtitle (before localization is applied).

origChartXAxisTitle​

Property origChartXAxisTitle As %ZEN.Datatype.string(XMLPROJECTION = "none") [ Internal ];

Original value for chart xAxis title (before localization is applied).

origChartYAxisTitles​

Property origChartYAxisTitles As list Of %ZEN.Datatype.string(XMLPROJECTION = "none") [ Internal ];

Original values for chart yAxis titles (before localization is applied).

Methods​

%GetCatalogInfo​

ClassMethod %GetCatalogInfo(Output pInfo As %List, Output pSubtypeList As %List) As %Status

Return information used to list this widget within the "widget catalog".

%GetWidgetPropertyInfo​

ClassMethod %GetWidgetPropertyInfo(pSubtype As %String, Output pInfo As %List) As %Status

Return information on additional "properties" supported by this widget for the given subtype.

%OnCreateControls​

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.

%CreateExportDropdown​

Method %CreateExportDropdown(id, enabled, imgId, help, options) As %String

Get html to create an icon with an Excel/CSV dropdown menu.

toggleExportMenu​

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.

closeExportMenu​

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.

%OnCreateWidget​

Method %OnCreateWidget(pGroup As %ZEN.Component.group) As %Status

This callback is responsible for creating the contents of the widget.

%LoadPivotInfo​

Method %LoadPivotInfo(pPivotName As %String, pPivotTable As %DeepSee.Component.pivotTable, pOverrideString As %String = "") As %Status [ Internal ]

Load the saved pivot information into the pivot table.

adjustContentSize​

ClientMethod adjustContentSize(load, width, height) [ Language = javascript ]

Called when page is loaded or widget is resized.

showListing​

ClientMethod showListing(listing) [ Language = javascript ]

Perform a showListing action, if supported.

showGeoListing​

ClientMethod showGeoListing(listing) [ Language = javascript ]

Perform a showGeoListing action.

showDimensions​

ClientMethod showDimensions() [ Language = javascript ]

Perform a showDimensions action, if supported. This toggles the visibility of the dimensions tree control

showBreakdown​

ClientMethod showBreakdown(analysisClass) [ Language = javascript ]

Launch the pivot analysis dialog.

getDataController​

ClientMethod getDataController() [ Language = javascript ]

If this widget contains a data controller, return it.

%GetDataController​

Method %GetDataController() As %ZEN.Auxiliary.abstractController

If this widget contains a data controller, return it.

chartClickHandler​

ClientMethod chartClickHandler(chart) [ Language = javascript ]

Select element handler for pivot chart.

drillHandler​

ClientMethod drillHandler(pivot) [ Language = javascript ]

Drill state change handler for pivot table.

listingSelectHandler​

ClientMethod listingSelectHandler(pivot) [ Language = javascript ]

Listing select handler for pivot table.

cellClickHandler​

ClientMethod cellClickHandler(pivot) [ Language = javascript ]

Cell click handler for pivot table.

realCellClickHandler​

ClientMethod realCellClickHandler() [ Language = javascript ]

Cell click handler for pivot table.

updateControlState​

ClientMethod updateControlState() [ Internal, Language = javascript ]

Update the display current controls for this widget.

toggleChart​

ClientMethod toggleChart() [ Internal, Language = javascript ]

Toggle between chart and table view.

exportExcel​

ClientMethod exportExcel() [ Language = javascript ]

Export current query to excel

exportCSV​

ClientMethod exportCSV(simple) [ Language = javascript ]

Export current query to a CSV file

exportPDF​

ClientMethod exportPDF(printMultiple, preserveTempFiles, filename) [ Language = javascript ]

Export current query to pdf. If we are in chart mode, export the chart.

GenerateXSLFO​

Method GenerateXSLFO(pWidgetID, pUrl, pMode, pFileName = "") As %Status [ ZenMethod ]

Create an XSLFO file used for merging many exports into a single report.

applySetting​

ClientMethod applySetting(action, value) [ Internal, Language = javascript ]

Apply the given setting value to this widget.

changeChartType​

ClientMethod changeChartType(value) [ Internal, Language = javascript ]

getParameterValue​

ClientMethod getParameterValue(parm) [ Internal, Language = javascript ]

Find the value of the given parameter value.

getPivotVariableState​

ClientMethod getPivotVariableState(delim1, delim2) [ Internal, Language = javascript ]

Return the current state of filters for this widget as one serialized string.

markerClicked​

ClientMethod markerClicked(marker) [ Internal, Language = javascript ]

Called when user clicks on a marker in a geolisting.

onApplyFilters​

ClientMethod onApplyFilters(refresh) [ Internal, Language = javascript ]

Notification to subclasses that filter has changed.

resetPivot​

ClientMethod resetPivot() [ Language = javascript ]

Go back to the previous pivot state.

ClientMethod navGetContentForLevel(level, key, value) [ Internal, Language = javascript ]

Return an object describing what to display for this level within the navigator. Invoked from dashboard viewer.

ClientMethod navHeaderButtonClick(key) [ Language = javascript ]

Click on header button in navigator.

ClientMethod navCloseButtonClick(key) [ Language = javascript ]

Click on close button in navigator.

ClientMethod navPopupAction(key, value) [ Language = javascript ]

Popup action in navigator.

ClientMethod navDataChange(key, value, final) [ Language = javascript ]

Change of data value in navigator.

hasOverrides​

ClientMethod hasOverrides() [ Language = javascript ]

Test if there are any style overrides for this widget.

resetOverrides​

ClientMethod resetOverrides(themeOnly, recreate) [ Language = javascript ]

Reset any style overrides for this widget.

getOverrides​

ClientMethod getOverrides() [ Language = javascript ]

Return an array of current style overrides for this widget. Used to save to a theme.

getSubtypeClass​

ClientMethod getSubtypeClass() [ Language = javascript ]

Return the actual type used for a widget subtype (such as "barChart").

chartRangeChange​

ClientMethod chartRangeChange(final) [ Language = javascript ]

Change of time range selector control.

getPivot​

ClientMethod getPivot() [ Language = javascript ]

Find the pivot table within this widget.

chartGetSeriesColor​

ClientMethod chartGetSeriesColor(series) [ Internal, Language = javascript ]

ongetSeriesColor handler for pivot chart.

chartGetSeriesColorsAsString​

ClientMethod chartGetSeriesColorsAsString(chart) [ Internal, Language = javascript ]

ongetSeriesColor handler for pivot chart.

chartRenderHandler​

ClientMethod chartRenderHandler() [ Language = javascript ]

RenderData handler for pivot chart.

executeDrillDown​

ClientMethod executeDrillDown(dataSource) [ Internal, Language = javascript ]

Perform a local drill down for a target widget.

executeDrillUp​

ClientMethod executeDrillUp() [ Internal, Language = javascript ]

Perform a local drill up for a target widget.

onloadHandler​

ClientMethod onloadHandler() [ Language = javascript ]

This client event, if present, is fired when the page is loaded.

setBkgOpacity​

ClientMethod setBkgOpacity(opacity) [ Language = javascript ]

setProperty​

ClientMethod setProperty(property, value, value2) [ Language = javascript ]

Set the value of a named property.

subtypeIsChart​

ClientMethod subtypeIsChart(subtype) [ Language = javascript ]

Test if this pivot widget is a chart

componentSetDisabled​

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)