DocBook|Search
Class Reference
%DeepSee.Component.Widget.pivot
   
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%DeepSee] >  [Component] >  [Widget] >  [pivot]
Private  Storage  

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

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
10 26


Summary

Properties
%condition %definition %import %includeFiles
%page %resource align aux
cellAlign cellSize cellStyle cellVAlign
centerHeader chartToggle children clickActions
clickFilterSpec clickTargetProperties clickTargets colSpan
composite containerStyle controlIndices currFilterSpec
currItemNo currSeriesNo currValue currValueName
dataSource disabled dragEnabled dropEnabled
enclosingClass enclosingStyle error filterDefault
filterState filterText 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 moveEnabled name onafterdrag
onbeforedrag onclick onclosepending ondrag
ondrop onhide onrefresh onresize
onshow onupdate onwindowdrop onwindowgrab
parent pivotName previewMode resizeEnabled
rowSpan sessionCookie settings showLabel
showSidebar sidebarContent sidebarWidth slice
subtype title tuple valign
visible widgetKey widgetLayout width
window

Methods
%%OIDGet %AddChild %AddChildAfter %AddChildBefore
%AddToSaveSet %Attr %BindExport %ClassIsLatestVersion
%ClassName %ConstructClone %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawComponentHTML %DrawHTML %DrawJSStrings
%EnclosingDivId %Eval %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
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
abortClose addChild addChildAfter addChildBefore
adjustChildArea adjustContentSize adjustHandleWidth adjustResizeBox
adjustSizes animateIcon cellClickHandler chartClickHandler
childrenMutated close 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 getDataController
getEnclosingDiv getHeaderDiv getHeaderUserDiv getHidden
getHintElement getLabelElement getProperty getSettings
getState getType getWindowHeight getWindowWidth
invokeSuper isCompressed isMaximized isOfType
isResizeInProgress listingSelectHandler makeId maximize
navDataChange onCreate onDelete onDisplayHandler
onEndModalHandler onGrabHandler onPopupAction onRefreshContents
onReleaseHandler onSerialize onStartModalHandler ondisabledHandler
onloadHandler onresizeHandler onunloadHandler onupdateHandler
raiseEventHandler refreshContents removeChild removeWindowChrome
render renderContents renderCoverplate renderHeader
renderResize renderSVG resetPivot resetWindowChrome
resize restoreGeometry restoreState saveGeometry
setAppLogo setCenterLayout setCloseIcon setContractIcon
setExpandIcon setHeaderLayout setHidden setIcon
setMaximizeIcon setMinimizeIcon setOverlayMode setProperty
setPropertyAll showBreakdown showDimensions showGeoListing
showListing startDrag startProgressBar stopProgressBar
syncObject verifyHeaderGeometry


Properties

• 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.
• property sessionCookie as %ZEN.Datatype.string;
Current CSP session.

Methods

• 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 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 drillHandler(pivot) [ Language = javascript ]
Drill state change handler for pivot table.
• method exportExcel() [ Language = javascript ]
Export current query to excel
• method exportPDF() [ Language = javascript ]
Export current query to pdf.
• method getDataController() [ Language = javascript ]
If this widget contains a data controller, return it.
• method listingSelectHandler(pivot) [ Language = javascript ]
Listing select handler for pivot table.
• method resetPivot() [ Language = javascript ]
Go back to the previous pivot state.
• 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.