This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %DeepSee.Component.pivotTable

%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:

Property Inventory (Including Private)

Method Inventory (Including Private)

Parameters

parameter DEFAULTENCLOSINGCLASS = dsPivotEnclosingDiv;
Inherited description: 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;
Inherited description: This is the XML namespace used for library components.

Properties (Including Private)

property absolutePositioning as %ZEN.Datatype.string [ InitialExpression = 0 ];
Property methods: absolutePositioningDisplayToLogical(), absolutePositioningGet(), absolutePositioningIsValid(), absolutePositioningLogicalToDisplay(), absolutePositioningLogicalToOdbc(), absolutePositioningNormalize(), absolutePositioningSet()
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 methods: analyzerModeDisplayToLogical(), analyzerModeGet(), analyzerModeIsValid(), analyzerModeLogicalToDisplay(), analyzerModeLogicalToOdbc(), analyzerModeLogicalToXSD(), analyzerModeNormalize(), analyzerModeSet(), analyzerModeXSDToLogical()
property autoExecute as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true then automatically execute queries when filters, rows, or columns are changed.
Property methods: autoExecuteDisplayToLogical(), autoExecuteGet(), autoExecuteIsValid(), autoExecuteLogicalToDisplay(), autoExecuteLogicalToOdbc(), autoExecuteLogicalToXSD(), autoExecuteNormalize(), autoExecuteSet(), autoExecuteXSDToLogical()
property backgroundImage as %ZEN.Datatype.uri;
Optional image to show in background of pivot table.
Property methods: backgroundImageDisplayToLogical(), backgroundImageGet(), backgroundImageIsValid(), backgroundImageLogicalToDisplay(), backgroundImageLogicalToOdbc(), backgroundImageNormalize(), backgroundImageSet()
property backgroundOpacity as %ZEN.Datatype.float [ InitialExpression = 0.12 ];
Opacity (0 to 1) of pivot table background image.
Property methods: backgroundOpacityDisplayToLogical(), backgroundOpacityGet(), backgroundOpacityIsValid(), backgroundOpacityLogicalToDisplay(), backgroundOpacityLogicalToOdbc(), backgroundOpacityNormalize(), backgroundOpacitySet()
property borderBottomCell as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Property methods: borderBottomCellDisplayToLogical(), borderBottomCellGet(), borderBottomCellIsValid(), borderBottomCellLogicalToDisplay(), borderBottomCellLogicalToOdbc(), borderBottomCellNormalize(), borderBottomCellSet()
property borderBottomCol as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Property methods: borderBottomColDisplayToLogical(), borderBottomColGet(), borderBottomColIsValid(), borderBottomColLogicalToDisplay(), borderBottomColLogicalToOdbc(), borderBottomColNormalize(), borderBottomColSet()
property borderBottomRow as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Property methods: borderBottomRowDisplayToLogical(), borderBottomRowGet(), borderBottomRowIsValid(), borderBottomRowLogicalToDisplay(), borderBottomRowLogicalToOdbc(), borderBottomRowNormalize(), borderBottomRowSet()
property borderLeftCell as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Table borders
Property methods: borderLeftCellDisplayToLogical(), borderLeftCellGet(), borderLeftCellIsValid(), borderLeftCellLogicalToDisplay(), borderLeftCellLogicalToOdbc(), borderLeftCellNormalize(), borderLeftCellSet()
property borderLeftCol as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Property methods: borderLeftColDisplayToLogical(), borderLeftColGet(), borderLeftColIsValid(), borderLeftColLogicalToDisplay(), borderLeftColLogicalToOdbc(), borderLeftColNormalize(), borderLeftColSet()
property borderLeftRow as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Property methods: borderLeftRowDisplayToLogical(), borderLeftRowGet(), borderLeftRowIsValid(), borderLeftRowLogicalToDisplay(), borderLeftRowLogicalToOdbc(), borderLeftRowNormalize(), borderLeftRowSet()
property borderRightCell as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Property methods: borderRightCellDisplayToLogical(), borderRightCellGet(), borderRightCellIsValid(), borderRightCellLogicalToDisplay(), borderRightCellLogicalToOdbc(), borderRightCellNormalize(), borderRightCellSet()
property borderRightCol as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Property methods: borderRightColDisplayToLogical(), borderRightColGet(), borderRightColIsValid(), borderRightColLogicalToDisplay(), borderRightColLogicalToOdbc(), borderRightColNormalize(), borderRightColSet()
property borderRightRow as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Property methods: borderRightRowDisplayToLogical(), borderRightRowGet(), borderRightRowIsValid(), borderRightRowLogicalToDisplay(), borderRightRowLogicalToOdbc(), borderRightRowNormalize(), borderRightRowSet()
property borderTopCell as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Property methods: borderTopCellDisplayToLogical(), borderTopCellGet(), borderTopCellIsValid(), borderTopCellLogicalToDisplay(), borderTopCellLogicalToOdbc(), borderTopCellNormalize(), borderTopCellSet()
property borderTopCol as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Property methods: borderTopColDisplayToLogical(), borderTopColGet(), borderTopColIsValid(), borderTopColLogicalToDisplay(), borderTopColLogicalToOdbc(), borderTopColNormalize(), borderTopColSet()
property borderTopRow as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Property methods: borderTopRowDisplayToLogical(), borderTopRowGet(), borderTopRowIsValid(), borderTopRowLogicalToDisplay(), borderTopRowLogicalToOdbc(), borderTopRowNormalize(), borderTopRowSet()
property calculatedMembers as list of calculatedMember (XMLNAME = "calculatedMember", XMLPROJECTION = "ELEMENT");
This contains any local calculated members for the table.
Property methods: calculatedMembersBuildValueArray(), calculatedMembersCollectionToDisplay(), calculatedMembersCollectionToOdbc(), calculatedMembersDisplayToCollection(), calculatedMembersGet(), calculatedMembersGetObject(), calculatedMembersGetObjectId(), calculatedMembersGetSwizzled(), calculatedMembersIsValid(), calculatedMembersOdbcToCollection(), calculatedMembersSet(), calculatedMembersSetObject(), calculatedMembersSetObjectId()
property caption as %ZEN.Datatype.string;
Caption to display. If not specified, the caption for the cube will be used.
Property methods: captionDisplayToLogical(), captionGet(), captionIsValid(), captionLogicalToDisplay(), captionLogicalToOdbc(), captionNormalize(), captionSet()
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 methods: cellHeightDisplayToLogical(), cellHeightGet(), cellHeightIsValid(), cellHeightLogicalToDisplay(), cellHeightLogicalToOdbc(), cellHeightNormalize(), cellHeightSet()
property cellStyle as %ZEN.Datatype.style;
Optional style to apply to cells.
Property methods: cellStyleDisplayToLogical(), cellStyleGet(), cellStyleIsValid(), cellStyleLogicalToDisplay(), cellStyleLogicalToOdbc(), cellStyleNormalize(), cellStyleSet()
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 methods: cellWidthDisplayToLogical(), cellWidthGet(), cellWidthIsValid(), cellWidthLogicalToDisplay(), cellWidthLogicalToOdbc(), cellWidthNormalize(), cellWidthSet()
property changesPending as %ZEN.Datatype.boolean (XMLPROJECTION = "none") [ InitialExpression = 0 ];
If autoExecute is off, then this tracks that a refresh is needed.
Property methods: changesPendingDisplayToLogical(), changesPendingGet(), changesPendingIsValid(), changesPendingLogicalToDisplay(), changesPendingLogicalToOdbc(), changesPendingLogicalToXSD(), changesPendingNormalize(), changesPendingSet(), changesPendingXSDToLogical()
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 methods: colorScaleDisplayToLogical(), colorScaleGet(), colorScaleIsValid(), colorScaleLogicalToDisplay(), colorScaleLogicalToOdbc(), colorScaleNormalize(), colorScaleSet()
property columnAxisOptions as pivotLevel;
This is used to define functions to apply to the entire column axis.
Property methods: columnAxisOptionsGet(), columnAxisOptionsGetSwizzled(), columnAxisOptionsIsValid(), columnAxisOptionsNewObject(), columnAxisOptionsSet()
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 methods: columnCountDisplayToLogical(), columnCountGet(), columnCountIsValid(), columnCountLogicalToDisplay(), columnCountLogicalToOdbc(), columnCountNormalize(), columnCountSet()
property columnHeaderStyle as %ZEN.Datatype.style;
Optional style to apply to column headers.
Property methods: columnHeaderStyleDisplayToLogical(), columnHeaderStyleGet(), columnHeaderStyleIsValid(), columnHeaderStyleLogicalToDisplay(), columnHeaderStyleLogicalToOdbc(), columnHeaderStyleNormalize(), columnHeaderStyleSet()
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 methods: columnLabelSpanDisplayToLogical(), columnLabelSpanGet(), columnLabelSpanIsValid(), columnLabelSpanLogicalToDisplay(), columnLabelSpanLogicalToOdbc(), columnLabelSpanLogicalToXSD(), columnLabelSpanNormalize(), columnLabelSpanSet(), columnLabelSpanXSDToLogical()
property columnLevels as list of pivotLevel (XMLNAME = "columnLevel", XMLPROJECTION = "ELEMENT");
This contains the definition of the column dimensions for this pivot table.
Property methods: columnLevelsBuildValueArray(), columnLevelsCollectionToDisplay(), columnLevelsCollectionToOdbc(), columnLevelsDisplayToCollection(), columnLevelsGet(), columnLevelsGetObject(), columnLevelsGetObjectId(), columnLevelsGetSwizzled(), columnLevelsIsValid(), columnLevelsOdbcToCollection(), columnLevelsSet(), columnLevelsSetObject(), columnLevelsSetObjectId()
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 methods: columnListDisplayToLogical(), columnListGet(), columnListIsValid(), columnListLogicalToDisplay(), columnListLogicalToOdbc(), columnListNormalize(), columnListSet()
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 methods: contextFilterSpecDisplayToLogical(), contextFilterSpecGet(), contextFilterSpecIsValid(), contextFilterSpecLogicalToDisplay(), contextFilterSpecLogicalToOdbc(), contextFilterSpecNormalize(), contextFilterSpecSet()
property crossJoinRowLimit as %ZEN.Datatype.integer [ InitialExpression = 2000 ];
Maximum number of rows to display for a CROSSJOIN.
Property methods: crossJoinRowLimitDisplayToLogical(), crossJoinRowLimitGet(), crossJoinRowLimitIsValid(), crossJoinRowLimitLogicalToDisplay(), crossJoinRowLimitLogicalToOdbc(), crossJoinRowLimitNormalize(), crossJoinRowLimitSet()
property cubeName as %ZEN.Datatype.className (ZENEXPRESSION = 1);
Name of the cube that will provide data for this pivot table.
Property methods: cubeNameDisplayToLogical(), cubeNameGet(), cubeNameIsValid(), cubeNameLogicalToDisplay(), cubeNameLogicalToOdbc(), cubeNameNormalize(), cubeNameSet()
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 methods: currListingPageDisplayToLogical(), currListingPageGet(), currListingPageIsValid(), currListingPageLogicalToDisplay(), currListingPageLogicalToOdbc(), currListingPageNormalize(), currListingPageSet()
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 methods: currPageDisplayToLogical(), currPageGet(), currPageIsValid(), currPageLogicalToDisplay(), currPageLogicalToOdbc(), currPageNormalize(), currPageSet()
property currentQueryText as array of %DeepSee.Component.queryChunk;
Text of most recently executed query
Property methods: currentQueryTextBuildValueArray(), currentQueryTextCollectionToDisplay(), currentQueryTextCollectionToOdbc(), currentQueryTextDisplayToCollection(), currentQueryTextGet(), currentQueryTextGetObject(), currentQueryTextGetObjectId(), currentQueryTextGetSwizzled(), currentQueryTextIsValid(), currentQueryTextOdbcToCollection(), currentQueryTextSet(), currentQueryTextSetObject(), currentQueryTextSetObjectId()
property dataSource as %ZEN.Datatype.string (VALUELIST = ",manual,automatic") [ InitialExpression = "automatic" ];
Specifies how this pivot table gets data from a DeepSee source.
Property methods: dataSourceDisplayToLogical(), dataSourceGet(), dataSourceIsValid(), dataSourceLogicalToDisplay(), dataSourceLogicalToOdbc(), dataSourceNameDisplayToLogical(), dataSourceNameGet(), dataSourceNameIsValid(), dataSourceNameLogicalToDisplay(), dataSourceNameLogicalToOdbc(), dataSourceNameNormalize(), dataSourceNameSet(), dataSourceNormalize(), dataSourceSet()
property drillLevels as list of pivotLevel (XMLNAME = "drillLevel", XMLPROJECTION = "ELEMENT");
This contains the current set of "drill into" levels for this pivot table.
Property methods: drillLevelsBuildValueArray(), drillLevelsCollectionToDisplay(), drillLevelsCollectionToOdbc(), drillLevelsDisplayToCollection(), drillLevelsGet(), drillLevelsGetObject(), drillLevelsGetObjectId(), drillLevelsGetSwizzled(), drillLevelsIsValid(), drillLevelsOdbcToCollection(), drillLevelsSet(), drillLevelsSetObject(), drillLevelsSetObjectId()
property drillRowNumbers as list of %ZEN.Datatype.string (XMLPROJECTION = "NONE");
Property methods: drillRowNumbersBuildValueArray(), drillRowNumbersCollectionToDisplay(), drillRowNumbersCollectionToOdbc(), drillRowNumbersDisplayToCollection(), drillRowNumbersDisplayToLogical(), drillRowNumbersGet(), drillRowNumbersGetObject(), drillRowNumbersGetObjectId(), drillRowNumbersGetSwizzled(), drillRowNumbersIsValid(), drillRowNumbersLogicalToDisplay(), drillRowNumbersLogicalToOdbc(), drillRowNumbersNormalize(), drillRowNumbersOdbcToCollection(), drillRowNumbersSet(), drillRowNumbersSetObject(), drillRowNumbersSetObjectId()
property evenRowStyle as %ZEN.Datatype.style;
Optional style to apply to even rows in zebra stripe mode.
Property methods: evenRowStyleDisplayToLogical(), evenRowStyleGet(), evenRowStyleIsValid(), evenRowStyleLogicalToDisplay(), evenRowStyleLogicalToOdbc(), evenRowStyleNormalize(), evenRowStyleSet()
property filterTableCaptionStyle as %ZEN.Datatype.style (XMLPROJECTION = "attribute");
filterTableCaptionStyle;
Property methods: filterTableCaptionStyleDisplayToLogical(), filterTableCaptionStyleGet(), filterTableCaptionStyleIsValid(), filterTableCaptionStyleLogicalToDisplay(), filterTableCaptionStyleLogicalToOdbc(), filterTableCaptionStyleNormalize(), filterTableCaptionStyleSet()
property filterTableItemStyle as %ZEN.Datatype.style (XMLPROJECTION = "attribute");
filterTableItemStyle;
Property methods: filterTableItemStyleDisplayToLogical(), filterTableItemStyleGet(), filterTableItemStyleIsValid(), filterTableItemStyleLogicalToDisplay(), filterTableItemStyleLogicalToOdbc(), filterTableItemStyleNormalize(), filterTableItemStyleSet()
property filterTableStyle as %ZEN.Datatype.style (XMLPROJECTION = "attribute");
filterTableStyle
Property methods: filterTableStyleDisplayToLogical(), filterTableStyleGet(), filterTableStyleIsValid(), filterTableStyleLogicalToDisplay(), filterTableStyleLogicalToOdbc(), filterTableStyleNormalize(), filterTableStyleSet()
property filters as list of pivotLevel (XMLNAME = "filter", XMLPROJECTION = "ELEMENT");
This contains the definition of the filters for this pivot table.
Property methods: filtersBuildValueArray(), filtersCollectionToDisplay(), filtersCollectionToOdbc(), filtersDisplayToCollection(), filtersGet(), filtersGetObject(), filtersGetObjectId(), filtersGetSwizzled(), filtersIsValid(), filtersOdbcToCollection(), filtersSet(), filtersSetObject(), filtersSetObjectId()
property fontFamilyCell as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Property methods: fontFamilyCellDisplayToLogical(), fontFamilyCellGet(), fontFamilyCellIsValid(), fontFamilyCellLogicalToDisplay(), fontFamilyCellLogicalToOdbc(), fontFamilyCellNormalize(), fontFamilyCellSet()
property fontFamilyCol as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Property methods: fontFamilyColDisplayToLogical(), fontFamilyColGet(), fontFamilyColIsValid(), fontFamilyColLogicalToDisplay(), fontFamilyColLogicalToOdbc(), fontFamilyColNormalize(), fontFamilyColSet()
property fontFamilyRow as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Property methods: fontFamilyRowDisplayToLogical(), fontFamilyRowGet(), fontFamilyRowIsValid(), fontFamilyRowLogicalToDisplay(), fontFamilyRowLogicalToOdbc(), fontFamilyRowNormalize(), fontFamilyRowSet()
property fontSizeCell as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Property methods: fontSizeCellDisplayToLogical(), fontSizeCellGet(), fontSizeCellIsValid(), fontSizeCellLogicalToDisplay(), fontSizeCellLogicalToOdbc(), fontSizeCellNormalize(), fontSizeCellSet()
property fontSizeCol as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Property methods: fontSizeColDisplayToLogical(), fontSizeColGet(), fontSizeColIsValid(), fontSizeColLogicalToDisplay(), fontSizeColLogicalToOdbc(), fontSizeColNormalize(), fontSizeColSet()
property fontSizeRow as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Property methods: fontSizeRowDisplayToLogical(), fontSizeRowGet(), fontSizeRowIsValid(), fontSizeRowLogicalToDisplay(), fontSizeRowLogicalToOdbc(), fontSizeRowNormalize(), fontSizeRowSet()
property formatRules as list of pivotCondition (XMLNAME = "formatRule", XMLPROJECTION = "ELEMENT");
This contains any conditional formatting rules for the table.
Property methods: formatRulesBuildValueArray(), formatRulesCollectionToDisplay(), formatRulesCollectionToOdbc(), formatRulesDisplayToCollection(), formatRulesGet(), formatRulesGetObject(), formatRulesGetObjectId(), formatRulesGetSwizzled(), formatRulesIsValid(), formatRulesOdbcToCollection(), formatRulesSet(), formatRulesSetObject(), formatRulesSetObjectId()
property headFunctionAdded as %ZEN.Datatype.integer (XMLPROJECTION = "NONE") [ InitialExpression = 0 ];
Flag to indicate a HEAD function has been added to an axis by the Analyzer
Property methods: headFunctionAddedDisplayToLogical(), headFunctionAddedGet(), headFunctionAddedIsValid(), headFunctionAddedLogicalToDisplay(), headFunctionAddedLogicalToOdbc(), headFunctionAddedNormalize(), headFunctionAddedSet()
property hiddenMeasureText as list of %ZEN.Datatype.string (XMLPROJECTION = "ELEMENT");
Property methods: hiddenMeasureTextBuildValueArray(), hiddenMeasureTextCollectionToDisplay(), hiddenMeasureTextCollectionToOdbc(), hiddenMeasureTextDisplayToCollection(), hiddenMeasureTextDisplayToLogical(), hiddenMeasureTextGet(), hiddenMeasureTextGetObject(), hiddenMeasureTextGetObjectId(), hiddenMeasureTextGetSwizzled(), hiddenMeasureTextIsValid(), hiddenMeasureTextLogicalToDisplay(), hiddenMeasureTextLogicalToOdbc(), hiddenMeasureTextNormalize(), hiddenMeasureTextOdbcToCollection(), hiddenMeasureTextSet(), hiddenMeasureTextSetObject(), hiddenMeasureTextSetObjectId()
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 methods: hideMeasuresDisplayToLogical(), hideMeasuresGet(), hideMeasuresIsValid(), hideMeasuresLogicalToDisplay(), hideMeasuresLogicalToOdbc(), hideMeasuresNormalize(), hideMeasuresSet()
property initialExecute as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, then automatically execute queries when this pivot is first displayed.
Property methods: initialExecuteDisplayToLogical(), initialExecuteGet(), initialExecuteIsValid(), initialExecuteLogicalToDisplay(), initialExecuteLogicalToOdbc(), initialExecuteLogicalToXSD(), initialExecuteNormalize(), initialExecuteSet(), initialExecuteXSDToLogical()
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 methods: isDrillThroughDisplayToLogical(), isDrillThroughGet(), isDrillThroughIsValid(), isDrillThroughLogicalToDisplay(), isDrillThroughLogicalToOdbc(), isDrillThroughLogicalToXSD(), isDrillThroughNormalize(), isDrillThroughSet(), isDrillThroughXSDToLogical()
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 methods: jsonRowsDisplayToLogical(), jsonRowsGet(), jsonRowsIsValid(), jsonRowsLogicalToDisplay(), jsonRowsLogicalToOdbc(), jsonRowsNormalize(), jsonRowsSet()
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 methods: kpiDisplayToLogical(), kpiGet(), kpiIsValid(), kpiLogicalToDisplay(), kpiLogicalToOdbc(), kpiNormalize(), kpiSet()
property listing as %ZEN.Datatype.string;
Name of listing to use for detail listing. If empty, the default listing is used.
Property methods: listingDisplayToLogical(), listingEnabledDisplayToLogical(), listingEnabledGet(), listingEnabledIsValid(), listingEnabledLogicalToDisplay(), listingEnabledLogicalToOdbc(), listingEnabledLogicalToXSD(), listingEnabledNormalize(), listingEnabledSet(), listingEnabledXSDToLogical(), listingFieldsBuildValueArray(), listingFieldsCollectionToDisplay(), listingFieldsCollectionToOdbc(), listingFieldsDisplayToCollection(), listingFieldsGet(), listingFieldsGetObject(), listingFieldsGetObjectId(), listingFieldsGetSwizzled(), listingFieldsIsValid(), listingFieldsOdbcToCollection(), listingFieldsSet(), listingFieldsSetObject(), listingFieldsSetObjectId(), listingFiltersBuildValueArray(), listingFiltersCollectionToDisplay(), listingFiltersCollectionToOdbc(), listingFiltersDisplayToCollection(), listingFiltersGet(), listingFiltersGetObject(), listingFiltersGetObjectId(), listingFiltersGetSwizzled(), listingFiltersIsValid(), listingFiltersOdbcToCollection(), listingFiltersSet(), listingFiltersSetObject(), listingFiltersSetObjectId(), listingFontSizeDisplayToLogical(), listingFontSizeGet(), listingFontSizeIsValid(), listingFontSizeLogicalToDisplay(), listingFontSizeLogicalToOdbc(), listingFontSizeNormalize(), listingFontSizeSet(), listingGet(), listingHeaderDblClickHandler(), listingIsValid(), listingKeyDisplayToLogical(), listingKeyGet(), listingKeyIsValid(), listingKeyLogicalToDisplay(), listingKeyLogicalToOdbc(), listingKeyNormalize(), listingKeySet(), listingLogicalToDisplay(), listingLogicalToOdbc(), listingNormalize(), listingPageSizeDisplayToLogical(), listingPageSizeGet(), listingPageSizeIsValid(), listingPageSizeLogicalToDisplay(), listingPageSizeLogicalToOdbc(), listingPageSizeNormalize(), listingPageSizeSet(), listingRowCountDisplayToLogical(), listingRowCountGet(), listingRowCountIsValid(), listingRowCountLogicalToDisplay(), listingRowCountLogicalToOdbc(), listingRowCountNormalize(), listingRowCountSet(), listingRowsDisplayToLogical(), listingRowsGet(), listingRowsIsValid(), listingRowsLogicalToDisplay(), listingRowsLogicalToOdbc(), listingRowsNormalize(), listingRowsSet(), listingSelectDisplayToLogical(), listingSelectGet(), listingSelectIsValid(), listingSelectLogicalToDisplay(), listingSelectLogicalToOdbc(), listingSelectNormalize(), listingSelectSet(), listingSet(), listingSortColumnDisplayToLogical(), listingSortColumnGet(), listingSortColumnIsValid(), listingSortColumnLogicalToDisplay(), listingSortColumnLogicalToOdbc(), listingSortColumnNormalize(), listingSortColumnSet(), listingSortDirDisplayToLogical(), listingSortDirGet(), listingSortDirIsValid(), listingSortDirLogicalToDisplay(), listingSortDirLogicalToOdbc(), listingSortDirNormalize(), listingSortDirSet(), listingTypeDisplayToLogical(), listingTypeGet(), listingTypeIsValid(), listingTypeLogicalToDisplay(), listingTypeLogicalToOdbc(), listingTypeNormalize(), listingTypeSet()
property listingEnabled as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, then listings are enabled for this pivot.
Property methods: listingEnabledDisplayToLogical(), listingEnabledGet(), listingEnabledIsValid(), listingEnabledLogicalToDisplay(), listingEnabledLogicalToOdbc(), listingEnabledLogicalToXSD(), listingEnabledNormalize(), listingEnabledSet(), listingEnabledXSDToLogical()
property listingFontSize as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Font fize used in listing
Property methods: listingFontSizeDisplayToLogical(), listingFontSizeGet(), listingFontSizeIsValid(), listingFontSizeLogicalToDisplay(), listingFontSizeLogicalToOdbc(), listingFontSizeNormalize(), listingFontSizeSet()
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 methods: listingPageSizeDisplayToLogical(), listingPageSizeGet(), listingPageSizeIsValid(), listingPageSizeLogicalToDisplay(), listingPageSizeLogicalToOdbc(), listingPageSizeNormalize(), listingPageSizeSet()
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 methods: listingRowCountDisplayToLogical(), listingRowCountGet(), listingRowCountIsValid(), listingRowCountLogicalToDisplay(), listingRowCountLogicalToOdbc(), listingRowCountNormalize(), listingRowCountSet()
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 methods: listingRowsDisplayToLogical(), listingRowsGet(), listingRowsIsValid(), listingRowsLogicalToDisplay(), listingRowsLogicalToOdbc(), listingRowsNormalize(), listingRowsSet()
property listingSelect as %ZEN.Datatype.string (VALUELIST = ",single,multi");
Specifies the select mode for a detail listing: none, "single", or "multi".
Property methods: listingSelectDisplayToLogical(), listingSelectGet(), listingSelectIsValid(), listingSelectLogicalToDisplay(), listingSelectLogicalToOdbc(), listingSelectNormalize(), listingSelectSet()
property listingSortColumn as %ZEN.Datatype.integer [ InitialExpression = 0 ];
If not 0, then sort the listing table by the values within this column.
Property methods: listingSortColumnDisplayToLogical(), listingSortColumnGet(), listingSortColumnIsValid(), listingSortColumnLogicalToDisplay(), listingSortColumnLogicalToOdbc(), listingSortColumnNormalize(), listingSortColumnSet()
property listingSortDir as %ZEN.Datatype.string (VALUELIST = "ASC,DESC") [ InitialExpression = "ASC" ];
If listing column sorting is on, then this is the sort direction.
Property methods: listingSortDirDisplayToLogical(), listingSortDirGet(), listingSortDirIsValid(), listingSortDirLogicalToDisplay(), listingSortDirLogicalToOdbc(), listingSortDirNormalize(), listingSortDirSet()
property maxChartSize as %ZEN.Datatype.integer (XMLPROJECTION = "NONE") [ InitialExpression = 400 ];
Certain chart types may have different maximum sizes that make sense.
Property methods: maxChartSizeDisplayToLogical(), maxChartSizeGet(), maxChartSizeIsValid(), maxChartSizeLogicalToDisplay(), maxChartSizeLogicalToOdbc(), maxChartSizeNormalize(), maxChartSizeSet()
property maxRows as %ZEN.Datatype.integer (XMLPROJECTION = "attribute");
Max rows exported to PDF
Property methods: maxRowsDisplayToLogical(), maxRowsGet(), maxRowsIsValid(), maxRowsLogicalToDisplay(), maxRowsLogicalToOdbc(), maxRowsNormalize(), maxRowsSet()
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 methods: mdxDisplayToLogical(), mdxGet(), mdxIsValid(), mdxLogicalToDisplay(), mdxLogicalToOdbc(), mdxNormalize(), mdxSet()
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 methods: measureLocationDisplayToLogical(), measureLocationGet(), measureLocationIsValid(), measureLocationLogicalToDisplay(), measureLocationLogicalToOdbc(), measureLocationNormalize(), measureLocationSet()
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 methods: measuresBuildValueArray(), measuresCollectionToDisplay(), measuresCollectionToOdbc(), measuresDisplayToCollection(), measuresGet(), measuresGetObject(), measuresGetObjectId(), measuresGetSwizzled(), measuresIsValid(), measuresOdbcToCollection(), measuresSet(), measuresSetObject(), measuresSetObjectId()
property nowDisplayFormat as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
nowDisplayFormat
Property methods: nowDisplayFormatDisplayToLogical(), nowDisplayFormatGet(), nowDisplayFormatIsValid(), nowDisplayFormatLogicalToDisplay(), nowDisplayFormatLogicalToOdbc(), nowDisplayFormatNormalize(), nowDisplayFormatSet()
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 methods: oncellClickDisplayToLogical(), oncellClickGet(), oncellClickIsValid(), oncellClickLogicalToDisplay(), oncellClickLogicalToOdbc(), oncellClickNormalize(), oncellClickSet()
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 methods: oncellDblClickDisplayToLogical(), oncellDblClickGet(), oncellDblClickIsValid(), oncellDblClickLogicalToDisplay(), oncellDblClickLogicalToOdbc(), oncellDblClickNormalize(), oncellDblClickSet()
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 methods: ondrillDisplayToLogical(), ondrillGet(), ondrillIsValid(), ondrillLogicalToDisplay(), ondrillLogicalToOdbc(), ondrillNormalize(), ondrillSet()
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 methods: onlistingSelectDisplayToLogical(), onlistingSelectGet(), onlistingSelectIsValid(), onlistingSelectLogicalToDisplay(), onlistingSelectLogicalToOdbc(), onlistingSelectNormalize(), onlistingSelectSet()
property overrideColumnSpec as %ZEN.Datatype.string (XMLPROJECTION = "NONE");
Externally applied COLUMNS spec. This should contain a valid MDX expression (without "ON COLUMNS").
Property methods: overrideColumnSpecDisplayToLogical(), overrideColumnSpecGet(), overrideColumnSpecIsValid(), overrideColumnSpecLogicalToDisplay(), overrideColumnSpecLogicalToOdbc(), overrideColumnSpecNormalize(), overrideColumnSpecSet()
property overrideColumnText as %ZEN.Datatype.string (XMLPROJECTION = "NONE");
Text value associated with overrideColumnSpec. Used as a label.
Property methods: overrideColumnTextDisplayToLogical(), overrideColumnTextGet(), overrideColumnTextIsValid(), overrideColumnTextLogicalToDisplay(), overrideColumnTextLogicalToOdbc(), overrideColumnTextNormalize(), overrideColumnTextSet()
property overrideRowSpec as %ZEN.Datatype.string (XMLPROJECTION = "NONE");
Externally applied ROWS spec. This should contain a valid MDX expression (without "ON ROWS").
Property methods: overrideRowSpecDisplayToLogical(), overrideRowSpecGet(), overrideRowSpecIsValid(), overrideRowSpecLogicalToDisplay(), overrideRowSpecLogicalToOdbc(), overrideRowSpecNormalize(), overrideRowSpecSet()
property overrideRowText as %ZEN.Datatype.string (XMLPROJECTION = "NONE");
Text value associated with overrideRowSpec. Used as a label.
Property methods: overrideRowTextDisplayToLogical(), overrideRowTextGet(), overrideRowTextIsValid(), overrideRowTextLogicalToDisplay(), overrideRowTextLogicalToOdbc(), overrideRowTextNormalize(), overrideRowTextSet()
property pageSize as %ZEN.Datatype.integer [ InitialExpression = 100 ];
Number of pivot result rows to show at one time.
Property methods: pageSizeDisplayToLogical(), pageSizeGet(), pageSizeIsValid(), pageSizeLogicalToDisplay(), pageSizeLogicalToOdbc(), pageSizeNormalize(), pageSizeSet()
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 methods: parametersBuildValueArray(), parametersCollectionToDisplay(), parametersCollectionToOdbc(), parametersDisplayToCollection(), parametersGet(), parametersGetObject(), parametersGetObjectId(), parametersGetSwizzled(), parametersIsValid(), parametersOdbcToCollection(), parametersSet(), parametersSetObject(), parametersSetObjectId()
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 methods: pivotSelectDisplayToLogical(), pivotSelectGet(), pivotSelectIsValid(), pivotSelectLogicalToDisplay(), pivotSelectLogicalToOdbc(), pivotSelectNormalize(), pivotSelectSet()
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 methods: printCellWidthDisplayToLogical(), printCellWidthGet(), printCellWidthIsValid(), printCellWidthLogicalToDisplay(), printCellWidthLogicalToOdbc(), printCellWidthNormalize(), printCellWidthSet()
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 methods: printLabelWidthDisplayToLogical(), printLabelWidthGet(), printLabelWidthIsValid(), printLabelWidthLogicalToDisplay(), printLabelWidthLogicalToOdbc(), printLabelWidthNormalize(), printLabelWidthSet()
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 methods: printMarginBottomDisplayToLogical(), printMarginBottomGet(), printMarginBottomIsValid(), printMarginBottomLogicalToDisplay(), printMarginBottomLogicalToOdbc(), printMarginBottomNormalize(), printMarginBottomSet()
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 methods: printMarginLeftDisplayToLogical(), printMarginLeftGet(), printMarginLeftIsValid(), printMarginLeftLogicalToDisplay(), printMarginLeftLogicalToOdbc(), printMarginLeftNormalize(), printMarginLeftSet()
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 methods: printMarginRightDisplayToLogical(), printMarginRightGet(), printMarginRightIsValid(), printMarginRightLogicalToDisplay(), printMarginRightLogicalToOdbc(), printMarginRightNormalize(), printMarginRightSet()
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 methods: printMarginTopDisplayToLogical(), printMarginTopGet(), printMarginTopIsValid(), printMarginTopLogicalToDisplay(), printMarginTopLogicalToOdbc(), printMarginTopNormalize(), printMarginTopSet()
property printOrientation as %ZEN.Datatype.string (XMLPROJECTION = "attribute") [ InitialExpression = 1 ];
Orientation when pivot is printed: "portrait" or "landscape".
Property methods: printOrientationDisplayToLogical(), printOrientationGet(), printOrientationIsValid(), printOrientationLogicalToDisplay(), printOrientationLogicalToOdbc(), printOrientationNormalize(), printOrientationSet()
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 methods: printPageSizeDisplayToLogical(), printPageSizeGet(), printPageSizeIsValid(), printPageSizeLogicalToDisplay(), printPageSizeLogicalToOdbc(), printPageSizeNormalize(), printPageSizeSet()
property printSubtitle as %ZEN.Datatype.string (MAXLEN = 2000, XMLPROJECTION = "attribute");
Subtitle to display when pivot is printed.
Property methods: printSubtitleDisplayToLogical(), printSubtitleGet(), printSubtitleIsValid(), printSubtitleLogicalToDisplay(), printSubtitleLogicalToOdbc(), printSubtitleNormalize(), printSubtitleOnDisplayToLogical(), printSubtitleOnGet(), printSubtitleOnIsValid(), printSubtitleOnLogicalToDisplay(), printSubtitleOnLogicalToOdbc(), printSubtitleOnNormalize(), printSubtitleOnSet(), printSubtitleSet()
property printSubtitleOn as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Display the subtitle when exporting to PDF
Property methods: printSubtitleOnDisplayToLogical(), printSubtitleOnGet(), printSubtitleOnIsValid(), printSubtitleOnLogicalToDisplay(), printSubtitleOnLogicalToOdbc(), printSubtitleOnNormalize(), printSubtitleOnSet()
property printTitle as %ZEN.Datatype.string (MAXLEN = 2000, XMLPROJECTION = "attribute");
Title to display when pivot is printed.
Property methods: printTitleDisplayToLogical(), printTitleGet(), printTitleIsValid(), printTitleLogicalToDisplay(), printTitleLogicalToOdbc(), printTitleNormalize(), printTitleSet()
property reinitialized as %ZEN.Datatype.boolean (XMLPROJECTION = "none") [ InitialExpression = 0 ];
Property methods: reinitializedDisplayToLogical(), reinitializedGet(), reinitializedIsValid(), reinitializedLogicalToDisplay(), reinitializedLogicalToOdbc(), reinitializedLogicalToXSD(), reinitializedNormalize(), reinitializedSet(), reinitializedXSDToLogical()
property resolvedQueryText as array of %DeepSee.Component.queryChunk;
Resolved text of most recently executed query
Property methods: resolvedQueryTextBuildValueArray(), resolvedQueryTextCollectionToDisplay(), resolvedQueryTextCollectionToOdbc(), resolvedQueryTextDisplayToCollection(), resolvedQueryTextGet(), resolvedQueryTextGetObject(), resolvedQueryTextGetObjectId(), resolvedQueryTextGetSwizzled(), resolvedQueryTextIsValid(), resolvedQueryTextOdbcToCollection(), resolvedQueryTextSet(), resolvedQueryTextSetObject(), resolvedQueryTextSetObjectId()
property rowAxisOptions as pivotLevel;
This is used to define functions to apply to the entire row axis.
Property methods: rowAxisOptionsGet(), rowAxisOptionsGetSwizzled(), rowAxisOptionsIsValid(), rowAxisOptionsNewObject(), rowAxisOptionsSet()
property rowCaptionList as list of %ZEN.Datatype.string (XMLPROJECTION = "ELEMENT");
Property methods: rowCaptionListBuildValueArray(), rowCaptionListCollectionToDisplay(), rowCaptionListCollectionToOdbc(), rowCaptionListDisplayToCollection(), rowCaptionListDisplayToLogical(), rowCaptionListGet(), rowCaptionListGetObject(), rowCaptionListGetObjectId(), rowCaptionListGetSwizzled(), rowCaptionListIsValid(), rowCaptionListLogicalToDisplay(), rowCaptionListLogicalToOdbc(), rowCaptionListNormalize(), rowCaptionListOdbcToCollection(), rowCaptionListSet(), rowCaptionListSetObject(), rowCaptionListSetObjectId()
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 methods: rowCountDisplayToLogical(), rowCountGet(), rowCountIsValid(), rowCountLogicalToDisplay(), rowCountLogicalToOdbc(), rowCountNormalize(), rowCountSet()
property rowHeaderStyle as %ZEN.Datatype.style;
Optional style to apply to row headers.
Property methods: rowHeaderStyleDisplayToLogical(), rowHeaderStyleGet(), rowHeaderStyleIsValid(), rowHeaderStyleLogicalToDisplay(), rowHeaderStyleLogicalToOdbc(), rowHeaderStyleNormalize(), rowHeaderStyleSet()
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 methods: rowLabelSpanDisplayToLogical(), rowLabelSpanGet(), rowLabelSpanIsValid(), rowLabelSpanLogicalToDisplay(), rowLabelSpanLogicalToOdbc(), rowLabelSpanLogicalToXSD(), rowLabelSpanNormalize(), rowLabelSpanSet(), rowLabelSpanXSDToLogical()
property rowLevels as list of pivotLevel (XMLNAME = "rowLevel", XMLPROJECTION = "ELEMENT");
This contains the definition of the row dimensions for this pivot table.
Property methods: rowLevelsBuildValueArray(), rowLevelsCollectionToDisplay(), rowLevelsCollectionToOdbc(), rowLevelsDisplayToCollection(), rowLevelsGet(), rowLevelsGetObject(), rowLevelsGetObjectId(), rowLevelsGetSwizzled(), rowLevelsIsValid(), rowLevelsOdbcToCollection(), rowLevelsSet(), rowLevelsSetObject(), rowLevelsSetObjectId()
property selectedCellBackground as %ZEN.Datatype.style [ InitialExpression = "rgb(47,98,128)" ];
Background color applied to the selected cell range.
Property methods: selectedCellBackgroundDisplayToLogical(), selectedCellBackgroundGet(), selectedCellBackgroundIsValid(), selectedCellBackgroundLogicalToDisplay(), selectedCellBackgroundLogicalToOdbc(), selectedCellBackgroundNormalize(), selectedCellBackgroundSet()
property selectedCellColor as %ZEN.Datatype.style [ InitialExpression = "white" ];
Color applied to the selected cell range.
Property methods: selectedCellColorDisplayToLogical(), selectedCellColorGet(), selectedCellColorIsValid(), selectedCellColorLogicalToDisplay(), selectedCellColorLogicalToOdbc(), selectedCellColorNormalize(), selectedCellColorSet()
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 methods: selectedRangeDisplayToLogical(), selectedRangeGet(), selectedRangeIsValid(), selectedRangeLogicalToDisplay(), selectedRangeLogicalToOdbc(), selectedRangeNormalize(), selectedRangeSet()
property showDate as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
showDate - on, off
Property methods: showDateDisplayToLogical(), showDateGet(), showDateIsValid(), showDateLogicalToDisplay(), showDateLogicalToOdbc(), showDateNormalize(), showDateSet()
property showEmptyColumns as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, display columns containing only empty values.
If mdx is specified, this is ignored.
Property methods: showEmptyColumnsDisplayToLogical(), showEmptyColumnsGet(), showEmptyColumnsIsValid(), showEmptyColumnsLogicalToDisplay(), showEmptyColumnsLogicalToOdbc(), showEmptyColumnsLogicalToXSD(), showEmptyColumnsNormalize(), showEmptyColumnsSet(), showEmptyColumnsXSDToLogical()
property showEmptyRows as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, display rows containing only empty values.
If mdx is specified, this is ignored.
Property methods: showEmptyRowsDisplayToLogical(), showEmptyRowsGet(), showEmptyRowsIsValid(), showEmptyRowsLogicalToDisplay(), showEmptyRowsLogicalToOdbc(), showEmptyRowsLogicalToXSD(), showEmptyRowsNormalize(), showEmptyRowsSet(), showEmptyRowsXSDToLogical()
property showFilters as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
showFilters - byTable, byTitle, off
Property methods: showFiltersDisplayToLogical(), showFiltersGet(), showFiltersIsValid(), showFiltersLogicalToDisplay(), showFiltersLogicalToOdbc(), showFiltersNormalize(), showFiltersSet()
property showListingFilters as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
showListingFilters - on, off
Property methods: showListingFiltersDisplayToLogical(), showListingFiltersGet(), showListingFiltersIsValid(), showListingFiltersLogicalToDisplay(), showListingFiltersLogicalToOdbc(), showListingFiltersNormalize(), showListingFiltersSet()
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 methods: showPivotDisplayToLogical(), showPivotGet(), showPivotIsValid(), showPivotLogicalToDisplay(), showPivotLogicalToOdbc(), showPivotLogicalToXSD(), showPivotNormalize(), showPivotSet(), showPivotStatsDisplayToLogical(), showPivotStatsGet(), showPivotStatsIsValid(), showPivotStatsLogicalToDisplay(), showPivotStatsLogicalToOdbc(), showPivotStatsLogicalToXSD(), showPivotStatsNormalize(), showPivotStatsSet(), showPivotStatsXSDToLogical(), showPivotXSDToLogical()
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 methods: showPivotStatsDisplayToLogical(), showPivotStatsGet(), showPivotStatsIsValid(), showPivotStatsLogicalToDisplay(), showPivotStatsLogicalToOdbc(), showPivotStatsLogicalToXSD(), showPivotStatsNormalize(), showPivotStatsSet(), showPivotStatsXSDToLogical()
property showPlan as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, execute a show plan for the query.
Property methods: showPlanDisplayToLogical(), showPlanGet(), showPlanIsValid(), showPlanLogicalToDisplay(), showPlanLogicalToOdbc(), showPlanLogicalToXSD(), showPlanNormalize(), showPlanSet(), showPlanXSDToLogical()
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 methods: showQueryDisplayToLogical(), showQueryGet(), showQueryIsValid(), showQueryLogicalToDisplay(), showQueryLogicalToOdbc(), showQueryLogicalToXSD(), showQueryNormalize(), showQuerySet(), showQueryXSDToLogical()
property showRowCaption as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, show a caption above the row headers.
Property methods: showRowCaptionDisplayToLogical(), showRowCaptionGet(), showRowCaptionIsValid(), showRowCaptionLogicalToDisplay(), showRowCaptionLogicalToOdbc(), showRowCaptionLogicalToXSD(), showRowCaptionNormalize(), showRowCaptionSet(), showRowCaptionXSDToLogical()
property showStatus as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
If true, show status area along the bottom of the table.
Property methods: showStatusDisplayToLogical(), showStatusGet(), showStatusIsValid(), showStatusLogicalToDisplay(), showStatusLogicalToOdbc(), showStatusLogicalToXSD(), showStatusNormalize(), showStatusSet(), showStatusXSDToLogical()
property showUser as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
Display the user when exporting to PDF
Property methods: showUserDisplayToLogical(), showUserGet(), showUserIsValid(), showUserLogicalToDisplay(), showUserLogicalToOdbc(), showUserNormalize(), showUserSet()
property showZebra as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, show zebra striping.
Property methods: showZebraDisplayToLogical(), showZebraGet(), showZebraIsValid(), showZebraLogicalToDisplay(), showZebraLogicalToOdbc(), showZebraLogicalToXSD(), showZebraNormalize(), showZebraSet(), showZebraStripesDisplayToLogical(), showZebraStripesGet(), showZebraStripesIsValid(), showZebraStripesLogicalToDisplay(), showZebraStripesLogicalToOdbc(), showZebraStripesNormalize(), showZebraStripesSet(), showZebraXSDToLogical()
property showZebraStripes as %ZEN.Datatype.string (XMLPROJECTION = "attribute");
showZebraStripes - on, off
Property methods: showZebraStripesDisplayToLogical(), showZebraStripesGet(), showZebraStripesIsValid(), showZebraStripesLogicalToDisplay(), showZebraStripesLogicalToOdbc(), showZebraStripesNormalize(), showZebraStripesSet()
property singleTable as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Property methods: singleTableAdjustLayout(), singleTableDisplayToLogical(), singleTableGet(), singleTableIsValid(), singleTableLogicalToDisplay(), singleTableLogicalToOdbc(), singleTableLogicalToXSD(), singleTableNormalize(), singleTableSet(), singleTableXSDToLogical()
property sortColumn as %ZEN.Datatype.integer [ InitialExpression = 0 ];
If not 0, then sort the results by the values within this column.
Property methods: sortColumnDisplayToLogical(), sortColumnGet(), sortColumnIsValid(), sortColumnLogicalToDisplay(), sortColumnLogicalToOdbc(), sortColumnNormalize(), sortColumnSet()
property sortDir as %ZEN.Datatype.string (VALUELIST = "ASC,DESC") [ InitialExpression = "ASC" ];
If column sorting is on, then this is the sort direction.
Property methods: sortDirDisplayToLogical(), sortDirGet(), sortDirIsValid(), sortDirLogicalToDisplay(), sortDirLogicalToOdbc(), sortDirNormalize(), sortDirSet()
property staleCache as %ZEN.Datatype.boolean (XMLPROJECTION = "none") [ InitialExpression = 0 ];
Property methods: staleCacheDisplayToLogical(), staleCacheGet(), staleCacheIsValid(), staleCacheLogicalToDisplay(), staleCacheLogicalToOdbc(), staleCacheLogicalToXSD(), staleCacheNormalize(), staleCacheSet(), staleCacheXSDToLogical()
property tableStyle as %ZEN.Datatype.style [ InitialExpression = "background-color:white" ];
Optional style to apply to entire table
Property methods: tableStyleDisplayToLogical(), tableStyleGet(), tableStyleIsValid(), tableStyleLogicalToDisplay(), tableStyleLogicalToOdbc(), tableStyleNormalize(), tableStyleSet()
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 methods: userMDXDisplayToLogical(), userMDXGet(), userMDXIsValid(), userMDXLogicalToDisplay(), userMDXLogicalToOdbc(), userMDXNormalize(), userMDXSet()
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.
Property methods: valueColumnDisplayToLogical(), valueColumnGet(), valueColumnIsValid(), valueColumnLogicalToDisplay(), valueColumnLogicalToOdbc(), valueColumnNormalize(), valueColumnSet()

Methods (Including Private)

method %CalculateSpans(ByRef pTopTableHTML, ByRef pSideTableHTML, Output pRowSpan, Output pColSpan, Output pFirstSpan=0) as %Status
method %CollectMeasures(pQueryKey As %String, Output pCollectedMeasures As %String, pListingFilters As %Boolean) as %Status
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 %DrawKPITable() as %Status
Draw table using KPI class as a source.
method %DrawNub(ByRef pNub, pRowSpan As %String, pColSpan As %String, pFirstSpan As %String) as %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
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 %HideMeasures() as %Boolean
Return true if the Measures setting stipulates the measures should be hidden from view.
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.
private method %OnNew(initvalue As %String) as %Status
Inherited description: Constructor for Zen objects.
If subclasses override %OnNew, they should make sure to invoke this using #super.
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 SetCurrentQueryText(pWhich As %String = "current", pMDX As %String) as %Status [ ZenMethod ]
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
clientmethod absoluteAdjustLayout() [ Language = javascript ]
clientmethod adjustCellSize(cellid, height, width, top, left, offsetHeight, offsetWidth) [ Language = javascript ]
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.
clientmethod allClick(evt) [ Language = javascript ]
Click on all check box (in detail listing).
clientmethod allClickPivot(evt) [ Language = javascript ]
Click on all check box (in pivot).
clientmethod callFormatValue(value, formattedValue, rowItem, columnItem) [ Language = javascript ]
Used to provide label related info when required.
clientmethod callGetItemSpec(labelInfo, rowItem, columnItem) [ Language = javascript ]
Used to provide label related info when required.
clientmethod canDrillThrough() [ Language = javascript ]
Test if this pivot supports drill through.
clientmethod canGoBack() [ Language = javascript ]
Indicate if we can go back to a prior state.
clientmethod canGoForward() [ Language = javascript ]
Indicate if we can go forward to a visited state.
clientmethod cancelQuery() [ Language = javascript ]
Cancel the current query for this pivot table and update the display.
clientmethod cbClick(evt, currCb) [ Language = javascript ]
Click on checkbox.
clientmethod cbClickPivot(evt, currCb) [ Language = javascript ]
Click on checkbox in pivot.
clientmethod cellClickHandler(evt, row, col) [ Language = javascript ]
Notification that a cell is clicked.
row and col give the ordinal (logical) position of the cell.
clientmethod cellDblClickHandler(evt, row, col) [ Language = javascript ]
Notification that a cell is double-clicked.
row and col give the ordinal position of the cell.
clientmethod cellMouseDownHandler(evt) [ Language = javascript ]
Mouse down within a cell. Try to prevent text select when selecting multiple cells.
clientmethod cellScrollHz() [ Language = javascript ]
Horizontal Scroll handler..
clientmethod cellScrollVt() [ Language = javascript ]
Vertical Scroll handler.
clientmethod columnClickHandler(evt, col) [ Language = javascript ]
Notification that a column header is clicked.
clientmethod columnDblClickHandler(evt, col) [ Language = javascript ]
Notification that a column header is double-clicked.
clientmethod computeTotals() [ Language = javascript ]
Compute row and columns totals, as needed.
clientmethod dateFromHorolog(val) [ Language = javascript ]
Convert a $H to yyyy-mm-dd date.
clientmethod dragFinishHandler(dragData) [ Language = javascript ]
This is called when a drag operation started within this component is completed.
clientmethod dragStartHandler(dragData) [ Language = javascript ]
Built-in drag handler for pivot table component. Let the user drag the selected node.
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.
clientmethod dropStartHandler(dragData) [ Language = javascript ]
Drop handler. This is called when an item is dropped onto the table.
clientmethod executeListing() [ Language = javascript ]
Execute a drill through for the current selected cell.
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.
clientmethod filterLabelClick(evt, filterValue) [ Language = javascript ]
Click on an item label within the filter dropdown.
clientmethod firstPage() [ Language = javascript ]
For multi-page display, go to the first page.
clientmethod getColumnDescriptors() [ Language = javascript ]
Return an array of column descriptors for use by a dataGrid connected to this pivot.
clientmethod getData(d1, d2, d3) [ Language = javascript ]
dataSet API Return the data contained in the specified location. Location is 0-based;
final clientmethod 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).
clientmethod getDataByName(property, series) [ Language = javascript ]
final clientmethod getDataSourceCaption(which, title) [ Language = javascript ]
Return a title to display for this data source. This provides the title for a chart.
final clientmethod getDimName(dim) [ Language = javascript ]
Return a name for the given dimension (0,1, or 2). This provides the axis label for a chart.
final clientmethod getDimSize(dim) [ Language = javascript ]
Return the number of items in the specified dimension (dim is 1,2, or 3).
clientmethod getDrillLevel() [ Language = javascript ]
Return current drill level for this pivot.
clientmethod getFilterForCells(r1, c1, r2, c2, allRows, allCols) [ Language = javascript ]
Return the filter spec for the given cell range.
final clientmethod 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 clientmethod getLabel(n, dim, noformat) [ Language = javascript ]
Get the label at position n (0-based) in the given dimension (1,2, or 3).
clientmethod getListingPageCount() [ Language = javascript ]
For multi-page listing display, calculate the number of pages.
clientmethod getPageCount() [ Language = javascript ]
For multi-page display, calculate the number of pages.
final clientmethod 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.
clientmethod getPropertyDim() [ Language = javascript ]
Return the ordinal number of the dimension supplying property names for this controller.
clientmethod getPropertyName(n) [ Language = javascript ]
Given a 0-based index, return the corresponding property name.
clientmethod getRowDescriptors() [ Language = javascript ]
Return an array of row descriptors for use by a dataGrid connected to this pivot.
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.
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.
final clientmethod getValueName() [ Language = javascript ]
Return a label for the values returned by the data source. This provides the axis label for a chart.
clientmethod goBack(notify) [ Language = javascript ]
Go back to the previous state.
clientmethod goForward() [ Language = javascript ]
Go forward to the next state (if there is one).
clientmethod gotoDrillLevel(idx) [ Language = javascript ]
Go to the given drill level.
clientmethod gotoPage(page) [ Language = javascript ]
For multi-page display, go to specified page (1 is first page), if possible.
clientmethod hasFormatRules() [ Language = javascript ]
Indicate if there are any formatting rules in play.
clientmethod hideMessage() [ Language = javascript ]
Hide the message box.
clientmethod ieLayout() [ Language = javascript ]
Work-around for ie8!
clientmethod lastPage() [ Language = javascript ]
For multi-page display, go to the last page.
clientmethod listingHeaderDblClickHandler(evt, col) [ Language = javascript ]
Notification that a listing header is double-clicked.
clientmethod newDataHandler() [ Language = javascript ]
Notification that new data is available.
clientmethod nextPage() [ Language = javascript ]
For multi-page display, go to next page, if possible.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
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.
clientmethod previousPage() [ Language = javascript ]
For multi-page display, go to previous page, if possible.
final clientmethod raiseDataChange() [ Language = javascript ]
Send notification to listeners that the data associated with this pivotTable has changed.
clientmethod removeAllDrillLevels() [ Language = javascript ]
Clear all current drill levels and reset the table back to its resting state.
clientmethod removeDrillLevel(idx, evt) [ Language = javascript ]
Remove a drill level. The input parameter idx is the 0-based index of the level to remove.
clientmethod removeMeasureLabels(values, measureCaption) [ Language = javascript ]
clientmethod resetTable() [ Language = javascript ]
Reset this table to default settings.
clientmethod rowClickHandler(evt, row) [ Language = javascript ]
Notification that a row header is clicked.
clientmethod rowDblClickHandler(evt, level, row) [ Language = javascript ]
Notification that a row header is double clicked.
clientmethod selectCellRange(startRow, startCol, endRow, endCol, allRows, allCols, selectOnly) [ Language = javascript ]
Set the selected cell range. Addresses are 1-based.
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.
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.
clientmethod setListing(listing, type) [ Language = javascript ]
Set the name of the listing (and listing type) to show for this pivot.
clientmethod setProperty(property, value, value2) [ Language = javascript ]
Set the value of a named property.
clientmethod showAllRows() [ Language = javascript ]
Notification that a listing header is double-clicked.
clientmethod showIKnowMeasureValue(cubeName, measure, objId) [ Language = javascript ]
clientmethod showMDXQuery() [ Language = javascript ]
Toggle display of the current query.
clientmethod showMessage(msg, pct, listing) [ Language = javascript ]
Display the message box. (or display message within pivot controller, if present).
clientmethod showPendingMsg(flag, msg) [ Language = javascript ]
Show (or hide) the "computing..." message.
clientmethod singleTableAdjustLayout() [ Language = javascript ]
clientmethod startQueryTimer(needsRefresh) [ Language = javascript ]
Start the timer used to update during query calculation.
clientmethod stopQueryTimer() [ Language = javascript ]
Stop the query timer.
clientmethod swapRowsAndColumns() [ Language = javascript ]
Swap the row and column definitions for this table and refresh it.
clientmethod wheelHandler(evt) [ Language = javascript ]
Mouse wheel handler.

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

Subclasses

FeedbackOpens in a new window