%DeepSee.Dashboard.Pivot

Class %DeepSee.Dashboard.Pivot Extends %DeepSee.UserLibrary.FolderItem [ System = 4 ]

This persistent class represents a saved DeepSee pivot table.

Parameters

XMLNAME

Parameter XMLNAME = "pivot";

ITEMTYPE

Parameter ITEMTYPE = "pivot";

ICON

Parameter ICON = "deepsee/ds2_layers2_44.png";

LARGEICON

Parameter LARGEICON = "deepsee/ds2_layers2_44.png";

PUBLIC

Parameter PUBLIC = 0;

Default value of public property for the class.

Properties

mdx

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

If defined and dataSource is set to "manual", then this is the MDX statement used to provide the contents of the pivot table.

cellWidth

Property cellWidth As %ZEN.Datatype.integer(XMLPROJECTION = "attribute") [ InitialExpression = 120 ];

This is the width (in pixels) used for all cells within the table.

columnHeaderStyle

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

Optional style to apply to column headers.

rowHeaderStyle

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

Optional style to apply to row headers.

cellStyle

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

Optional style to apply to cells.

rowLabelSpan

Property rowLabelSpan As %ZEN.Datatype.boolean(XMLPROJECTION = "attribute") [ 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(XMLPROJECTION = "attribute") [ 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(XMLPROJECTION = "attribute") [ 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(XMLPROJECTION = "attribute") [ InitialExpression = 0 ];

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

showEmptyColumns

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

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

cubeName

Property cubeName As %ZEN.Datatype.className(XMLPROJECTION = "attribute");

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

caption

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

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

listing

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

Name of listing to use for detail listings. If not specified, the default listing for the cube will be used.

listingRows

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

Maximum number of rows to show in a listing. If not specified, the default value used.

showStatus

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

If true, show status area along the bottom of the 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.

listingFilters

Property listingFilters As list Of PivotLevel(XMLNAME = "listingFilter", XMLPROJECTION = "ELEMENT");

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

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.

canDrillDown

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

drillLevels

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

This contains the drillLevels for this pivot table.

listingFields

Property listingFields As list Of PivotLevel(XMLNAME = "listingField", XMLPROJECTION = "ELEMENT");

This contains the definition of the listing fields for this pivot table.

formatRules

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

This contains the formatting rule for this pivot table.

pageSize

Property pageSize As %ZEN.Datatype.integer(XMLPROJECTION = "attribute") [ InitialExpression = 100 ];

Number of result rows to show at one time.

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

rowTotals

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

If true, then display row totals.

columnTotals

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

If true, then display column totals.

rowTotalAgg

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

Aggregate for row totals.

columnTotalAgg

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

Aggregate for column totals.

rowTotalSource

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

Where row totals come from.

calculatedMembers

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

This contains the (local) calculated memmers for this pivot table.

showZebra

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

If true, then display zebra striping.

showRowCaption

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

If true, then display row captions.

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.

printSubtitleOn

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

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

printOrientation

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

Orientation when pivot is printed.

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.

autoExecute

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

pivotTable autoExecute flag.

previewMode

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

Save of previewMode setting. The Analyzer will transfer this value to the previewMode property, widgets will not.

manualMode

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

pivotTable manualMode (dataSource) flag.

userMDX

Property userMDX As %ZEN.Datatype.string(MAXLEN = 5000);

pivotTable manualMode query.

chartMarginTop

Property chartMarginTop As %ZEN.Datatype.float(XMLPROJECTION = "attribute");

Page top margin when chart is printed. This is in the same units as the page size.

chartMarginLeft

Property chartMarginLeft As %ZEN.Datatype.float(XMLPROJECTION = "attribute");

Page left margin when chart is printed. This is in the same units as the page size.

chartMarginRight

Property chartMarginRight As %ZEN.Datatype.float(XMLPROJECTION = "attribute");

Page right margin when chart is printed. This is in the same units as the page size.

chartMarginBottom

Property chartMarginBottom As %ZEN.Datatype.float(XMLPROJECTION = "attribute");

Page bottom margin when chart 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");

Table styles

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

listingFontSize

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

Font size for listings

showZebraStripes

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

showZebraStripes - on, off

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

measureLocation

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

measureLocation for pivot.

hideMeasures

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

hide measure captions or not for pivot.

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.

Methods

%CopyToComponent

Method %CopyToComponent(pPivot As %DeepSee.Component.pivotTable) As %Status [ Internal ]

Copy the contents of this pivot definition to pivot table pPivot.

%CopyFromComponent

Method %CopyFromComponent(pPivot As %DeepSee.Component.pivotTable) As %Status [ Internal ]

Set the contents of this pivot definition from pivot table pPivot.

%CopyToDao

Method %CopyToDao(Output pPivotJSON As %DynamicObject) As %Status

Copy the contents of this pivot definition to an Dao.

%GetDependencies

Method %GetDependencies(pList As %String) As %Status

Return a list of all other folder items (including cubes or kpis) that this item depends upon.

%GetCubeName

Method %GetCubeName() As %String

Return the cube name that provides data for this pivot.

%GetURL

Method %GetURL() As %String

Return the URL for this item.

%GetTypeName

Method %GetTypeName() As %String

Return the localized type name for this item.