Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [%SYS] >  [%DeepSee] >  [Dashboard] >  [Pivot]
Private  Storage   

persistent class %DeepSee.Dashboard.Pivot extends %DeepSee.UserLibrary.FolderItem

This persistent class represents a saved DeepSee pivot table.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 88 6


Summary

Properties
ReadOnly Timestamp autoExecute backgroundImage
backgroundOpacity bookCover borderBottomCell borderBottomCol
borderBottomRow borderLeftCell borderLeftCol borderLeftRow
borderRightCell borderRightCol borderRightRow borderTopCell
borderTopCol borderTopRow calculatedMembers caption
category cellHeight cellStyle cellWidth
chartMarginBottom chartMarginLeft chartMarginRight chartMarginTop
colorScale columnAxisOptions columnHeaderStyle columnLabelSpan
columnLevels columnTotalAgg columnTotals createdBy
cubeName description documentName drillLevels
filterTableCaptionStyle filterTableItemStyle filterTableStyle filters
folder folderName fontFamilyCell fontFamilyCol
fontFamilyRow fontSizeCell fontSizeCol fontSizeRow
formatRules fullName hideMeasures keywords
listing listingFields listingFilters listingFontSize
listingRows locked manualMode maxRows
mdx measureLocation measures name
nowDisplayFormat owner pageSize previewMode
printCellWidth printLabelWidth printMarginBottom printMarginLeft
printMarginRight printMarginTop printOrientation printPageSize
printSubtitle printSubtitleOn printTitle public
resource rowAxisOptions rowHeaderStyle rowLabelSpan
rowLevels rowTotalAgg rowTotalSource rowTotals
shared showDate showEmptyColumns showEmptyRows
showFilters showListingFilters showRowCaption showStatus
showUser showZebra showZebraStripes sqlRestriction
timeCreated timeModified title userMDX

Methods
%AddToSaveSet %AddToSyncSet %BMEBuilt %BuildIndicesAsync
%BuildIndicesAsyncResponse %CheckConstraints %CheckConstraintsForExtent %CheckResource
%ClassIsLatestVersion %ClassName %ComposeOid %ConstructClone
%Delete %DeleteExtent %DeleteId %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %Dump %Exists
%ExistsId %Extends %GUID %GUIDSet
%GetCoverSpec %GetCubeName %GetDependencies %GetIcon
%GetLargeIcon %GetLock %GetParameter %GetResource
%GetSwizzleObject %GetTypeName %GetURL %Id
%InsertBatch %IsA %IsModified %IsNull
%KillExtent %KillExtentData %LoadFromMemory %LockExtent
%LockId %New %NormalizeObject %ObjectIsNull
%ObjectModified %Oid %OnAfterImport %OnBeforeAddToSync
%OnDetermineClass %Open %OpenId %OriginalNamespace
%PackageName %ParseFullName %PhysicalAddress %PurgeIndices
%Reload %RemoveFromSaveSet %ResolveConcurrencyConflict %RollBack
%Save %SaveDirect %SaveIndices %SerializeObject
%SetModified %SortBegin %SortEnd %SyncObjectIn
%SyncTransport %UnlockExtent %UnlockId %ValidateIndices
%ValidateObject XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType documentNameGet folderNameGet folderNameSet
fullNameFromDocumentName fullNameGet fullNameSet


Parameters

• parameter ICON = "deepsee/ds2_layers2_44.png";
URL of icon for this item
• parameter ITEMTYPE = "pivot";
This is the extension returned by this type from the Finder.
• parameter LARGEICON = "deepsee/ds2_layers2_44.png";
URL of large icon for this item
• parameter PUBLIC = 0;
Default value of public property for the class.
• parameter XMLNAME = "pivot";
This parameter provides the default XMLNAME for the class. If it is empty then the class name will be used to construct a default XML name. The default XMLNAME is used as the top level tag when exporting objects and the export context did not provide an XML container name.

Properties

• property autoExecute as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
pivotTable autoExecute flag.
• property backgroundImage as %ZEN.Datatype.uri;
Optional image to show in background of pivot table.
• property backgroundOpacity as %ZEN.Datatype.float [ InitialExpression = 0.12 ];
Opacity (0 to 1) of pivot table background image.
• property borderBottomCell as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property borderBottomCol as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property borderBottomRow as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property borderLeftCell as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Table borders
• property borderLeftCol as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property borderLeftRow as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property borderRightCell as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property borderRightCol as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property borderRightRow as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property borderTopCell as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property borderTopCol as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property borderTopRow as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property calculatedMembers as list of CalculatedMember(XMLNAME="calculatedMember",XMLPROJECTION="ELEMENT");
This contains the (local) calculated memmers for this pivot table.
• property caption as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Caption to display. If not specified, the caption for the cube will be used.
• 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.
• property cellStyle as %ZEN.Datatype.style(XMLPROJECTION="attribute");
Optional style to apply to cells.
• property cellWidth as %ZEN.Datatype.integer(XMLPROJECTION="attribute") [ InitialExpression = 120 ];
This is the width (in pixels) used for all cells within the table.
• 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.
• 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.
• 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.
• 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.
• property colorScale as %ZEN.Datatype.string;
If set, this is the name of the color-scaling scheme to apply. red-to-black,green-to-black,blue-to-black,salmon-to-black,purple-to-black,gray-to-black or "custom:r1,g1,b1:r2,g2,b2".
• property columnAxisOptions as PivotLevel;
This is used to define functions to apply to the entire column axis.
• property columnHeaderStyle as %ZEN.Datatype.style(XMLPROJECTION="attribute");
Optional style to apply to column headers.
• 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.
• property columnLevels as list of PivotLevel(XMLNAME="columnLevel",XMLPROJECTION="ELEMENT");
This contains the definition of the column dimensions for this pivot table.
• property columnTotalAgg as %ZEN.Datatype.string(XMLPROJECTION="attribute") [ InitialExpression = "sum" ];
Aggregate for column totals.
• property columnTotals as %ZEN.Datatype.boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];
If true, then display column totals.
• property cubeName as %ZEN.Datatype.className(XMLPROJECTION="attribute");
Name of the cube that will provide data for this pivot table.
• property drillLevels as list of PivotLevel(XMLNAME="drillLevel",XMLPROJECTION="ELEMENT");
This contains the drillLevels for this pivot table.
• property filterTableCaptionStyle as %ZEN.Datatype.style(XMLPROJECTION="attribute");
filterTableCaptionStyle;
• property filterTableItemStyle as %ZEN.Datatype.style(XMLPROJECTION="attribute");
filterTableItemStyle;
• property filterTableStyle as %ZEN.Datatype.style(XMLPROJECTION="attribute");
filterTableStyle
• property filters as list of PivotLevel(XMLNAME="filter",XMLPROJECTION="ELEMENT");
This contains the definition of the filters for this pivot table.
• property fontFamilyCell as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Table styles
• property fontFamilyCol as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property fontFamilyRow as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property fontSizeCell as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property fontSizeCol as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property fontSizeRow as %ZEN.Datatype.string(XMLPROJECTION="attribute");
• property formatRules as list of PivotCondition(XMLNAME="formatRule",XMLPROJECTION="ELEMENT");
This contains the formatting rule for this pivot table.
• property hideMeasures as %ZEN.Datatype.string(XMLPROJECTION="attribute");
hide measure captions or not for pivot.
• 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.
• property listingFields as list of PivotLevel(XMLNAME="listingField",XMLPROJECTION="ELEMENT");
This contains the definition of the listing fields for this pivot table.
• property listingFilters as list of PivotLevel(XMLNAME="listingFilter",XMLPROJECTION="ELEMENT");
This contains the definition of the listing filters for this pivot table.
• property listingFontSize as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Font size for listings
• property listingRows as %ZEN.Datatype.integer(XMLPROJECTION="attribute");
Maximum number of rows to show in a listing. If not specified, the default value used.
• property manualMode as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
pivotTable manualMode (dataSource) flag.
• property maxRows as %ZEN.Datatype.integer(XMLPROJECTION="attribute");
Max rows exported to PDF
• 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.
• property measureLocation as %ZEN.Datatype.string(XMLPROJECTION="attribute");
measureLocation for pivot.
• property measures as list of PivotLevel(XMLNAME="measure",XMLPROJECTION="ELEMENT");
This contains the default measure(s) (e.g., "[Measures].[Sales]") to show for this pivot table.
• property nowDisplayFormat as %ZEN.Datatype.string(XMLPROJECTION="attribute");
nowDisplayFormat
• property pageSize as %ZEN.Datatype.integer(XMLPROJECTION="attribute") [ InitialExpression = 100 ];
Number of result rows to show at one time.
• 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.
• property printCellWidth as %ZEN.Datatype.float(XMLPROJECTION="attribute");
Width of data cells when the pivot is printed. This is in the same units as the page size.
• property printLabelWidth as %ZEN.Datatype.float(XMLPROJECTION="attribute");
Width of row labels when the pivot is printed. This is in the same units as the page size.
• property printMarginBottom as %ZEN.Datatype.float(XMLPROJECTION="attribute");
Page bottom margin when pivot is printed. This is in the same units as the page size.
• property printMarginLeft as %ZEN.Datatype.float(XMLPROJECTION="attribute");
Page left margin when pivot is printed. This is in the same units as the page size.
• property printMarginRight as %ZEN.Datatype.float(XMLPROJECTION="attribute");
Page right margin when pivot is printed. This is in the same units as the page size.
• property printMarginTop as %ZEN.Datatype.float(XMLPROJECTION="attribute");
Page top margin when pivot is printed. This is in the same units as the page size.
• property printOrientation as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Orientation when pivot is printed.
• property printPageSize as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Page size when pivot is printed. This takes the form "8.5x11 in" (w x h).
• property printSubtitle as %ZEN.Datatype.string(MAXLEN=2000,XMLPROJECTION="attribute");
Subtitle to display when pivot is printed.
• property printSubtitleOn as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Display subtitle when exporting to PDF
• property printTitle as %ZEN.Datatype.string(MAXLEN=2000,XMLPROJECTION="attribute");
Title to display when pivot is printed.
• property rowAxisOptions as PivotLevel;
This is used to define functions to apply to the entire row axis.
• property rowHeaderStyle as %ZEN.Datatype.style(XMLPROJECTION="attribute");
Optional style to apply to row headers.
• 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.
• property rowLevels as list of PivotLevel(XMLNAME="rowLevel",XMLPROJECTION="ELEMENT");
This contains the definition of the row dimensions for this pivot table.
• property rowTotalAgg as %ZEN.Datatype.string(XMLPROJECTION="attribute") [ InitialExpression = "sum" ];
Aggregate for row totals.
• property rowTotalSource as %ZEN.Datatype.string(XMLPROJECTION="attribute") [ InitialExpression = "page" ];
Where row totals come from.
• property rowTotals as %ZEN.Datatype.boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];
If true, then display row totals.
• property showDate as %ZEN.Datatype.string(XMLPROJECTION="attribute");
showDate - on, off
• 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.
• 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.
• property showFilters as %ZEN.Datatype.string(XMLPROJECTION="attribute");
showFilters - byTable, byTitle, off
• property showListingFilters as %ZEN.Datatype.string(XMLPROJECTION="attribute");
showListingFilters - on, off
• property showRowCaption as %ZEN.Datatype.boolean(XMLPROJECTION="attribute") [ InitialExpression = 1 ];
If true, then display row captions.
• property showStatus as %ZEN.Datatype.boolean(XMLPROJECTION="attribute") [ InitialExpression = 1 ];
If true, show status area along the bottom of the table.
• property showUser as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Display the user when exporting to PDF
• property showZebra as %ZEN.Datatype.boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];
If true, then display zebra striping.
• property showZebraStripes as %ZEN.Datatype.string(XMLPROJECTION="attribute");
showZebraStripes - on, off
• property sqlRestriction as %ZEN.Datatype.string(XMLNAME="sqlRestriction",XMLPROJECTION="ELEMENT");
This contains an SQL restriction that should be applied to this pivot table.
• property userMDX as %ZEN.Datatype.string(MAXLEN=5000);
pivotTable manualMode query.

Methods

• method %GetCubeName() as %String
Return the cube name that provides data for this pivot.
• method %GetDependencies(pList As %String) as %Status
Return a list of all other folder items (including cubes or kpis) that this item depends upon.
• method %GetTypeName() as %String
Return the localized type name for this item.
• method %GetURL() as %String
Return the URL for this item.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.