DocBook|Search
Class Reference
%DeepSee.Dashboard.Pivot
   
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%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 46 6


Summary

Properties
autoExecute calculatedMembers caption cellHeight
cellStyle cellWidth colorScale columnAxisOptions
columnHeaderStyle columnLabelSpan columnLevels columnTotalAgg
columnTotals createdBy cubeName description
documentName drillLevels filters folder
folderName formatRules fullName keywords
listing listingRows locked manualMode
mdx measures name owner
pageSize printCellWidth printLabelWidth printMarginBottom
printMarginLeft printMarginRight printMarginTop printOrientation
printPageSize printSubtitle printTitle public
resource rowAxisOptions rowHeaderStyle rowLabelSpan
rowLevels rowTotalAgg rowTotalSource rowTotals
shared showEmptyColumns showEmptyRows showRowCaption
showStatus showZebra timeCreated timeModified
title userMDX

Methods
%%OIDGet %AddToSaveSet %AddToSyncSet %BMEBuilt
%BuildIndices %CheckResource %CheckUnique %ClassIsLatestVersion
%ClassName %ComposeOid %ConstructClone %Delete
%DeleteExtent %DeleteId %DispatchClassMethod %DispatchGetModified
%DispatchGetProperty %DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty
%DispatchSetProperty %Dump %Exists %ExistsId
%Extends %GUID %GUIDSet %GetCubeName
%GetDependencies %GetIcon %GetLargeIcon %GetLock
%GetParameter %GetResource %GetSwizzleObject %GetTypeName
%GetURL %Id %InsertBatch %IsA
%IsModified %KillExtent %KillExtentData %LoadFromMemory
%LockExtent %LockId %New %NormalizeObject
%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 %ValidateObject
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
documentNameGet folderNameGet folderNameSet fullNameFromDocumentName
fullNameGet fullNameSet


Parameters

• parameter ICON = "deepsee/ds2_bank_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_bank_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 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 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 filters as list of PivotLevel(XMLNAME="filter",XMLPROJECTION="ELEMENT");
This contains the definition of the filters for this pivot table.
• property formatRules as list of PivotCondition(XMLNAME="formatRule",XMLPROJECTION="ELEMENT");
This contains the formatting rule for this pivot table.
• 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 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 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 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 pageSize as %ZEN.Datatype.integer(XMLPROJECTION="attribute") [ InitialExpression = 100 ];
Number of result rows to show at one time.
• 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 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 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 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 showZebra as %ZEN.Datatype.boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];
If true, then display zebra striping.
• 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.