%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
Method Inventory
- %CreateExportDropdown()
- %GetCatalogInfo()
- %GetDataController()
- %GetWidgetPropertyInfo()
- %OnCreateControls()
- %OnCreateWidget()
- GenerateXSLFO()
- adjustContentSize()
- cellClickHandler()
- chartClickHandler()
- chartRangeChange()
- chartRenderHandler()
- closeExportMenu()
- componentSetDisabled()
- drillHandler()
- exportCSV()
- exportExcel()
- exportPDF()
- getDataController()
- getOverrides()
- getPivot()
- getSubtypeClass()
- hasOverrides()
- listingSelectHandler()
- navCloseButtonClick()
- navDataChange()
- navHeaderButtonClick()
- navPopupAction()
- onloadHandler()
- realCellClickHandler()
- resetOverrides()
- resetPivot()
- setBkgOpacity()
- setProperty()
- showBreakdown()
- showDimensions()
- showGeoListing()
- showListing()
- subtypeIsChart()
- toggleExportMenu()
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 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
method %CreateExportDropdown(id, enabled, imgId, help, options) as %String
Get html to create an icon with an Excel/CSV dropdown menu.
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.
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 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
setDisabled(flag)
setDisabled(flag)
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
- %condition
- %definition
- %import
- %includeFiles
- %page
- %resource
- align
- aux
- backgroundColor
- cellAlign
- cellSize
- cellStyle
- cellVAlign
- centerHeader
- 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
- isClosed
- label
- labelClass
- labelDisabledClass
- labelPosition
- labelStyle
- layout
- linkWidgetKey
- maximized
- minWidth
- moveEnabled
- name
- onafterdrag
- onbeforedrag
- onclick
- onclosepending
- ondrag
- ondrop
- onhide
- onrefresh
- onresize
- onshow
- onupdate
- onwindowdrop
- onwindowgrab
- opacity
- opacityToolbar
- parent
- prevHomeCol
- prevHomeRow
- previewMode
- resizeEnabled
- rowSpan
- sessionCookie
- settings
- showLabel
- showSidebar
- showToolbar
- showToolbarBottomBorder
- showToolbarOnlyWhenMaximized
- sidebarContent
- sidebarWidth
- slice
- subtype
- title
- tuple
- valign
- visible
- widgetKey
- widgetLayout
- width
- window
Inherited Methods
- %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()
- %GetChildIndex()
- %GetEventHandlers()
- %GetParameter()
- %GetWidgetSettings()
- %GetXMLName()
- %IsA()
- %IsModified()
- %MakeId()
- %MakeWidgetId()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OnAddToPageAfter()
- %OnAddToPageBefore()
- %OnDrawEnclosingDiv()
- %OnDrawObjectProperties()
- %OnMutateChildren()
- %OnObjectSynch()
- %OnZENDeserialize()
- %OriginalNamespace()
- %PackageName()
- %QuoteValue()
- %QuoteValueL10N()
- %RemoveChild()
- %RemoveChildren()
- %RemoveFromSaveSet()
- %Self()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- GetKpiFilterCaption()
- ResolveText()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()
- abortClose()
- addChild()
- addChildAfter()
- addChildBefore()
- adjustChildArea()
- adjustHandleWidth()
- adjustResizeBox()
- adjustSizes()
- animateIcon()
- applyCSSSettings()
- chartCloseButtonClick()
- chartCreateLength()
- chartDataArrange()
- chartDataChange()
- chartGetContentForLevel()
- chartHeaderButtonClick()
- chartParseColorList()
- chartParseLength()
- chartSetChartType()
- childrenMutated()
- close()
- closeWidget()
- compress()
- constrainDragX()
- constrainDragY()
- controlEventHandler()
- disableCoverplate()
- disableDrag()
- disableHeaderMaxToggle()
- disableResize()
- dragFinishHandler()
- dragHandler()
- dragNotifyHandler()
- dragStartHandler()
- dropHandler()
- dropStartHandler()
- enableCoverplate()
- enableDrag()
- enableHeaderMaxToggle()
- enableResize()
- endDrag()
- expand()
- exposeComponent()
- findComponent()
- findElement()
- fireOnUpdateEvent()
- getChildDiv()
- getChildIndex()
- getCoverplateDiv()
- getDefinition()
- getEnclosingDiv()
- getFilterTableForPrinting()
- getHeaderDiv()
- getHeaderUserDiv()
- getHidden()
- getHintElement()
- getLabelElement()
- getOverrideSkipList()
- getProperty()
- getSVGFrame()
- getSettingDisplayValue()
- getSettingLists()
- getSettings()
- getState()
- getType()
- getWindowHeight()
- getWindowWidth()
- initializeHomeRowCol()
- invokeSuper()
- isCompressed()
- isMasterWidget()
- isMaximized()
- isOfType()
- isResizeInProgress()
- makeId()
- maximize()
- navDataArrange()
- navSelectItem()
- onCreate()
- onDelete()
- onDisplayHandler()
- onEndModalHandler()
- onGrabHandler()
- onPopupAction()
- onRefreshContents()
- onReleaseHandler()
- onSerialize()
- onStartModalHandler()
- ondisabledHandler()
- onresizeHandler()
- onunloadHandler()
- onupdateHandler()
- openWidget()
- pivotTableCloseButtonClick()
- pivotTableDataArrange()
- pivotTableDataChange()
- pivotTableGetContentForLevel()
- pivotTableHeaderButtonClick()
- printSVGContent()
- processAppMessage()
- raiseEventHandler()
- refreshContents()
- removeChild()
- removeWindowChrome()
- render()
- renderContents()
- renderCoverplate()
- renderHeader()
- renderResize()
- renderSVG()
- resetWindowChrome()
- resize()
- restoreGeometry()
- restoreState()
- saveGeometry()
- selectWidget()
- setAppLogo()
- setBodyStyle()
- setCenterLayout()
- setCloseIcon()
- setContractIcon()
- setExpandIcon()
- setHeaderLayout()
- setHeaderStyle()
- setHidden()
- setIcon()
- setMaximizeIcon()
- setMinimizeIcon()
- setModifiedIfDragged()
- setOpacity()
- setOverlayMode()
- setPropertyAll()
- setToolbarProperty()
- startDrag()
- startProgressBar()
- stopProgressBar()
- syncObject()
- updateMenuBar()
- verifyHeaderGeometry()