%DeepSee.Component.pivotTable

Class %DeepSee.Component.pivotTable Extends %ZEN.Component.component [ System = 3 ]

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:

• "manual" - Setting the value of the userMDX property to a valid MDX statement will cause the pivotTable to display the results of the query. This includes DRILLTHROUGH queries (which provide a listing of source data values).
• "automatic" - The user can drag and drop member specifications onto one of the various drop zones (supplied by the pivotController component) and the pivot table will automatically construct and execute an MDX query. In this case, you must supply a value for the cubeName property.
  This is the mode in which the DeepSee Analyzer works.

Parameters

JSINCLUDES

Parameter JSINCLUDES = "DeepSee.js,dsparser.js";

Pick up formula code.

NAMESPACE

Parameter NAMESPACE = "http://www.intersystems.com/deepsee";

DOMAIN

Parameter DOMAIN = "%DeepSee";

Localization domain

DEFAULTENCLOSINGCLASS

Parameter DEFAULTENCLOSINGCLASS = "dsPivotEnclosingDiv";

MAXCOLUMNS

Parameter MAXCOLUMNS = 100;

MAXLISTINGROWS

Parameter MAXLISTINGROWS = 1000;

Properties

absolutePositioning

Property absolutePositioning As %ZEN.Datatype.string [ InitialExpression = 0 ];

dataSource

Property dataSource As %ZEN.Datatype.string(VALUELIST = ",manual,automatic") [ InitialExpression = "automatic" ];

Specifies how this pivot table gets data from a DeepSee source.

singleTable

Property singleTable As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

staleCache

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

reinitialized

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

dataSourceName

Property dataSourceName As %ZEN.Datatype.string [ Internal ];

Name of data source associated with this pivot.

mdx

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.

userMDX

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.

kpi

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.

currentQueryText

Property currentQueryText As %ZEN.Datatype.string(ZENENCRYPT = 1, ZENSETTING = 0);

Text of most recently executed query

resolvedQueryText

Property resolvedQueryText As %ZEN.Datatype.string(ZENENCRYPT = 1, ZENSETTING = 0);

Resolved text of most recently executed query

columnList

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 "\:"

valueColumn

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.

hideMeasures

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

hiddenMeasureText

Property hiddenMeasureText As list Of %ZEN.Datatype.string(XMLPROJECTION = "ELEMENT");

rowCaptionList

Property rowCaptionList As list Of %ZEN.Datatype.string(XMLPROJECTION = "ELEMENT");

showPlan

Property showPlan As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

If true, execute a show plan for the query.

cellWidth

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.

rowLabelSpan

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.

columnLabelSpan

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.

cellHeight

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.

showEmptyRows

Property showEmptyRows As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

If true, display rows containing only empty values.
If mdx is specified, this is ignored.

showEmptyColumns

Property showEmptyColumns As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

If true, display columns containing only empty values.
If mdx is specified, this is ignored.

cubeName

Property cubeName As %ZEN.Datatype.className(ZENEXPRESSION = 1);

Name of the cube that will provide data for this pivot table.

caption

Property caption As %ZEN.Datatype.string;

Caption to display. If not specified, the caption for the cube will be used.

listing

Property listing As %ZEN.Datatype.string;

Name of listing to use for the current detail listing. If empty, the default listing is used.

defaultListing

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.

listingEnabled

Property listingEnabled As %ZEN.Datatype.boolean [ InitialExpression = 1 ];

If true, then listings are enabled for this pivot.

listingSelect

Property listingSelect As %ZEN.Datatype.string(VALUELIST = ",single,multi");

Specifies the select mode for a detail listing: none, "single", or "multi".

listingType

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

Specifies the type of detail listing to show: "table", or "map".

listingRows

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.

listingPageSize

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.

pivotSelect

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.

cubeKey

Property cubeKey As %ZEN.Datatype.string(XMLPROJECTION = "none", ZENSETTING = 0) [ Internal ];

Internal property used to remember the normalized cube name for this table.

queryKey

Property queryKey As %ZEN.Datatype.string(XMLPROJECTION = "none", ZENSETTING = 0) [ Internal ];

Internal property used to remember the query key for this table.

listingKey

Property listingKey As %ZEN.Datatype.string(XMLPROJECTION = "none", ZENSETTING = 0) [ Internal ];

Internal property used to caching listing results for this table.

pivotNonce

Property pivotNonce As %ZEN.Datatype.integer(XMLPROJECTION = "none", ZENSETTING = 0) [ InitialExpression = {$R(1000000000)}, Internal ];

Internal property to track this specific pivot instance. This is used to cancel query execution.

totalValue

Property totalValue As %ZEN.Datatype.float(XMLPROJECTION = "none", ZENSETTING = 0) [ Internal ];

Internal property used to track the current total of cell values.

cellCount

Property cellCount As %ZEN.Datatype.integer(XMLPROJECTION = "none", ZENSETTING = 0) [ Internal ];

Internal property used to track the number of cells.

columnsTruncated

Property columnsTruncated As %ZEN.Datatype.integer(XMLPROJECTION = "none", ZENSETTING = 0) [ InitialExpression = 0, Internal ];

Internal property used to track if we truncated the number of displayed columns.

queryStatus

Property queryStatus As %ZEN.Datatype.string(XMLPROJECTION = "none", ZENSETTING = 0) [ InitialExpression = 0, Internal ];

Internal property used to track the current query status.

queryComplete

Property queryComplete As %ZEN.Datatype.float(XMLPROJECTION = "none", ZENSETTING = 0) [ Internal ];

Internal property used to track the completion percentage of the current query.

queryCalls

Property queryCalls As %ZEN.Datatype.integer(XMLPROJECTION = "none", ZENSETTING = 0) [ Internal ];

Internal property used to track number of calls to track the current query.

queryPending

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

Internal property used to track whether the current query has pending results (such as async KPIs being computed).

showStatus

Property showStatus As %ZEN.Datatype.boolean [ InitialExpression = 1 ];

If true, show status area along the bottom of the table.

showPivotStats

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.

showQuery

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.

canDrillDown

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

If true, user can drill down by double-clicking on row captions. This is only enabled for queries automatically generated by the pivot table.

rowAxisOptions

Property rowAxisOptions As pivotLevel;

This is used to define functions to apply to the entire row axis.

columnAxisOptions

Property columnAxisOptions As pivotLevel;

This is used to define functions to apply to the entire column axis.

rowLevels

Property rowLevels As list Of pivotLevel(XMLNAME = "rowLevel", XMLPROJECTION = "ELEMENT");

This contains the definition of the row dimensions for this pivot table.

columnLevels

Property columnLevels As list Of pivotLevel(XMLNAME = "columnLevel", XMLPROJECTION = "ELEMENT");

This contains the definition of the column dimensions for this pivot table.

filters

Property filters As list Of pivotLevel(XMLNAME = "filter", XMLPROJECTION = "ELEMENT");

This contains the definition of the filters for this pivot table.

sqlRestriction

Property sqlRestriction As %ZEN.Datatype.string(XMLNAME = "sqlRestriction", XMLPROJECTION = "ELEMENT");

This contains an SQL restriction that should be applied to this pivot table.

contextFilterSpec

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.

overrideColumnSpec

Property overrideColumnSpec As %ZEN.Datatype.string(XMLPROJECTION = "NONE");

Externally applied COLUMNS spec. This should contain a valid MDX expression (without "ON COLUMNS").

overrideColumnText

Property overrideColumnText As %ZEN.Datatype.string(XMLPROJECTION = "NONE");

Text value associated with overrideColumnSpec. Used as a label.

overrideRowSpec

Property overrideRowSpec As %ZEN.Datatype.string(XMLPROJECTION = "NONE");

Externally applied ROWS spec. This should contain a valid MDX expression (without "ON ROWS").

overrideRowText

Property overrideRowText As %ZEN.Datatype.string(XMLPROJECTION = "NONE");

Text value associated with overrideRowSpec. Used as a label.

measures

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.

measureLocation

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".

drillLevels

Property drillLevels As list Of pivotLevel(XMLNAME = "drillLevel", XMLPROJECTION = "ELEMENT");

This contains the current set of "drill into" levels for this pivot table.

drillRowNumbers

Property drillRowNumbers As list Of %ZEN.Datatype.string(XMLPROJECTION = "NONE");

listingFilters

Property listingFilters As list Of pivotLevel(XMLNAME = "listingFilter", XMLPROJECTION = "ELEMENT") [ Internal ];

This is the set of filters that describe the cell(s) used for the current listing for this pivot table.

listingFields

Property listingFields As list Of pivotLevel(XMLNAME = "listingField", XMLPROJECTION = "ELEMENT") [ Internal ];

This is the set of fields that describe the columnns used for the current custom listing for this pivot table.

canUseListingFields

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

If true, user can select their own fields for listing.

pageSize

Property pageSize As %ZEN.Datatype.integer [ InitialExpression = 100 ];

Number of pivot result rows to show at one time.

currPage

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.

sortColumn

Property sortColumn As %ZEN.Datatype.integer [ InitialExpression = 0 ];

If not 0, then sort the results by the values within this column.

sortDir

Property sortDir As %ZEN.Datatype.string(VALUELIST = "ASC,DESC") [ InitialExpression = "ASC" ];

If column sorting is on, then this is the sort direction.

currListingPage

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.

listingSortColumn

Property listingSortColumn As %ZEN.Datatype.integer [ InitialExpression = 0 ];

If not 0, then sort the listing table by the values within this column.

listingSortDir

Property listingSortDir As %ZEN.Datatype.string(VALUELIST = "ASC,DESC") [ InitialExpression = "ASC" ];

If listing column sorting is on, then this is the sort direction.

rowCount

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.

jsonRows

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.

listingRowCount

Property listingRowCount As %ZEN.Datatype.integer(XMLPROJECTION = "none", ZENSETTING = 0);

If present, this is the total number of rows returned by the current listing.

columnCount

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.

formatRules

Property formatRules As list Of pivotCondition(XMLNAME = "formatRule", XMLPROJECTION = "ELEMENT");

This contains any conditional formatting rules for the table.

calculatedMembers

Property calculatedMembers As list Of calculatedMember(XMLNAME = "calculatedMember", XMLPROJECTION = "ELEMENT");

This contains any local calculated members for the table.

selectedRange

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.

selectedCellBackground

Property selectedCellBackground As %ZEN.Datatype.style [ InitialExpression = "rgb(47,98,128)" ];

Background color applied to the selected cell range.

selectedCellColor

Property selectedCellColor As %ZEN.Datatype.style [ InitialExpression = "white" ];

Color applied to the selected cell range.

columnHeaderStyle

Property columnHeaderStyle As %ZEN.Datatype.style;

Optional style to apply to column headers.

rowHeaderStyle

Property rowHeaderStyle As %ZEN.Datatype.style;

Optional style to apply to row headers.

cellStyle

Property cellStyle As %ZEN.Datatype.style;

Optional style to apply to cells.

tableStyle

Property tableStyle As %ZEN.Datatype.style [ InitialExpression = "background-color:white" ];

Optional style to apply to entire table

showZebra

Property showZebra As %ZEN.Datatype.boolean [ InitialExpression = 0 ];

If true, show zebra striping.

showRowCaption

Property showRowCaption As %ZEN.Datatype.boolean [ InitialExpression = 1 ];

If true, show a caption above the row headers.

rowCaptionText

Property rowCaptionText As %ZEN.Datatype.string(XMLPROJECTION = "none", ZENSETTING = 0) [ Internal ];

Holder for row caption text.

evenRowStyle

Property evenRowStyle As %ZEN.Datatype.style;

Optional style to apply to even rows in zebra stripe mode.

colorScale

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".

analyzerMode

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.

backgroundImage

Property backgroundImage As %ZEN.Datatype.uri;

Optional image to show in background of pivot table.

backgroundOpacity

Property backgroundOpacity As %ZEN.Datatype.float [ InitialExpression = 0.12 ];

Opacity (0 to 1) of pivot table background image.

isDrillThrough

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

parameters

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.

%message

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

If set, then only one cell is displayed with this message text.

progressMessage

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

If set this will contain the current message for display in the progress indicator.

rowTotals

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

If true, then display row totals.

columnTotals

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

If true, then display column totals.

rowTotalAgg

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

Indicate which aggregate to use for row totals: sum,min,max,count,avg,pct.

columnTotalAgg

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

Indicate which aggregate to use for column totals: sum,min,max,count,avg,pct.

rowTotalSource

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

Indicate the source for row totals: "page" or "all".

%ResultSet

Property %ResultSet As %DeepSee.ResultSet(XMLPROJECTION = "none") [ Internal ];

Current DeepSee result set being processed.

%KPIController

Property %KPIController As %ZEN.Auxiliary.dataController(XMLPROJECTION = "none") [ Internal ];

Current data controller used to get KPI data.

data

Property data As %ZEN.Datatype.string(XMLPROJECTION = "none", ZENSETTING = 0) [ Internal ];

The client-side object graph referred to by this property contains the most recent data for this pivot table.

oncellClick

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.

oncellDblClick

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.

ondrill

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.

onlistingSelect

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.

isPaging

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

Internal flag. Set true when paging among query results.

initialExecute

Property initialExecute As %ZEN.Datatype.boolean [ InitialExpression = 1 ];

If true, then automatically execute queries when this pivot is first displayed.

autoExecute

Property autoExecute As %ZEN.Datatype.boolean [ InitialExpression = 1 ];

If true then automatically execute queries when filters, rows, or columns are changed.

previewMode

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

Initial value of previewMode setting for the Analyzer

allowPreviewInteraction

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

Allow the user to interact with the pivot even in preview mode.

previewRowCount

Property previewRowCount As %ZEN.Datatype.integer(XMLPROJECTION = "none") [ InitialExpression = 25 ];

The row limit used to truncate while in SAMPLE mode.

rowsTruncated

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.

changesPending

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

If autoExecute is off, then this tracks that a refresh is needed.

selectedRowValues

Property selectedRowValues As %ZEN.Datatype.string(XMLPROJECTION = "none", ZENSETTING = 0) [ Internal ];

Internal property used to remember the set of selected row values.

printTitle

Property printTitle As %ZEN.Datatype.string(MAXLEN = 2000, XMLPROJECTION = "attribute");

Title to display when pivot is printed.

printSubtitle

Property printSubtitle As %ZEN.Datatype.string(MAXLEN = 2000, XMLPROJECTION = "attribute");

Subtitle to display when pivot is printed.

printOrientation

Property printOrientation As %ZEN.Datatype.string(XMLPROJECTION = "attribute") [ InitialExpression = 1 ];

Orientation when pivot is printed: "portrait" or "landscape".

printSubtitleOn

Property printSubtitleOn As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

Display the subtitle when exporting to PDF

showUser

Property showUser As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

Display the user when exporting to PDF

printPageSize

Property printPageSize As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

Page size when pivot is printed. This takes the form "8.5x11 in" (w x h).

printMarginTop

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.

printMarginLeft

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.

printMarginRight

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.

printMarginBottom

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.

printLabelWidth

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.

printCellWidth

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.

maxRows

Property maxRows As %ZEN.Datatype.integer(XMLPROJECTION = "attribute");

Max rows exported to PDF

borderLeftCell

Property borderLeftCell As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

Table borders

borderRightCell

Property borderRightCell As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

borderTopCell

Property borderTopCell As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

borderBottomCell

Property borderBottomCell As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

borderLeftCol

Property borderLeftCol As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

borderRightCol

Property borderRightCol As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

borderTopCol

Property borderTopCol As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

borderBottomCol

Property borderBottomCol As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

borderLeftRow

Property borderLeftRow As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

borderRightRow

Property borderRightRow As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

borderTopRow

Property borderTopRow As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

borderBottomRow

Property borderBottomRow As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

fontFamilyCell

Property fontFamilyCell As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

fontSizeCell

Property fontSizeCell As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

fontFamilyCol

Property fontFamilyCol As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

fontSizeCol

Property fontSizeCol As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

fontFamilyRow

Property fontFamilyRow As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

fontSizeRow

Property fontSizeRow As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

showFilters

Property showFilters As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

showFilters - byTable, byTitle, off

showListingFilters

Property showListingFilters As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

showListingFilters - on, off

showDate

Property showDate As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

showDate - on, off

showZebraStripes

Property showZebraStripes As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

showZebraStripes - on, off

listingFontSize

Property listingFontSize As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

Font fize used in listing

filterTableStyle

Property filterTableStyle As %ZEN.Datatype.style(XMLPROJECTION = "attribute");

filterTableStyle

filterTableCaptionStyle

Property filterTableCaptionStyle As %ZEN.Datatype.style(XMLPROJECTION = "attribute");

filterTableCaptionStyle;

filterTableItemStyle

Property filterTableItemStyle As %ZEN.Datatype.style(XMLPROJECTION = "attribute");

filterTableItemStyle;

nowDisplayFormat

Property nowDisplayFormat As %ZEN.Datatype.string(XMLPROJECTION = "attribute");

nowDisplayFormat

showPivot

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

crossJoinRowLimit

Property crossJoinRowLimit As %ZEN.Datatype.integer [ InitialExpression = 2000 ];

Maximum number of rows to display for a CROSSJOIN.

headFunctionAdded

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

pivotVariables

Property pivotVariables As array Of %String(XMLPROJECTION = "NONE") [ Internal ];

Run-time value of pivot variables used by this pivot.

maxChartSize

Property maxChartSize As %ZEN.Datatype.integer(XMLPROJECTION = "NONE") [ InitialExpression = 400 ];

Certain chart types may have different maximum sizes that make sense.

LastSessionKey

Property LastSessionKey As %ZEN.Datatype.integer [ InitialExpression = 0 ];

Saves the session key of the latest executed query for access and clean-up of local cache

LastCube

Property LastCube As %ZEN.Datatype.string;

Saves the cube name of the latest executed query for clean-up of local cache

LastQueryKey

Property LastQueryKey As %ZEN.Datatype.string;

Saves the query key of the latest executed query for clean-up of local cache

XDatas

Style

XData Style

defines the style sheet used by this component.

Methods

deferredExecuteQuery

ClientMethod deferredExecuteQuery(force) [ Internal, Language = javascript ]

Execute a query after a short pause (to allow for window updates, etc.

executeQuery

ClientMethod 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.

executeListing

ClientMethod executeListing() [ Language = javascript ]

Execute a drill through for the current selected cell.

cancelQuery

ClientMethod cancelQuery() [ Language = javascript ]

Cancel the current query for this pivot table and update the display.

swapRowsAndColumns

ClientMethod swapRowsAndColumns() [ Language = javascript ]

Swap the row and column definitions for this table and refresh it.

getSelectedRange

ClientMethod 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.

resetTable

ClientMethod resetTable() [ Language = javascript ]

Reset this table to default settings.

canDrillThrough

ClientMethod canDrillThrough() [ Language = javascript ]

Test if this pivot supports drill through.

drillThrough

ClientMethod 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.

setDrillThrough

ClientMethod 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.

showMDXQuery

ClientMethod showMDXQuery() [ Language = javascript ]

Toggle display of the current query.

%LocalizeElements

Method %LocalizeElements(pCubeClass As %String, pList As %ListOfObjects) [ Internal ]

Make sure any text within this list of pivot levels is localized!

%UpdateLocalSession

Method %UpdateLocalSession() As %Status

Updates the SessionKey, Cube, and QueryKey properties with the current session data, and deletes the previous session data from the cache

DeleteLastResult

Method DeleteLastResult() As %String [ ZenMethod ]

Deletes the previous session data from the local cache. Called from the frontend

onunloadHandler

ClientMethod onunloadHandler() [ Language = javascript ]

Delete the latest query from local cache in asynchronous mode before unloading

%DrawHTML

Method %DrawHTML()

Draw HTML for this component.

%DrawTable

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.

%GetMaxRowLevelDepth

ClassMethod %GetMaxRowLevelDepth(pRow, pDepth As %Integer = 0) As %Integer

%CalculateSpans

Method %CalculateSpans(ByRef pTopTableHTML, ByRef pSideTableHTML, Output pRowSpan, Output pColSpan, Output pFirstSpan = 0) As %Status

DivMerge

Method DivMerge(tNubTable = "", tTopTable = "", tSideTable = "", tDataTable = "", pNubTableHTML, pTopTableHTML, pSideTableHTML, pDataTableHTML)

%DrawNub

Method %DrawNub(ByRef pNub, pRowSpan As %String, pColSpan As %String, pFirstSpan As %String) As %Status

%Emit

Method %Emit(ByRef pTable, pTransform As %String = "", ByRef pIgnore = "", pRowSpan As %String, pColSpan As %String, pBorderWidth As %String = 1) As %Status

%MergeTables

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

%DrawKPITable

Method %DrawKPITable() As %Status

Draw table using KPI class as a source.

%GetKPIColumns

ClassMethod %GetKPIColumns(pController As %ZEN.Auxiliary.dataController, Output pColCount As %Integer, Output pColInfo, pColumnList As %String = "") As %Status [ Internal ]

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.

%DrawStatusArea

Method %DrawStatusArea(pPageCount As %Integer, pMode As %String = "pivot", pTruncated As %Boolean = 0) As %Status [ Internal ]

Draw the contents of the status area. pMode indicates whether this is a pivot status or a listing status.

%DrawDataTable

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.

%DrawEmptyTable

Method %DrawEmptyTable(pMessage As %String, ByRef pHTML As %String, ByRef pHTMLAttributes) As %Status

Draw a one-cell data table with the given message.

%GetAxisSize

Method %GetAxisSize(pAxisNo As %Integer) As %Integer [ Internal ]

Find the number of displayed leaf nodes in the given axis.
pAxisNo is the axis number.

%GetAxisSpecs

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 [ Internal ]

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

%GetFilterInfo

Method %GetFilterInfo(Output pInfo, Output pAdvancedFilters, pReturnMembers = 0) As %Status [ Internal ]

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)

%CreateResultSet

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.

%OnCreateResultSet

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.

%CountMeasures

Method %CountMeasures(Output pMeasures As %Integer, Output pComputedMeasures As %Integer) [ Internal ]

Return the total number of measures and how many are computed measures.

%CollectMeasures

Method %CollectMeasures(pQueryKey As %String, Output pCollectedMeasures As %String, pListingFilters As %Boolean) As %Status

%HideMeasures

Method %HideMeasures() As %Boolean

Return true if the Measures setting stipulates the measures should be hidden from view.

%GetWhereClause

Method %GetWhereClause(ByRef pFilterInfo) As %String [ Internal ]

Construct the MDX WHERE clause for the pivot table.

%GetAxisClauseFromLevels

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 [ Internal ]

Convert an array of pivot levels into an MDX axis clause that will serve as part of the query executed for the pivot.

ProcessLevels

Method ProcessLevels(pList As %AbstractList, pStart As %Integer, ByRef pTree, pParent As %Integer) [ Internal ]

Convert array of levels (from pStart) into a parse tree that can be handed to a query.

cellMouseDownHandler

ClientMethod cellMouseDownHandler(evt) [ Language = javascript ]

Mouse down within a cell. Try to prevent text select when selecting multiple cells.

cellClickHandler

ClientMethod cellClickHandler(evt, row, col) [ Language = javascript ]

Notification that a cell is clicked.
row and col give the ordinal (logical) position of the cell.

cellDblClickHandler

ClientMethod cellDblClickHandler(evt, row, col) [ Language = javascript ]

Notification that a cell is double-clicked.
row and col give the ordinal position of the cell.

columnClickHandler

ClientMethod columnClickHandler(evt, col) [ Language = javascript ]

Notification that a column header is clicked.

columnDblClickHandler

ClientMethod columnDblClickHandler(evt, col) [ Language = javascript ]

Notification that a column header is double-clicked.

listingHeaderDblClickHandler

ClientMethod listingHeaderDblClickHandler(evt, col) [ Language = javascript ]

Notification that a listing header is double-clicked.

rowClickHandler

ClientMethod rowClickHandler(evt, row) [ Language = javascript ]

Notification that a row header is clicked.

rowDblClickHandler

ClientMethod rowDblClickHandler(evt, level, row) [ Language = javascript ]

Notification that a row header is double clicked.

selectCellRange

ClientMethod selectCellRange(startRow, startCol, endRow, endCol, allRows, allCols, selectOnly) [ Language = javascript ]

Set the selected cell range. Addresses are 1-based.

getPageCount

ClientMethod getPageCount() [ Language = javascript ]

For multi-page display, calculate the number of pages.

getListingPageCount

ClientMethod getListingPageCount() [ Language = javascript ]

For multi-page listing display, calculate the number of pages.

previousPage

ClientMethod previousPage() [ Language = javascript ]

For multi-page display, go to previous page, if possible.

nextPage

ClientMethod nextPage() [ Language = javascript ]

For multi-page display, go to next page, if possible.

firstPage

ClientMethod firstPage() [ Language = javascript ]

For multi-page display, go to the first page.

lastPage

ClientMethod lastPage() [ Language = javascript ]

For multi-page display, go to the last page.

gotoPage

ClientMethod gotoPage(page) [ Language = javascript ]

For multi-page display, go to specified page (1 is first page), if possible.

setProperty

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

Set the value of a named property.

dragStartHandler

ClientMethod dragStartHandler(dragData) [ Language = javascript ]

Built-in drag handler for pivot table component. Let the user drag the selected node.

callGetItemSpec

ClientMethod callGetItemSpec(labelInfo, rowItem, columnItem) [ Language = javascript ]

Used to provide label related info when required.

callFormatValue

ClientMethod callFormatValue(value, formattedValue, rowItem, columnItem) [ Language = javascript ]

Used to provide label related info when required.

removeMeasureLabels

ClientMethod removeMeasureLabels(values, measureCaption) [ Language = javascript ]

dropStartHandler

ClientMethod dropStartHandler(dragData) [ Language = javascript ]

Drop handler. This is called when an item is dropped onto the table.

dragFinishHandler

ClientMethod dragFinishHandler(dragData) [ Language = javascript ]

This is called when a drag operation started within this component is completed.

hideMessage

ClientMethod hideMessage() [ Language = javascript ]

Hide the message box.

showPendingMsg

ClientMethod showPendingMsg(flag, msg) [ Language = javascript ]

Show (or hide) the "computing..." message.

showMessage

ClientMethod showMessage(msg, pct, listing) [ Language = javascript ]

Display the message box. This message will store the incoming msg for use as the message default for subsequent calls. If a controller with its own showMessage is present for this pivotTable, dispatch the message display to that method.

itemMouseDown

ClientMethod itemMouseDown(evt, idx) [ Internal, Language = javascript ]

Mouse down handler for nodes.

itemMouseUp

ClientMethod itemMouseUp(evt) [ Internal, Language = javascript ]

Mouse up handler for nodes.

absoluteAdjustLayout

ClientMethod absoluteAdjustLayout() [ Language = javascript ]

adjustCellSize

ClientMethod adjustCellSize(cellid, height, width, top, left, offsetHeight, offsetWidth) [ Language = javascript ]

singleTableAdjustLayout

ClientMethod singleTableAdjustLayout() [ Language = javascript ]

adjustTableLayout

ClientMethod 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.

computeDivSize

ClientMethod computeDivSize(theDiv, isWebKit) [ Internal, Language = javascript ]

Compute and return the size of the given html.

ieLayout

ClientMethod ieLayout() [ Language = javascript ]

Work-around for ie8!

wheelHandler

ClientMethod wheelHandler(evt) [ Language = javascript ]

Mouse wheel handler.

cellScrollVt

ClientMethod cellScrollVt() [ Language = javascript ]

Vertical Scroll handler.

cellScrollHz

ClientMethod cellScrollHz() [ Language = javascript ]

Horizontal Scroll handler..

onloadHandler

ClientMethod onloadHandler() [ Language = javascript ]

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

onupdateHandler

ClientMethod 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.

startQueryTimer

ClientMethod startQueryTimer(needsRefresh) [ Language = javascript ]

Start the timer used to update during query calculation.

stopQueryTimer

ClientMethod stopQueryTimer() [ Language = javascript ]

Stop the query timer.

queryTimerHandler

ClientMethod queryTimerHandler() [ Internal, Language = javascript ]

Internal method.
Timer event handler used by the query timer bar.

GetItemCaption

ClassMethod GetItemCaption(pCubeName As %String, pSpec As %String) As %String [ ZenMethod ]

Return the caption associate with given cube element.

FormatValue

ClassMethod FormatValue(pCubeName As %String, pQueryKey As %String, pValue As %String, pFormattedValue As %ZEN.proxyObject, pRowNo As %Integer, pColNo As %Integer) As %Boolean [ ZenMethod ]

GetItemSpec

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.

getFilterForCells

ClientMethod getFilterForCells(r1, c1, r2, c2, allRows, allCols) [ Language = javascript ]

Return the filter spec for the given cell range.

GetSlicerSpecForCells

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.

GetQueryStatus

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.

GetQueryText

ClassMethod GetQueryText(pCubeName As %String, pQueryKey As %String, pEncrypt As %Boolean = 0) As %String [ ZenMethod ]

Get the MDX text for the current query.

SetCurrentQueryText

Method SetCurrentQueryText(pWhich As %String = "current", pMDX As %String) As %Status [ ZenMethod ]

GetCurrentQueryText

Method GetCurrentQueryText(pWhich As %String) As %String [ ZenMethod ]

KillQuery

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.

showIKnowMeasureValue

ClientMethod showIKnowMeasureValue(cubeName, measure, objId) [ Language = javascript ]

%MaterializeListing

Method %MaterializeListing(pRS As %DeepSee.ResultSet, pSQLRS As %SQL.StatementResult = "") As %Status [ Internal ]

Execute the listing for a drillthrough query and save it to a cache global.
If pSQLRS is provided, use it.

%DrawListing

Method %DrawListing() As %Status [ Internal ]

Draw the listing table for a drillthrough query.
Assume the listing has been materialized to a listing global.

%ShowPlan

Method %ShowPlan(pRS As %DeepSee.ResultSet) As %Status

Show execution plan for the query

%ShowPlanItem

Method %ShowPlanItem(ByRef pPlan, pNodeNo As %Integer, pLevel As %Integer = 0) As %Status

Show one item in a query plan.

filterLabelClick

ClientMethod filterLabelClick(evt, filterValue) [ Language = javascript ]

Click on an item label within the filter dropdown.

pushState

ClientMethod pushState() [ Internal, Language = javascript ]

Push the current state of the pivot onto the "history" stack.

popState

ClientMethod popState() [ Internal, Language = javascript ]

Pop the current state of the pivot from the "history" stack.

copyState

ClientMethod copyState(master) [ Internal, Language = javascript ]

Copy the (most of the) current state of another pivot into this one. Used by linked pivots.

hasFormatRules

ClientMethod hasFormatRules() [ Language = javascript ]

Indicate if there are any formatting rules in play.

canGoBack

ClientMethod canGoBack() [ Language = javascript ]

Indicate if we can go back to a prior state.

goBack

ClientMethod goBack(notify) [ Language = javascript ]

Go back to the previous state.

canGoForward

ClientMethod canGoForward() [ Language = javascript ]

Indicate if we can go forward to a visited state.

goForward

ClientMethod goForward() [ Language = javascript ]

Go forward to the next state (if there is one).

%ClearDataModified

Method %ClearDataModified() [ CodeMode = objectgenerator, Internal ]

Clear the (shadow) modified bit for the data property.

%SetDataModified

Method %SetDataModified() [ CodeMode = objectgenerator, Internal ]

Set the (shadow) modified bit for the data property.

%OnDrawObjectProperties

Method %OnDrawObjectProperties() [ Internal ]

Render the JSON content of the target object along with the other properties of the provider.

%OnObjectSynch

Method %OnObjectSynch() As %Status [ Internal ]

Render the JSON content of the target object along with the other properties of the provider.

%DrawJSON

Method %DrawJSON() As %Status [ Internal ]

Draw JSON output for the current query results.

%OutputJSONForGeoListing

Method %OutputJSONForGeoListing(pRS As %DeepSee.ResultSet, pSQLRS As %SQL.StatementResult = "") As %Status [ Internal ]

Draw JSON output for a geolisting.

%OutputJSONForKPI

Method %OutputJSONForKPI() As %Status [ Internal ]

Draw JSON output for the current KPI class.

getContent

ClientMethod getContent() [ Final, Internal, Language = javascript ]

sendEventToViews

ClientMethod 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.

register

ClientMethod register(component) [ Final, Internal, Language = javascript ]

Internal method.
Establish a connection between this pivotTable and a chart component

unregister

ClientMethod unregister(component) [ Final, Internal, Language = javascript ]

Internal method.
Break the a connection between this pivotTable and a chart component

raiseDataChange

ClientMethod raiseDataChange() [ Final, Language = javascript ]

Send notification to listeners that the data associated with this pivotTable has changed.

getDimensions

ClientMethod getDimensions() [ Internal, Language = javascript ]

Return number of dimensions in this pivot.

getDimSize

ClientMethod getDimSize(dim) [ Final, Language = javascript ]

Return the number of items in the specified dimension (dim is 1,2, or 3).

getDimGrouping

ClientMethod getDimGrouping(dim) [ Final, Internal, Language = javascript ]

Special method: return if the given dimension has hierarchical groupings (to indicate that a chart should display them).

getDataAsArrays

ClientMethod getDataAsArrays() [ Final, Language = javascript ]

This is a specialized variant of getData that return the data in this controller as an array of arrays (used by charts).

getLabel

ClientMethod getLabel(n, dim, noformat) [ Final, Language = javascript ]

Get the label at position n (0-based) in the given dimension (1,2, or 3).

computeCaption

ClientMethod computeCaption(item, noformat) [ Final, Internal, Language = javascript ]

Resolve the caption for a given axis item. (This is used to get logical values for time axis members).

dateFromHorolog

ClientMethod dateFromHorolog(val) [ Language = javascript ]

Convert a $H to yyyy-mm-dd date.

getDimName

ClientMethod getDimName(dim) [ Final, Language = javascript ]

Return a name for the given dimension (1,2, or 3). This provides the axis label for a chart.

getPropertyName

ClientMethod getPropertyName(n) [ Language = javascript ]

Given a 0-based index, return the corresponding property name.

getValueName

ClientMethod getValueName() [ Final, Language = javascript ]

Return a label for the values returned by the data source. This provides the axis label for a chart.

getDataSourceCaption

ClientMethod getDataSourceCaption(which, title) [ Final, Language = javascript ]

Return a title to display for this data source. This provides the title for a chart.

getDataByName

ClientMethod getDataByName(property, series) [ Language = javascript ]

getData

ClientMethod getData(d1, d2, d3) [ Language = javascript ]

dataSet API Return the data contained in the specified location. Location is 0-based;

getFilterInfo

ClientMethod getFilterInfo(fnames, fvalues, flabels) [ Final, 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.

ParseMDXExpression

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.

getPivotVariableInfo

ClientMethod getPivotVariableInfo(pnames, pvalues) [ Final, 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.

getPivotVariablesValues

ClientMethod getPivotVariablesValues(pnames, pvalues) [ Final, Language = javascript ]

Return names and values of 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.

addController

ClientMethod addController(ctrl) [ Internal, Language = javascript ]

Associate a controller component with this pivotTable. This is called by the controller component.

removeController

ClientMethod removeController() [ Internal, Language = javascript ]

Remove the controller component associated with this pivotTable. This is called by the controller component.

updateController

ClientMethod updateController() [ Internal, Language = javascript ]

Update the controller component associated with this pivotTable, if any. This is called internally when the state of the pivot table changes.

updateToolbar

ClientMethod updateToolbar() [ Internal, 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.

%OnNew

Method %OnNew(initvalue As %RawString) As %Status [ Private, ProcedureBlock = 1 ]

getDrillLevel

ClientMethod getDrillLevel() [ Language = javascript ]

Return current drill level for this pivot.

gotoDrillLevel

ClientMethod gotoDrillLevel(idx) [ Language = javascript ]

Go to the given drill level.

removeDrillLevel

ClientMethod removeDrillLevel(idx, evt) [ Language = javascript ]

Remove a drill level. The input parameter idx is the 0-based index of the level to remove.

removeAllDrillLevels

ClientMethod removeAllDrillLevels() [ Language = javascript ]

Clear all current drill levels and reset the table back to its resting state.

setListing

ClientMethod setListing(listing, type) [ Language = javascript ]

Set the name of the listing (and listing type) to show for this pivot.

allClick

ClientMethod allClick(evt) [ Language = javascript ]

Click on all check box (in detail listing).

cbClick

ClientMethod cbClick(evt, currCb) [ Language = javascript ]

Click on checkbox.

allClickPivot

ClientMethod allClickPivot(evt) [ Language = javascript ]

Click on all check box (in pivot).

cbClickPivot

ClientMethod cbClickPivot(evt, currCb) [ Language = javascript ]

Click on checkbox in pivot.

getSelectedItems

ClientMethod 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.

newDataHandler

ClientMethod newDataHandler() [ Language = javascript ]

Notification that new data is available.

computeTotals

ClientMethod computeTotals() [ Language = javascript ]

Compute row and columns totals, as needed.

%GetSummaryFromCSS

ClassMethod %GetSummaryFromCSS(pStyle As %String, Output pAgg As %String) As %String

Parse a CSS style directive and remove any "summary:val" directives within it.

getColumnDescriptors

ClientMethod getColumnDescriptors() [ Language = javascript ]

Return an array of column descriptors for use by a dataGrid connected to this pivot.

processAxisColumns

ClientMethod processAxisColumns(list, groups, tuples) [ Internal, Language = javascript ]

Convert an axis group to descriptors.

getRowDescriptors

ClientMethod getRowDescriptors() [ Language = javascript ]

Return an array of row descriptors for use by a dataGrid connected to this pivot.

processAxisRows

ClientMethod processAxisRows(list, groups, tuples) [ Internal, Language = javascript ]

Convert an axis group to descriptors.

getPageSize

ClientMethod getPageSize() [ Internal, Language = javascript ]

Return total number of pages to support dataGrid paging.

getRecordCount

ClientMethod getRecordCount() [ Internal, Language = javascript ]

Return total number of records to support dataGrid paging.

getCurrPage

ClientMethod getCurrPage() [ Internal, Language = javascript ]

Number of the current "page" when paging (1-based).

setCurrPage

ClientMethod setCurrPage(page) [ Internal, Language = javascript ]

Set the current "page" when paging (1-based).

getRowCaptions

ClientMethod getRowCaptions() [ Internal, Language = javascript ]

Return an array of row captions (shown above headers).

showAllRows

ClientMethod showAllRows() [ Language = javascript ]

Notification that a listing header is double-clicked.

getPropertyDim

ClientMethod getPropertyDim() [ Language = javascript ]

Return the ordinal number of the dimension supplying property names for this controller.

GetPivotVariableData

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.

SynthesizeMDX

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

addPivotCoverPane

ClientMethod addPivotCoverPane(parentDiv) [ Internal, Language = javascript ]

Adds a coverpane to the pivot in the DOM. This is used to disable the pivot interaction.

setPivotDisabled

ClientMethod setPivotDisabled(setDisabled) [ Language = javascript ]

This prevents a user from interacting with the pivot by using the cover pane.

exportToPDF

ClientMethod exportToPDF(parms) [ Language = javascript ]

This entry point triggers an execution and printing of the current table in SVG format.

callbackExportRStoPDF

ClientMethod callbackExportRStoPDF(dc) [ Language = javascript ]

This method is designed to be used as a callback from the DeepSeeDataController. It takes a resultset from the supplied datacontroller and uses it to print to PDF. This method expects the printing parameters needed by the svgImageProvider are supplied in an object dc.parms.

callbackRSPending

ClientMethod callbackRSPending(dc) [ Language = javascript ]

This method is designed to be used as a callback from the DeepSeeDataController. It reports the number of seconds the client has been waiting for the DeepSeeResultSet data to be returned from the server.