Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %DeepSee.Component.pivotTable
Private  Storage   

%DeepSee.Component.pivotTable


class %DeepSee.Component.pivotTable extends
%ZEN.Component.component

Pivot table component.
This component gives users the ability to view and interact with a DeepSee cube or subject area.
The data displayed by the pivot table can be supplied in various ways. This is specified using the dataSource:

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 163 163


Summary


Properties
%KPIController %ResultSet %condition %import
%includeFiles %message %page %resource
absolutePositioning align allowPreviewInteraction analyzerMode
autoExecute aux backgroundImage backgroundOpacity
borderBottomCell borderBottomCol borderBottomRow borderLeftCell
borderLeftCol borderLeftRow borderRightCell borderRightCol
borderRightRow borderTopCell borderTopCol borderTopRow
calculatedMembers canDrillDown canUseListingFields caption
cellCount cellHeight cellStyle cellWidth
changesPending colorScale columnAxisOptions columnCount
columnHeaderStyle columnLabelSpan columnLevels columnList
columnTotalAgg columnTotals columnsTruncated composite
containerStyle contextFilterSpec crossJoinRowLimit cubeKey
cubeName currListingPage currPage currentQueryText
data dataSource dataSourceName defaultListing
dragEnabled drillLevels drillRowNumbers dropEnabled
dynamic enclosingClass enclosingStyle error
evenRowStyle filterTableCaptionStyle filterTableItemStyle filterTableStyle
filters fontFamilyCell fontFamilyCol fontFamilyRow
fontSizeCell fontSizeCol fontSizeRow formatRules
headFunctionAdded height hidden hiddenMeasureText
hideMeasures hint hintClass hintStyle
id index initialExecute isDrillThrough
isPaging jsonRows kpi label
labelClass labelDisabledClass labelStyle listing
listingEnabled listingFields listingFilters listingFontSize
listingKey listingPageSize listingRowCount listingRows
listingSelect listingSortColumn listingSortDir listingType
maxChartSize maxRows mdx measureLocation
measures name nowDisplayFormat onafterdrag
onbeforedrag oncellClick oncellDblClick ondrag
ondrill ondrop onhide onlistingSelect
onrefresh onshow onupdate overlayMode
overrideColumnSpec overrideColumnText overrideRowSpec overrideRowText
pageSize parameters parent pivotNonce
pivotSelect pivotVariables previewMode previewRowCount
printCellWidth printLabelWidth printMarginBottom printMarginLeft
printMarginRight printMarginTop printOrientation printPageSize
printSubtitle printSubtitleOn printTitle queryCalls
queryComplete queryKey queryPending queryStatus
reinitialized renderFlag resolvedQueryText rowAxisOptions
rowCaptionList rowCaptionText rowCount rowHeaderStyle
rowLabelSpan rowLevels rowTotalAgg rowTotalSource
rowTotals rowsTruncated selectedCellBackground selectedCellColor
selectedRange selectedRowValues showDate showEmptyColumns
showEmptyRows showFilters showLabel showListingFilters
showPivot showPivotStats showPlan showQuery
showRowCaption showStatus showUser showZebra
showZebraStripes singleTable slice sortColumn
sortDir sqlRestriction staleCache tableStyle
title totalValue tuple userMDX
valign valueColumn visible width
window

Methods
%%OIDGet %AddToSaveSet %Attr %BindExport
%BuildObjectGraph %CalculateSpans %ClassIsLatestVersion %ClassName
%ClearDataModified %Close %CollectMeasures %ConstructClone
%CountMeasures %CreateResultSet %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %DrawClassDefinition %DrawComponentHTML %DrawDataTable
%DrawEmptyTable %DrawHTML %DrawJSGetSettings %DrawJSON
%DrawJSSerialize %DrawJSStrings %DrawKPITable %DrawListing
%DrawNub %DrawObjectProperties %DrawSVGDef %DrawStatusArea
%DrawStyleHTML %DrawStyleSVG %DrawTable %Emit
%EnclosingDivId %Eval %EvalC %Extends
%ForceClientRender %GenerateCode %GetAxisClauseFromLevels %GetAxisSize
%GetAxisSpecs %GetClassCRC %GetClassDepth %GetEventHandlers
%GetFilterInfo %GetIncludeFiles %GetIncludeInfo %GetKPIColumns
%GetMaxRowLevelDepth %GetParameter %GetSummaryFromCSS %GetSuperClassList
%GetWhereClause %GetXMLName %HideMeasures %IncrementCount
%IsA %IsModified %LocalizeElements %MakeId
%MaterializeListing %MergeTables %New %NormalizeObject
%ObjectModified %ObjectSynch %OnAddToPage %OnAddToPageAfter
%OnAddToPageBefore %OnCreateResultSet %OnDrawEnclosingDiv %OnDrawObjectProperties
%OnObjectSynch %OnZENDeserialize %OriginalNamespace %OutputJSONForGeoListing
%OutputJSONForKPI %PackageName %QuoteValue %QuoteValueL10N
%RemoveFromSaveSet %Self %SerializeObject %SetDataModified
%SetModified %ShowPlan %ShowPlanItem %ValidateObject
%XMLGenerate %ZENDeserialize DivMerge FormatValue
GetCurrentQueryText GetItemCaption GetItemSpec GetPivotVariableData
GetQueryStatus GetQueryText GetSlicerSpecForCells KillQuery
ParseMDXExpression ProcessLevels ReallyRefreshContents SetCurrentQueryText
SynthesizeMDX XMLAfterExport XMLBeforeExport XMLDTD
XMLExport XMLExportInternal XMLExportToStream XMLExportToString
XMLGetSchemaImports XMLImport XMLImportInternal XMLIsObjectEmpty
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
absoluteAdjustLayout addController addPivotCoverPane adjustCellSize
adjustTableLayout allClick allClickPivot callFormatValue
callGetItemSpec canDrillThrough canGoBack canGoForward
cancelQuery cbClick cbClickPivot cellClickHandler
cellDblClickHandler cellMouseDownHandler cellScrollHz cellScrollVt
columnClickHandler columnDblClickHandler computeCaption computeDivSize
computeTotals copyState dateFromHorolog deferredExecuteQuery
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
drillThrough dropHandler dropStartHandler executeListing
executeQuery exposeComponent filterLabelClick findElement
fireOnUpdateEvent firstPage getColumnDescriptors getContent
getCurrPage getData getDataAsArrays getDataByName
getDataSourceCaption getDimGrouping getDimName getDimSize
getDimensions getDrillLevel getEnclosingDiv getFilterForCells
getFilterInfo getHidden getHintElement getLabel
getLabelElement getListingPageCount getPageCount getPageSize
getPivotVariableInfo getProperty getPropertyDim getPropertyName
getRecordCount getRowCaptions getRowDescriptors getSelectedItems
getSelectedRange getSettings getType getValueName
goBack goForward gotoDrillLevel gotoPage
hasFormatRules hideMessage ieLayout invokeSuper
isOfType itemMouseDown itemMouseUp lastPage
listingHeaderDblClickHandler makeId newDataHandler nextPage
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onStartModalHandler
onloadHandler onunloadHandler onupdateHandler popState
previousPage processAxisColumns processAxisRows progressBarHandler
pushState queryTimerHandler raiseDataChange refreshContents
register removeAllDrillLevels removeController removeDrillLevel
removeMeasureLabels render renderContents renderSVG
resetTable rowClickHandler rowDblClickHandler selectCellRange
sendEventToViews setCurrPage setDrillThrough setHidden
setListing setOverlayMode setPivotDisabled setProperty
showAllRows showIKnowMeasureValue showMDXQuery showMessage
showPendingMsg singleTableAdjustLayout startProgressBar startQueryTimer
stopProgressBar stopQueryTimer swapRowsAndColumns unregister
updateController updateToolbar wheelHandler

Subclasses
%ZEN.Auxiliary.jsonMDXProvider

Parameters


• parameter DEFAULTENCLOSINGCLASS = "dsPivotEnclosingDiv";
Subclasses can set this to change default enclosingClass used for this component.
• parameter DOMAIN = "%DeepSee";
Localization domain
• parameter MAXCOLUMNS = 100;
• parameter MAXLISTINGROWS = 1000;
• parameter NAMESPACE = "http://www.intersystems.com/deepsee";
This is the XML namespace used for library components.

Properties


• property %KPIController as %ZEN.Auxiliary.dataController(XMLPROJECTION="none");
Current data controller used to get KPI data.
• property %ResultSet as %DeepSee.ResultSet(XMLPROJECTION="none");
Current DeepSee result set being processed.
• property %message as %ZEN.Datatype.string(XMLPROJECTION="none");
If set, then only one cell is displayed with this message text.
• property absolutePositioning as %ZEN.Datatype.string [ InitialExpression = 0 ];
• property allowPreviewInteraction as %ZEN.Datatype.boolean(XMLPROJECTION="none") [ InitialExpression = 1 ];
Allow the user to interact with the pivot even in preview mode.
• property analyzerMode as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Special flag to indicate use of pivot within the Analyzer. For now this turns on a background image.
• property autoExecute as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true then automatically execute queries when filters, rows, or columns are changed.
• property backgroundImage as %ZEN.Datatype.uri;
Optional image to show in background of pivot table.
• property backgroundOpacity as %ZEN.Datatype.float [ InitialExpression = 0.12 ];
Opacity (0 to 1) of pivot table background image.
• property borderBottomCell as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property borderBottomCol as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property borderBottomRow as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property borderLeftCell as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Table borders
• property borderLeftCol as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property borderLeftRow as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property borderRightCell as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property borderRightCol as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property borderRightRow as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property borderTopCell as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property borderTopCol as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property borderTopRow as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property calculatedMembers as list of calculatedMember(XMLNAME="calculatedMember",XMLPROJECTION="ELEMENT");
This contains any local calculated members for the table.
• property canDrillDown as %ZEN.Datatype.boolean(XMLPROJECTION="none",ZENSETTING=0) [ InitialExpression = 1 ];
If true, user can drill down by double-clicking on row captions. This is only enabled for queries automatically generated by the pivot table.
• property canUseListingFields as %ZEN.Datatype.boolean(XMLPROJECTION="none",ZENSETTING=0) [ InitialExpression = 0 ];
If true, user can select their own fields for listing.
• property caption as %ZEN.Datatype.string;
Caption to display. If not specified, the caption for the cube will be used.
• property cellCount as %ZEN.Datatype.integer(XMLPROJECTION="none",ZENSETTING=0);
Internal property used to track the number of cells.
• property cellHeight as %ZEN.Datatype.integer [ InitialExpression = 22 ];
This is the height (in pixels) used for all cells within the table. The default is 22.
• property cellStyle as %ZEN.Datatype.style;
Optional style to apply to cells.
• property cellWidth as %ZEN.Datatype.integer [ InitialExpression = 120 ];
This is the minimum width (in pixels) used for all cells within the table. The default is 120.
• property changesPending as %ZEN.Datatype.boolean(XMLPROJECTION="none") [ InitialExpression = 0 ];
If autoExecute is off, then this tracks that a refresh is needed.
• property colorScale as %ZEN.Datatype.string;
If set, this is the name of the color-scaling scheme to apply. red-to-black,green-to-black,blue-to-black,salmon-to-black,purple-to-black,gray-to-black or "custom:r1,g1,b1:r2,g2,b2".
• property columnAxisOptions as pivotLevel;
This is used to define functions to apply to the entire column axis.
• property columnCount as %ZEN.Datatype.integer(XMLPROJECTION="none",ZENSETTING=0);
If present, this is the number of columns returned by the current query. This is calculated in both user query and automatic query modes.
• property columnHeaderStyle as %ZEN.Datatype.style;
Optional style to apply to column headers.
• property columnLabelSpan as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
This specifies how parent column labels with multiple child labels are displayed.
If true, then one parent label is displayed for each set of children. If false, then the parent row label is repeated for each child.
• property columnLevels as list of pivotLevel(XMLNAME="columnLevel",XMLPROJECTION="ELEMENT");
This contains the definition of the column dimensions for this pivot table.
• property columnList as %ZEN.Datatype.csv;
If defined, then this is a list of columns to display when displaying a KPI-based pivot. Each item in the list can also define a caption: "property:caption,..." as well as a format: "property:caption:format,..."
"," and ":" can be escaped with "\," and "\:"
• property columnTotalAgg as %ZEN.Datatype.string(XMLPROJECTION="none") [ InitialExpression = "sum" ];
Indicate which aggregate to use for column totals: sum,min,max,count,avg,pct.
• property columnTotals as %ZEN.Datatype.boolean(XMLPROJECTION="none") [ InitialExpression = 0 ];
If true, then display column totals.
• property columnsTruncated as %ZEN.Datatype.integer(XMLPROJECTION="none",ZENSETTING=0) [ InitialExpression = 0 ];
Internal property used to track if we truncated the number of displayed columns.
• property contextFilterSpec as %ZEN.Datatype.string(XMLPROJECTION="NONE");
Externally applied filter spec. This should contain a valid %FILTER clause. If it starts with "%FILTER" then it is one or more %FILTER clauses.
• property crossJoinRowLimit as %ZEN.Datatype.integer [ InitialExpression = 2000 ];
Maximum number of rows to display for a CROSSJOIN.
• property cubeKey as %ZEN.Datatype.string(XMLPROJECTION="none",ZENSETTING=0);
Internal property used to remember the normalized cube name for this table.
• property cubeName as %ZEN.Datatype.className(ZENEXPRESSION=1);
Name of the cube that will provide data for this pivot table.
• property currListingPage as %ZEN.Datatype.integer [ InitialExpression = -1 ];
This is the number (1-based) of the "page" within the listing that is currently displayed. If this is set to -1, then the first page will be displayed AND the listing will be recomputed.
• property currPage as %ZEN.Datatype.integer [ InitialExpression = 1 ];
This is the number (1-based) of the "page" within the query results that is currently displayed.
• property currentQueryText as array of %DeepSee.Component.queryChunk;
Text of most recently executed query
• property data as %ZEN.Datatype.string(XMLPROJECTION="none",ZENSETTING=0);
The client-side object graph referred to by this property contains the most recent data for this pivot table.
• property dataSource as %ZEN.Datatype.string(VALUELIST=",manual,automatic") [ InitialExpression = "automatic" ];
Specifies how this pivot table gets data from a DeepSee source.
• property dataSourceName as %ZEN.Datatype.string;
Name of data source associated with this pivot.
• property defaultListing as %ZEN.Datatype.string;
Name of listing to use for the default detail listing. If empty, the default listing for the cube is used.
• property drillLevels as list of pivotLevel(XMLNAME="drillLevel",XMLPROJECTION="ELEMENT");
This contains the current set of "drill into" levels for this pivot table.
• property drillRowNumbers as list of %ZEN.Datatype.string(XMLPROJECTION="NONE");
• property evenRowStyle as %ZEN.Datatype.style;
Optional style to apply to even rows in zebra stripe mode.
• property filterTableCaptionStyle as %ZEN.Datatype.style(XMLPROJECTION="attribute");
filterTableCaptionStyle;
• property filterTableItemStyle as %ZEN.Datatype.style(XMLPROJECTION="attribute");
filterTableItemStyle;
• property filterTableStyle as %ZEN.Datatype.style(XMLPROJECTION="attribute");
filterTableStyle
• property filters as list of pivotLevel(XMLNAME="filter",XMLPROJECTION="ELEMENT");
This contains the definition of the filters for this pivot table.
• property fontFamilyCell as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property fontFamilyCol as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property fontFamilyRow as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property fontSizeCell as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property fontSizeCol as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property fontSizeRow as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property formatRules as list of pivotCondition(XMLNAME="formatRule",XMLPROJECTION="ELEMENT");
This contains any conditional formatting rules for the table.
• property headFunctionAdded as %ZEN.Datatype.boolean(XMLPROJECTION="NONE") [ InitialExpression = 0 ];
Flag to indicate a HEAD function has been added to an axis by the Analyzer
• property hiddenMeasureText as list of %ZEN.Datatype.string(XMLPROJECTION="ELEMENT");
• property hideMeasures as %ZEN.Datatype.string [ InitialExpression = 1 ];
Indicates if and how measures should be displayed 0 = Always 1 = If More Than 1 Measure 2 = Never
• property initialExecute as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, then automatically execute queries when this pivot is first displayed.
• property isDrillThrough as %ZEN.Datatype.boolean(XMLPROJECTION="none",ZENSETTING=0) [ InitialExpression = 0 ];
When set true, the current query is executed as a DRILLTHROUGH.
If the current data source is a KPI, then execute a listing provided by the KPI (if available).
• property isPaging as %ZEN.Datatype.boolean(XMLPROJECTION="none") [ InitialExpression = 0 ];
Internal flag. Set true when paging among query results.
• property jsonRows as %ZEN.Datatype.integer [ InitialExpression = 2500 ];
Maximum number of data rows emitted as JSON to drive charts. If empty, the default value (2500) is used.
• property kpi as %ZEN.Datatype.string;
If defined, then this is the name of the DeepSee KPI class used to provide the contents of the pivot table.
• property listing as %ZEN.Datatype.string;
Name of listing to use for the current detail listing. If empty, the default listing is used.
• property listingEnabled as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, then listings are enabled for this pivot.
• property listingFields as list of pivotLevel(XMLNAME="listingField",XMLPROJECTION="ELEMENT");
This is the set of fields that describe the columnns used for the current custom listing for this pivot table.
• property listingFilters as list of pivotLevel(XMLNAME="listingFilter",XMLPROJECTION="ELEMENT");
This is the set of filters that describe the cell(s) used for the current listing for this pivot table.
• property listingFontSize as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Font fize used in listing
• property listingKey as %ZEN.Datatype.string(XMLPROJECTION="none",ZENSETTING=0);
Internal property used to caching listing results for this table.
• property listingPageSize as %ZEN.Datatype.integer [ InitialExpression = 100 ];
Number of rows to display within one page of a detail listing. If empty, the default value (100) is used.
• property listingRowCount as %ZEN.Datatype.integer(XMLPROJECTION="none",ZENSETTING=0);
If present, this is the total number of rows returned by the current listing.
• property listingRows as %ZEN.Datatype.integer;
Maximum number of total rows to display within a detail listing. If empty, the default value (1000) is used.
• property listingSelect as %ZEN.Datatype.string(VALUELIST=",single,multi");
Specifies the select mode for a detail listing: none, "single", or "multi".
• property listingSortColumn as %ZEN.Datatype.integer [ InitialExpression = 0 ];
If not 0, then sort the listing table by the values within this column.
• property listingSortDir as %ZEN.Datatype.string(VALUELIST="ASC,DESC") [ InitialExpression = "ASC" ];
If listing column sorting is on, then this is the sort direction.
• property listingType as %ZEN.Datatype.string(VALUELIST=",table,map",XMLPROJECTION="none") [ InitialExpression = "table" ];
Specifies the type of detail listing to show: "table", or "map".
• property maxChartSize as %ZEN.Datatype.integer(XMLPROJECTION="NONE") [ InitialExpression = 400 ];
Certain chart types may have different maximum sizes that make sense.
• property maxRows as %ZEN.Datatype.integer(XMLPROJECTION="attribute");
Max rows exported to PDF
• property mdx as %ZEN.Datatype.string(ZENENCRYPT=1,ZENSETTING=0);
If defined and dataSource is set to "manual", then this is the MDX statement used to provide the contents of the pivot table.
• property measureLocation as %ZEN.Datatype.string(VALUELIST="rows,columns") [ InitialExpression = "columns" ];
When there are multiple measures in the measures list, speficies where to place them: "rows", or "columns".
• property measures as list of pivotLevel(XMLNAME="measure",XMLPROJECTION="ELEMENT");
This contains the default measure(s) (e.g., "[Measures].[Sales]") to show for this pivot table.
• property nowDisplayFormat as %ZEN.Datatype.string(XMLPROJECTION="attribute");
nowDisplayFormat
• property oncellClick as %ZEN.Datatype.eventHandler;
oncellClick event handler: This event handler is called by the pivot when the user clicks the mouse on a cell within the pivot table.
The event handler is passed an argument, pivot, that is this pivot table object.
• property oncellDblClick as %ZEN.Datatype.eventHandler;
oncellDblClick event handler: This event handler is called by the pivot when the user double clicks the mouse on a cell within the pivot table.
The event handler is passed an argument, pivot, that is this pivot table object.
• property ondrill as %ZEN.Datatype.eventHandler;
ondrill event handler: This event handler is called by the pivot whenever the drill down state of the pivot is changed.
The event handler is passed an argument, pivot, that is this pivot table object.
• property onlistingSelect as %ZEN.Datatype.eventHandler;
onlistingSelect event handler: This event handler is called by the pivot when the user selects or unselected an item within a pivot listing.
The event handler is passed an argument, pivot, that is this pivot table object.
• property overrideColumnSpec as %ZEN.Datatype.string(XMLPROJECTION="NONE");
Externally applied COLUMNS spec. This should contain a valid MDX expression (without "ON COLUMNS").
• property overrideColumnText as %ZEN.Datatype.string(XMLPROJECTION="NONE");
Text value associated with overrideColumnSpec. Used as a label.
• property overrideRowSpec as %ZEN.Datatype.string(XMLPROJECTION="NONE");
Externally applied ROWS spec. This should contain a valid MDX expression (without "ON ROWS").
• property overrideRowText as %ZEN.Datatype.string(XMLPROJECTION="NONE");
Text value associated with overrideRowSpec. Used as a label.
• property pageSize as %ZEN.Datatype.integer [ InitialExpression = 100 ];
Number of pivot result rows to show at one time.
• property parameters as array of %ZEN.Auxiliary.parameter(XMLKEYNAME="paramName",XMLNAME="parameter",XMLPROJECTION="ELEMENT");
User-defined set of parameters. These values are passed on to the user callback functions that provides the contents of this table. Typically this is used to hold search parameters.
• property pivotNonce as %ZEN.Datatype.integer(XMLPROJECTION="none",ZENSETTING=0) [ InitialExpression = $R(1000000000) ];
Internal property to track this specific pivot instance. This is used to cancel query execution.
• property pivotSelect as %ZEN.Datatype.string(VALUELIST=",single,multi");
Specifies the select mode for the pivot table: none, "single", or "multi". Turning this on displays check boxes for each row in the pivot table. This is different from the built-in cell range selection mechanism.
This only applies to KPI-based pivots.
• property pivotVariables as array of %String(XMLPROJECTION="NONE");
Run-time value of pivot variables used by this pivot.
• property previewMode as %ZEN.Datatype.boolean(XMLPROJECTION="none") [ InitialExpression = 0 ];
Initial value of previewMode setting for the Analyzer
• property previewRowCount as %ZEN.Datatype.integer(XMLPROJECTION="none") [ InitialExpression = 25 ];
The row limit used to truncate while in SAMPLE mode.
• property printCellWidth as %ZEN.Datatype.float(XMLPROJECTION="attribute");
Width of data cells when the pivot is printed. This is in the same units as the page size.
• property printLabelWidth as %ZEN.Datatype.float(XMLPROJECTION="attribute");
Width of row labels when the pivot is printed. This is in the same units as the page size.
• property printMarginBottom as %ZEN.Datatype.float(XMLPROJECTION="attribute");
Page bottom margin when pivot is printed. This is in the same units as the page size.
• property printMarginLeft as %ZEN.Datatype.float(XMLPROJECTION="attribute");
Page left margin when pivot is printed. This is in the same units as the page size.
• property printMarginRight as %ZEN.Datatype.float(XMLPROJECTION="attribute");
Page right margin when pivot is printed. This is in the same units as the page size.
• property printMarginTop as %ZEN.Datatype.float(XMLPROJECTION="attribute");
Page top margin when pivot is printed. This is in the same units as the page size.
• property printOrientation as %ZEN.Datatype.string(XMLPROJECTION="attribute") [ InitialExpression = 1 ];
Orientation when pivot is printed: "portrait" or "landscape".
• property printPageSize as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Page size when pivot is printed. This takes the form "8.5x11 in" (w x h).
• property printSubtitle as %ZEN.Datatype.string(MAXLEN=2000,XMLPROJECTION="attribute");
Subtitle to display when pivot is printed.
• property printSubtitleOn as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Display the subtitle when exporting to PDF
• property printTitle as %ZEN.Datatype.string(MAXLEN=2000,XMLPROJECTION="attribute");
Title to display when pivot is printed.
• property queryCalls as %ZEN.Datatype.integer(XMLPROJECTION="none",ZENSETTING=0);
Internal property used to track number of calls to track the current query.
• property queryComplete as %ZEN.Datatype.float(XMLPROJECTION="none",ZENSETTING=0);
Internal property used to track the completion percentage of the current query.
• property queryKey as %ZEN.Datatype.string(XMLPROJECTION="none",ZENSETTING=0);
Internal property used to remember the query key for this table.
• property queryPending as %ZEN.Datatype.boolean(XMLPROJECTION="none",ZENSETTING=0) [ InitialExpression = 0 ];
Internal property used to track whether the current query has pending results (such as async KPIs being computed).
• property queryStatus as %ZEN.Datatype.string(XMLPROJECTION="none",ZENSETTING=0) [ InitialExpression = 0 ];
Internal property used to track the current query status.
• property reinitialized as %ZEN.Datatype.boolean(XMLPROJECTION="none") [ InitialExpression = 0 ];
• property resolvedQueryText as array of %DeepSee.Component.queryChunk;
Resolved text of most recently executed query
• property rowAxisOptions as pivotLevel;
This is used to define functions to apply to the entire row axis.
• property rowCaptionList as list of %ZEN.Datatype.string(XMLPROJECTION="ELEMENT");
• property rowCaptionText as %ZEN.Datatype.string(XMLPROJECTION="none",ZENSETTING=0);
Holder for row caption text.
• property rowCount as %ZEN.Datatype.integer(XMLPROJECTION="none",ZENSETTING=0);
If present, this is the number of rows returned by the current query. This is calculated in both user query and automatic query modes.
• property rowHeaderStyle as %ZEN.Datatype.style;
Optional style to apply to row headers.
• property rowLabelSpan as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
This specifies how parent row labels with multiple child labels are displayed.
If true, then one parent label is displayed for each set of children. If false, then the parent row label is repeated for each child.
• property rowLevels as list of pivotLevel(XMLNAME="rowLevel",XMLPROJECTION="ELEMENT");
This contains the definition of the row dimensions for this pivot table.
• property rowTotalAgg as %ZEN.Datatype.string(XMLPROJECTION="none") [ InitialExpression = "sum" ];
Indicate which aggregate to use for row totals: sum,min,max,count,avg,pct.
• property rowTotalSource as %ZEN.Datatype.string(XMLPROJECTION="none") [ InitialExpression = "page" ];
Indicate the source for row totals: "page" or "all".
• property rowTotals as %ZEN.Datatype.boolean(XMLPROJECTION="none") [ InitialExpression = 0 ];
If true, then display row totals.
• property rowsTruncated as %ZEN.Datatype.boolean(XMLPROJECTION="none") [ InitialExpression = 0 ];
This flag is set when the resultset has seen its rows truncated by a HEAD function.
• property selectedCellBackground as %ZEN.Datatype.style [ InitialExpression = "rgb(47,98,128)" ];
Background color applied to the selected cell range.
• property selectedCellColor as %ZEN.Datatype.style [ InitialExpression = "white" ];
Color applied to the selected cell range.
• property selectedRange as %ZEN.Datatype.csv;
This specifies the current selected range of cells as a comma-separated list of integers. The list is of the form:
startRow,startCol,endRow,endCol,allRows,allCols
All cells numbers are 1-based and represent the ordinal position of cells as they are displayed and not their position within the underlying query (e.g., when columns are sorted, these are still 1,2,3).
If allRows is 1, then all rows for indicated columns are selected.
If allCols is 1, then all columns for indicated rows are selected.
If the range is equal to "", then no cells are selected.
• property selectedRowValues as %ZEN.Datatype.string(XMLPROJECTION="none",ZENSETTING=0);
Internal property used to remember the set of selected row values.
• property showDate as %ZEN.Datatype.string(XMLPROJECTION="attribute");
showDate - on, off
• property showEmptyColumns as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, display columns containing only empty values.
If mdx is specified, this is ignored.
• property showEmptyRows as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, display rows containing only empty values.
If mdx is specified, this is ignored.
• property showFilters as %ZEN.Datatype.string(XMLPROJECTION="attribute");
showFilters - byTable, byTitle, off
• property showListingFilters as %ZEN.Datatype.string(XMLPROJECTION="attribute");
showListingFilters - on, off
• property showPivot as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, then write out HTML for this pivot otherwise only serve up JSON data (to drive other components).
• property showPivotStats as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, show pivot cell count and total in status area along the bottom of the table.
• property showPlan as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, execute a show plan for the query.
• property showQuery as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, show the query used to get results for this table.
This is a intended for use as a troubleshooting aid.
• property showRowCaption as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, show a caption above the row headers.
• property showStatus as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, show status area along the bottom of the table.
• property showUser as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Display the user when exporting to PDF
• property showZebra as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, show zebra striping.
• property showZebraStripes as %ZEN.Datatype.string(XMLPROJECTION="attribute");
showZebraStripes - on, off
• property singleTable as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
• property sortColumn as %ZEN.Datatype.integer [ InitialExpression = 0 ];
If not 0, then sort the results by the values within this column.
• property sortDir as %ZEN.Datatype.string(VALUELIST="ASC,DESC") [ InitialExpression = "ASC" ];
If column sorting is on, then this is the sort direction.
• property sqlRestriction as %ZEN.Datatype.string(XMLNAME="sqlRestriction",XMLPROJECTION="ELEMENT");
This contains an SQL restriction that should be applied to this pivot table.
• property staleCache as %ZEN.Datatype.boolean(XMLPROJECTION="none") [ InitialExpression = 0 ];
• property tableStyle as %ZEN.Datatype.style [ InitialExpression = "background-color:white" ];
Optional style to apply to entire table
• property totalValue as %ZEN.Datatype.float(XMLPROJECTION="none",ZENSETTING=0);
Internal property used to track the current total of cell values.
• property userMDX as %ZEN.Datatype.string(ZENSETTING=0);
If defined, then this holds the user-supplied MDX statement used to provide the contents of the pivot table.
• property valueColumn as %ZEN.Datatype.string;
If defined, then this is the name of the column that provides the value for a row within this pivot. This value is used when a row is selected, and a dashboard *action* is invoked on the pivot.
This only applies to KPI-based pivots. If not provided, then the first column is used.

Methods


• method %CalculateSpans(ByRef pTopTableHTML, ByRef pSideTableHTML, Output pRowSpan, Output pColSpan, Output pFirstSpan=0) as %Status
• method %ClearDataModified()
Clear the (shadow) modified bit for the data property.
• method %CollectMeasures(pQueryKey As %String, Output pCollectedMeasures As %String, pListingFilters As %Boolean) as %Status
• method %CountMeasures(Output pMeasures As %Integer, Output pComputedMeasures As %Integer)
Return the total number of measures and how many are computed measures.
• method %CreateResultSet(Output pSC As %Status, ByRef pParms, ByRef pFilterInfo, ByRef pAdvancedFilters, Output pQueryText As %String, Output pAxes, Output pDataReady As %Boolean, Output pComplexQuery As %Boolean, pExecuteBaseQuery As %Boolean = 0) as %DeepSee.ResultSet
Create the DeepSee ResultSet needed to get data for this table.
Does not execute the query.
pSC is a status code.
pParms is an array of input parameter values.
pFilterInfo is an array of filter details.
pAdvancedFilters is an array of advanced filter details.
pAxes is an array of top nodes for each axis.
pDataReady is true if the query results are in the cache.
pQueryText is the text of the query.
pComplexQuery is true if this is a "complex" query that should have its axes executed first.
• method %DrawDataTable(pAxisCount As %Integer, pColRoot As %Integer, pRowRoot As %Integer, pStartRow As %Integer, pEndRow As %Integer, pColumnTotals As %Boolean = 0, pRowTotals As %Boolean = 0, pUseSort As %Boolean = 0, pMaxCols As %Boolean = 1000, ByRef pHTML As %String, ByRef pHTMLAttributes As %String) as %Status
Draw the table containing the data cells.
pColRoot is node number for top node along the column axis.
pRowRoot is node number for top node along the row axis.
pStartRow is the ordinal number of the first row to display.
pEndRow is the ordinal number of the last row to display.
• method %DrawEmptyTable(pMessage As %String, ByRef pHTML As %String, ByRef pHTMLAttributes) as %Status
Draw a one-cell data table with the given message.
• method %DrawHTML()
Draw HTML for this component.
• method %DrawJSON() as %Status
Draw JSON output for the current query results.
• method %DrawKPITable() as %Status
Draw table using KPI class as a source.
• method %DrawListing() as %Status
Draw the listing table for a drillthrough query.
Assume the listing has been materialized to a listing global.
• method %DrawNub(ByRef pNub, pRowSpan As %String, pColSpan As %String, pFirstSpan As %String) as %Status
• method %DrawStatusArea(pPageCount As %Integer, pMode As %String = "pivot", pTruncated As %Boolean = 0) as %Status
Draw the contents of the status area. pMode indicates whether this is a pivot status or a listing status.
• method %DrawTable(pAxisCount As %Integer, pColAxis As %Integer, pRowAxis As %Integer, ByRef pFilterInfo, pUseSort As %Boolean = 0) as %Status
Draw the tables that make up this component.
pAxisCount is the number of axes within the result.
pColAxis specifies which axis should be used for columns.
pRowAxis specifies which axis should be used for rows.
pFilterInfo is an array of filter information.
pUseSort indicates that row sorting is in play.
• method %Emit(ByRef pTable, pTransform As %String = "", ByRef pIgnore="", pRowSpan As %String, pColSpan As %String, pBorderWidth As %String = 1) as %Status
• method %GetAxisClauseFromLevels(pLevels As %AbstractList, pShowEmpty As %Boolean = 0, Output pComplexQuery As %Boolean, pDrillLevel As %Integer = "", pMaxItems As %Integer = "", pShowAll As %Boolean = 0) as %String
Convert an array of pivot levels into an MDX axis clause that will serve as part of the query executed for the pivot.
• method %GetAxisSize(pAxisNo As %Integer) as %Integer
Find the number of displayed leaf nodes in the given axis.
pAxisNo is the axis number.
• method %GetAxisSpecs(pAxisNo As %Integer, pSpan As %Boolean, pStart As %Integer, pEnd As %Integer, Output pLevels As %Integer, Output pItems, pUseSort As %Boolean = 0) as %Status
Compute information needed to draw the labels and cells of this table for the given axis.
pAxisNo is the axis number.
pSpan indicates whether we should span parent labels.
pStart is the (ordinal) number of the first cell to show.
pEnd is the (ordinal) number of the end cell to show.
pLevels returns the number of levels within the axis.
pItems returns an array of items to plot. This takes the form:
pItems(level,index) = $LB(nodeNo,colSpan,rowSpan,hasChildren,[itemNo(presorted #)]) (along the column axis, otherwise flip the row and col spans).
• method %GetFilterInfo(Output pInfo, Output pAdvancedFilters, pReturnMembers=0) as %Status
Get information for filters.
pInfo returns the list of filters in the first subscript:
pInfo(i) = $LB(idx,spec,value,text,isMsr,isMember)
If the pReturnMembers flag is set, the list of members for the filter will be returned in:
pInfo(i,j) = $LB(value,name,memberId,memberKey) for the j-th member of the i-th filter.
There may be advanced filters:
pAdvancedFilters(i) = $LB(idx,spec,text)
• classmethod %GetKPIColumns(pController As %ZEN.Auxiliary.dataController, Output pColCount As %Integer, Output pColInfo, pColumnList As %String = "") as %Status
Return information on the set of columns to display for the current KPI. Returns:
pColInfo(n) = property
pColInfo(n,"caption") = caption (if different)
This is a class method that is also called from Excel and PDF export.
If pColumnList is provided, it is a csv-list that specifies the columns and column order from the KPI to display. Otherwise all columns are displayed in the order defined by the KPI.
• classmethod %GetMaxRowLevelDepth(pRow, pDepth As %Integer = 0) as %Integer
• classmethod %GetSummaryFromCSS(pStyle As %String, Output pAgg As %String) as %String
Parse a CSS style directive and remove any "summary:val" directives within it.
• method %GetWhereClause(ByRef pFilterInfo) as %String
Construct the MDX WHERE clause for the pivot table.
• method %HideMeasures() as %Boolean
Return true if the Measures setting stipulates the measures should be hidden from view.
• method %LocalizeElements(pCubeClass As %String, pList As %ListOfObjects)
Make sure any text within this list of pivot levels is localized!
• method %MaterializeListing(pRS As %DeepSee.ResultSet, pSQLRS As %SQL.StatementResult = "") as %Status
Execute the listing for a drillthrough query and save it to a cache global.
If pSQLRS is provided, use it.
• method %MergeTables(ByRef pNubTableHTML As %String, ByRef pTopTableHTML As %String, ByRef pSideTableHTML As %String, ByRef pDataTableHTML As %String, ByRef pNubTableAttributes As %String, ByRef pTopTableAttributes As %String, ByRef pSideTableAttributes As %String, ByRef pDataTableAttributes As %String) as %Status
• method %OnCreateResultSet(Output pRS As %DeepSee.ResultSet, ByRef pParms) as %Status
This callback is invoked when the pivot table is about to create a result set.
If the callback creates a %DeepSee.ResultSet object and returns it via pRS, then the pivot table will use this result set to display results.
• method %OnDrawObjectProperties()
Render the JSON content of the target object along with the other properties of the provider.
• private method %OnNew(initvalue As %RawString) as %Status
Constructor for Zen objects.
If subclasses override %OnNew, they should make sure to invoke this using #super.
• method %OnObjectSynch() as %Status
Render the JSON content of the target object along with the other properties of the provider.
• method %OutputJSONForGeoListing(pRS As %DeepSee.ResultSet, pSQLRS As %SQL.StatementResult = "") as %Status
Draw JSON output for a geolisting.
• method %OutputJSONForKPI() as %Status
Draw JSON output for the current KPI class.
• method %SetDataModified()
Set the (shadow) modified bit for the data property.
• method %ShowPlan(pRS As %DeepSee.ResultSet) as %Status
Show execution plan for the query
• method %ShowPlanItem(ByRef pPlan, pNodeNo As %Integer, pLevel As %Integer = 0) as %Status
Show one item in a query plan.
• method DivMerge(tNubTable="", tTopTable="", tSideTable="", tDataTable="", pNubTableHTML, pTopTableHTML, pSideTableHTML, pDataTableHTML)
• classmethod FormatValue(pCubeName As %String, pQueryKey As %String, pValue As %String, pFormattedValue As %ZEN.proxyObject, pRowNo As %Integer, pColNo As %Integer) as %Boolean [ ZenMethod ]
• method GetCurrentQueryText(pWhich As %String) as %String [ ZenMethod ]
• classmethod GetItemCaption(pCubeName As %String, pSpec As %String) as %String [ ZenMethod ]
Return the caption associate with given cube element.
• classmethod GetItemSpec(pSpec As %ZEN.proxyObject, pCubeName As %String, pQueryKey As %String, pSortDir As %String, pSortColumn As %String, pAxisName As %String, pItemNo As %Integer, pItemNoSorted As %Boolean = 0) as %Boolean [ ZenMethod ]
Get the tuple spec for the given item within the query result and place it into the proxy object. pAxisName is "row" or "col".
Return true, if ok.
• classmethod GetPivotVariableData(pCubeName, pVariableName, pValue="") as %ZEN.proxyObject [ ZenMethod ]
Retrieves the meta data about the pivot variable and can convert the logical value display value.
• classmethod GetQueryStatus(pObject As %ZEN.proxyObject, pCubeName As %String, pQueryKey As %String, pKPI As %String = "") as %Boolean [ ZenMethod ]
Check on the status of the given query. Return true, if ok.
• classmethod GetQueryText(pCubeName As %String, pQueryKey As %String, pEncrypt As %Boolean = 0) as %String [ ZenMethod ]
Get the MDX text for the current query.
• classmethod GetSlicerSpecForCells(pSpec As %ZEN.proxyObject, pCubeName As %String, pQueryKey As %String, pStartRow As %Integer, pStartCol As %Integer, pEndRow As %Integer = "", pEndCol As %Integer = "", pAllRows As %Boolean = 0, pAllCols As %Boolean = 0, pSortCol As %Integer = 0, pSortDir As %String = "ASC") as %Boolean [ ZenMethod ]
Get the slicer spec for the given cell within the query result and place it into the proxy object. Return true, if ok.
• classmethod KillQuery(pCubeName As %String, pQueryKey As %String, pNonce As %String) as %Boolean [ ZenMethod ]
Cancel the query specified by pCubeName and pQueryKey. Return true, if ok.
• classmethod ParseMDXExpression(pExpression, pCubeName) as %String [ ZenMethod ]
Parse an MDX clause representing a collection of cell addresses into a $C(10)-delimited list that can be pssed back to the client. This is designed to parse contextual filters.
• method ProcessLevels(pList As %AbstractList, pStart As %Integer, ByRef pTree, pParent As %Integer)
Convert array of levels (from pStart) into a parse tree that can be handed to a query.
• method SetCurrentQueryText(pWhich As %String = "current", pMDX As %String) as %Status
• method SynthesizeMDX(Output pSC As %Status, ByRef pRS As %DeepSee.ResultSet, ByRef pParms, ByRef pFilterInfo, ByRef pAdvancedFilters, Output pQueryText As %String, Output pAxes, Output pDataReady As %Boolean, Output pComplexQuery As %Boolean, pExecuteBaseQuery As %Boolean = 0, pShowAll As %Boolean = 0) as %String [ ZenMethod ]
Build the current MDX query text from the current contents of this component
• method absoluteAdjustLayout() [ Language = javascript ]
• method addController(ctrl) [ Language = javascript ]
Associate a controller component with this pivotTable. This is called by the controller component.
• method addPivotCoverPane(parentDiv) [ Language = javascript ]
Adds a coverpane to the pivot in the DOM. This is used to disable the pivot interaction.
• method adjustCellSize(cellid, height, width, top, left, offsetHeight, offsetWidth) [ Language = javascript ]
• method adjustTableLayout() [ Language = javascript ]
Adjust size and position of the layout divs that contain the table as well as the cells and headers in the table.
• method allClick(evt) [ Language = javascript ]
Click on all check box (in detail listing).
• method allClickPivot(evt) [ Language = javascript ]
Click on all check box (in pivot).
• method callFormatValue(value, formattedValue, rowItem, columnItem) [ Language = javascript ]
Used to provide label related info when required.
• method callGetItemSpec(labelInfo, rowItem, columnItem) [ Language = javascript ]
Used to provide label related info when required.
• method canDrillThrough() [ Language = javascript ]
Test if this pivot supports drill through.
• method canGoBack() [ Language = javascript ]
Indicate if we can go back to a prior state.
• method canGoForward() [ Language = javascript ]
Indicate if we can go forward to a visited state.
• method cancelQuery() [ Language = javascript ]
Cancel the current query for this pivot table and update the display.
• method cbClick(evt, currCb) [ Language = javascript ]
Click on checkbox.
• method cbClickPivot(evt, currCb) [ Language = javascript ]
Click on checkbox in pivot.
• method cellClickHandler(evt, row, col) [ Language = javascript ]
Notification that a cell is clicked.
row and col give the ordinal (logical) position of the cell.
• method cellDblClickHandler(evt, row, col) [ Language = javascript ]
Notification that a cell is double-clicked.
row and col give the ordinal position of the cell.
• method cellMouseDownHandler(evt) [ Language = javascript ]
Mouse down within a cell. Try to prevent text select when selecting multiple cells.
• method cellScrollHz() [ Language = javascript ]
Horizontal Scroll handler..
• method cellScrollVt() [ Language = javascript ]
Vertical Scroll handler.
• method columnClickHandler(evt, col) [ Language = javascript ]
Notification that a column header is clicked.
• method columnDblClickHandler(evt, col) [ Language = javascript ]
Notification that a column header is double-clicked.
• final method computeCaption(item, noformat) [ Language = javascript ]
Resolve the caption for a given axis item. (This is used to get logical values for time axis members).
• method computeDivSize(theDiv, isWebKit) [ Language = javascript ]
Compute and return the size of the given html.
• method computeTotals() [ Language = javascript ]
Compute row and columns totals, as needed.
• method copyState(master) [ Language = javascript ]
Copy the (most of the) current state of another pivot into this one. Used by linked pivots.
• method dateFromHorolog(val) [ Language = javascript ]
Convert a $H to yyyy-mm-dd date.
• method deferredExecuteQuery(force) [ Language = javascript ]
Execute a query after a short pause (to allow for window updates, etc.
• method dragFinishHandler(dragData) [ Language = javascript ]
This is called when a drag operation started within this component is completed.
• method dragStartHandler(dragData) [ Language = javascript ]
Built-in drag handler for pivot table component. Let the user drag the selected node.
• method drillThrough() [ Language = javascript ]
Toggle drill through state of this pivot. If not in drill through mode, execute a drill through: show a listing for the current selected range of cells. else restore normal view. Return true if the operation took place.
• method dropStartHandler(dragData) [ Language = javascript ]
Drop handler. This is called when an item is dropped onto the table.
• method executeListing() [ Language = javascript ]
Execute a drill through for the current selected cell.
• method executeQuery(force) [ Language = javascript ]
Execute the current query for this pivot table and update the display.
If force is true, then force the query to be prepared.
• method filterLabelClick(evt, filterValue) [ Language = javascript ]
Click on an item label within the filter dropdown.
• method firstPage() [ Language = javascript ]
For multi-page display, go to the first page.
• method getColumnDescriptors() [ Language = javascript ]
Return an array of column descriptors for use by a dataGrid connected to this pivot.
• final method getContent() [ Language = javascript ]
• method getCurrPage() [ Language = javascript ]
Number of the current "page" when paging (1-based).
• method getData(d1, d2, d3) [ Language = javascript ]
dataSet API Return the data contained in the specified location. Location is 0-based;
• final method getDataAsArrays() [ Language = javascript ]
This is a specialized variant of getData that return the data in this controller as an array of arrays (used by charts).
• method getDataByName(property, series) [ Language = javascript ]
• final method getDataSourceCaption(which, title) [ Language = javascript ]
Return a title to display for this data source. This provides the title for a chart.
• final method getDimGrouping(dim) [ Language = javascript ]
Special method: return if the given dimension has hierarchical groupings (to indicate that a chart should display them).
• final method getDimName(dim) [ Language = javascript ]
Return a name for the given dimension (1,2, or 3). This provides the axis label for a chart.
• final method getDimSize(dim) [ Language = javascript ]
Return the number of items in the specified dimension (dim is 1,2, or 3).
• method getDimensions() [ Language = javascript ]
Return number of dimensions in this pivot.
• method getDrillLevel() [ Language = javascript ]
Return current drill level for this pivot.
• method getFilterForCells(r1, c1, r2, c2, allRows, allCols) [ Language = javascript ]
Return the filter spec for the given cell range.
• final method getFilterInfo(fnames, fvalues, flabels) [ Language = javascript ]
Return information on current filters.
fnames is an array in which the filter names will be placed.
fvalues is an array in which the filter values will be placed.
flabels is an array in which the filter labels will be placed.
• final method getLabel(n, dim, noformat) [ Language = javascript ]
Get the label at position n (0-based) in the given dimension (1,2, or 3).
• method getListingPageCount() [ Language = javascript ]
For multi-page listing display, calculate the number of pages.
• method getPageCount() [ Language = javascript ]
For multi-page display, calculate the number of pages.
• method getPageSize() [ Language = javascript ]
Return total number of pages to support dataGrid paging.
• final method getPivotVariableInfo(pnames, pvalues) [ Language = javascript ]
Return information on current pivot variables.
pnames is an array in which the variable names will be placed.
pvalues is an array in which the variable values will be placed.
• method getPropertyDim() [ Language = javascript ]
Return the ordinal number of the dimension supplying property names for this controller.
• method getPropertyName(n) [ Language = javascript ]
Given a 0-based index, return the corresponding property name.
• method getRecordCount() [ Language = javascript ]
Return total number of records to support dataGrid paging.
• method getRowCaptions() [ Language = javascript ]
Return an array of row captions (shown above headers).
• method getRowDescriptors() [ Language = javascript ]
Return an array of row descriptors for use by a dataGrid connected to this pivot.
• method getSelectedItems() [ Language = javascript ]
Return an array of the values of the selected items in the pivot table. For listing mode, this is the set of ids for the selected rows. For pivot mode, this is the values of the value column for each selected row.
• method getSelectedRange() [ Language = javascript ]
Return the range of selected cells or null if nothing selected.
The range is returned as an array of startRow,startCol,endRow,endCol,allRows,allCols.
• final method getValueName() [ Language = javascript ]
Return a label for the values returned by the data source. This provides the axis label for a chart.
• method goBack(notify) [ Language = javascript ]
Go back to the previous state.
• method goForward() [ Language = javascript ]
Go forward to the next state (if there is one).
• method gotoDrillLevel(idx) [ Language = javascript ]
Go to the given drill level.
• method gotoPage(page) [ Language = javascript ]
For multi-page display, go to specified page (1 is first page), if possible.
• method hasFormatRules() [ Language = javascript ]
Indicate if there are any formatting rules in play.
• method hideMessage() [ Language = javascript ]
Hide the message box.
• method ieLayout() [ Language = javascript ]
Work-around for ie8!
• method itemMouseDown(evt, idx) [ Language = javascript ]
Mouse down handler for nodes.
• method itemMouseUp(evt) [ Language = javascript ]
Mouse up handler for nodes.
• method lastPage() [ Language = javascript ]
For multi-page display, go to the last page.
• method listingHeaderDblClickHandler(evt, col) [ Language = javascript ]
Notification that a listing header is double-clicked.
• method newDataHandler() [ Language = javascript ]
Notification that new data is available.
• method nextPage() [ Language = javascript ]
For multi-page display, go to next page, if possible.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method onupdateHandler() [ Language = javascript ]
This client method, if present, is fired when the object is updated from the server. This is called *after* changes have been synched.
• method popState() [ Language = javascript ]
Pop the current state of the pivot from the "history" stack.
• method previousPage() [ Language = javascript ]
For multi-page display, go to previous page, if possible.
• method processAxisColumns(list, groups, tuples) [ Language = javascript ]
Convert an axis group to descriptors.
• method processAxisRows(list, groups, tuples) [ Language = javascript ]
Convert an axis group to descriptors.
• method pushState() [ Language = javascript ]
Push the current state of the pivot onto the "history" stack.
• method queryTimerHandler() [ Language = javascript ]
Internal method.
Timer event handler used by the query timer bar.
• final method raiseDataChange() [ Language = javascript ]
Send notification to listeners that the data associated with this pivotTable has changed.
• final method register(component) [ Language = javascript ]
Internal method.
Establish a connection between this pivotTable and a chart component
• method removeAllDrillLevels() [ Language = javascript ]
Clear all current drill levels and reset the table back to its resting state.
• method removeController() [ Language = javascript ]
Remove the controller component associated with this pivotTable. This is called by the controller component.
• method removeDrillLevel(idx, evt) [ Language = javascript ]
Remove a drill level. The input parameter idx is the 0-based index of the level to remove.
• method removeMeasureLabels(values, measureCaption) [ Language = javascript ]
• method resetTable() [ Language = javascript ]
Reset this table to default settings.
• method rowClickHandler(evt, row) [ Language = javascript ]
Notification that a row header is clicked.
• method rowDblClickHandler(evt, level, row) [ Language = javascript ]
Notification that a row header is double clicked.
• method selectCellRange(startRow, startCol, endRow, endCol, allRows, allCols, selectOnly) [ Language = javascript ]
Set the selected cell range. Addresses are 1-based.
• method sendEventToViews(reason, source, data1, data2, data3) [ Language = javascript ]
Send an event to all listeners (dataViews) connected to this dataController. reason is the name of the event.
source, if not null, if the dataView that raised the event.
data1,data2, and data3 contain event-specific data passed along with the event.
• method setCurrPage(page) [ Language = javascript ]
Set the current "page" when paging (1-based).
• method setDrillThrough(flag, force) [ Language = javascript ]
Set the drill through state of this pivot to flag.
If true, execute a drill through: show a listing for the current selected range of cells. else restore normal view. Return true if the operation took place.
• method setListing(listing, type) [ Language = javascript ]
Set the name of the listing (and listing type) to show for this pivot.
• method setPivotDisabled(setDisabled) [ Language = javascript ]
This prevents a user from interacting with the pivot by using the cover pane.
• method setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
• method showAllRows() [ Language = javascript ]
Notification that a listing header is double-clicked.
• method showIKnowMeasureValue(cubeName, measure, objId) [ Language = javascript ]
• method showMDXQuery() [ Language = javascript ]
Toggle display of the current query.
• method showMessage(msg, pct, listing) [ Language = javascript ]
Display the message box. (or display message within pivot controller, if present).
• method showPendingMsg(flag, msg) [ Language = javascript ]
Show (or hide) the "computing..." message.
• method singleTableAdjustLayout() [ Language = javascript ]
• method startQueryTimer(needsRefresh) [ Language = javascript ]
Start the timer used to update during query calculation.
• method stopQueryTimer() [ Language = javascript ]
Stop the query timer.
• method swapRowsAndColumns() [ Language = javascript ]
Swap the row and column definitions for this table and refresh it.
• final method unregister(component) [ Language = javascript ]
Internal method.
Break the a connection between this pivotTable and a chart component
• method updateController() [ Language = javascript ]
Update the controller component associated with this pivotTable, if any. This is called internally when the state of the pivot table changes.
• method updateToolbar() [ Language = javascript ]
Update the toolbar on the controller component associated with this pivotTable, if any. This is called internally when the state of the pivot table changes.
• method wheelHandler(evt) [ Language = javascript ]
Mouse wheel handler.