Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / %DeepSee.Dashboard.PivotLevel
Private  Storage   

%DeepSee.Dashboard.PivotLevel


serial class %DeepSee.Dashboard.PivotLevel extends
%SerialObject, %XML.Adaptor

This class defines a level within a DeepSee saved pivot.
This is used to fill in the values of a pivotLevel within a DeepSee pivot table.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 29


Summary


Properties
advanced aggEnabled aggFunction aggFunctionParm
childLevels drillLevel drilldownSpec enabled
filterEnabled filterExpression headCount headEnabled
key levelCaption levelFormat levelHeaderStyle
levelStyle levelSummary levelType orderDirection
orderEnabled orderExpression spec suppress8020
text value

Methods
%AddToSaveSet %AddToSyncSet %ClassIsLatestVersion %ClassName
%ConstructClone %Delete %DeleteId %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %Extends %GetParameter
%GetSwizzleObject %IsA %IsModified %IsNull
%New %NormalizeObject %ObjectIsNull %ObjectModified
%OnBeforeAddToSync %OnDetermineClass %Open %OpenId
%OriginalNamespace %PackageName %RemoveFromSaveSet %ResolveConcurrencyConflict
%SerializeObject %SetModified %SyncObjectIn %SyncTransport
%ValidateObject LogicalToOdbc OdbcToLogical XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType


Parameters


• parameter NAMESPACE = "http://www.intersystems.com/deepsee/library";
NAMESPACE specifies the XML namespace to be used when projecting the class to XML. if NAMESPACE - "", the default namespace is used for the XML schema is used as the namespace for his class.
• parameter XMLIGNORENULL = 1;
XMLIGNORENULL allows the programmer to override the default XML handling of empty strings for properties of type %String. By default (XMLIGNORENULL = 0), empty strings in the XML input are stored as $c(0) and $c(0) is written to XML as an empty tag. A missing tag in the XML input is always stored as "" and "" is always output to XML as no tag.

If XMLIGNORENULL is set = 1, then both missing tags in the XML and empty strings are input as "", and both "" and $c(0) are output as empty tags (i.e. <tag></tag>).

If XMLIGNORENULL is set = "inputonly", then both missing tags in the XML and empty strings are input as "". Output of "" and $c(0) are for XMLIGNORENULL = 0: $c(0) is output as an empty tag (i.e. <tag></tag>) and "" is output as no tag.

If XMLIGNORENULL = "runtime" (runtime is not case sensitive), then the behavior of XMLIGNORENULL is determined by the format parameter of XMLExport, XMLImport and %XML.Reader.OpenFile. The default behavior for XMLIGNORENULL="runtime is the same as XMLIGNORENULL=0. Adding "ignorenull" to the format argument changes the behavior to that of XMLIGNORENULL=1. "ignorenull" shoud be separated by a comma from literal/encoded part of the format. Example values for format are "", ",ignorenull", "literal,ignorenull" and "encoded,ignorenull". Note that "inputonly" is equivalent to using ,ignorenull for XMLExport and not for %XML.Reader.
• 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 advanced as %ZEN.Datatype.boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];
If true, this is an advanced filter.
• property aggEnabled as %ZEN.Datatype.boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];
If true, apply the Aggregate function to this level.
• property aggFunction as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Aggregate function.
• property aggFunctionParm as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Aggregate function parameter.
• property childLevels as list of PivotLevel(XMLELEMENTREF=1,XMLPROJECTION="ELEMENT");
Children of this level.
• property drillLevel as %ZEN.Datatype.integer(XMLPROJECTION="attribute") [ InitialExpression = 0 ];
Drill-level at which this level was defined.
• property drilldownSpec as %ZEN.Datatype.string(MAXLEN="",XMLPROJECTION="attribute");
If defined, this is a ^-delimited list of MDX expressions to use when drilling (double-clicking) on a member defined by this level.
• property enabled as %ZEN.Datatype.boolean(XMLPROJECTION="attribute") [ InitialExpression = 1 ];
If true, this level is enabled. Only applies to filters at this time.
• property filterEnabled as %ZEN.Datatype.boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];
If true, apply the FILTER function to this level.
• property filterExpression as %ZEN.Datatype.string(MAXLEN="",XMLPROJECTION="attribute");
Filter expression for FILTER function.
• property headCount as %ZEN.Datatype.integer(XMLPROJECTION="attribute");
Count argument for HEAD function.
• property headEnabled as %ZEN.Datatype.boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];
If true, apply the HEAD function to this level.
• property key as %ZEN.Datatype.string(MAXLEN="",XMLPROJECTION="attribute");
Key value of the current dimension level.
This can be a comma-delimited list of keys: "14,25"
• property levelCaption as %ZEN.Datatype.string(MAXLEN="",XMLPROJECTION="attribute");
Optional caption to apply to this element.
• property levelFormat as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Optional format to apply to this element.
• property levelHeaderStyle as %ZEN.Datatype.style(XMLPROJECTION="attribute");
Optional style to apply to this element's header.
• property levelStyle as %ZEN.Datatype.style(XMLPROJECTION="attribute");
Optional style to apply to this element.
• property levelSummary as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Optional summary to apply to this element.
• property levelType as %ZEN.Datatype.string(XMLPROJECTION="attribute");
Type of member to use for this element.
• property orderDirection as %ZEN.Datatype.string(XMLPROJECTION="attribute") [ InitialExpression = "BDESC" ];
Direction argument for ORDER function.
• property orderEnabled as %ZEN.Datatype.boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];
If true, apply the ORDER function to this level.
• property orderExpression as %ZEN.Datatype.string(MAXLEN="",XMLPROJECTION="attribute");
Sort expression for ORDER function.
• property spec as %ZEN.Datatype.string(MAXLEN="",XMLPROJECTION="attribute");
This specifies the dimension level displayed for this level of the pivot table.
For example, "[Product]" or "[Time].[Year]"
• property suppress8020 as %ZEN.Datatype.boolean(XMLPROJECTION="attribute") [ InitialExpression = 0 ];
If true, apply the 80/20 suppression to this level.
• property text as %ZEN.Datatype.caption(MAXLEN="",XMLPROJECTION="attribute");
Optional display name for this level. This is the text displayed by the pivot table when a level is used a filter, for example.
• property value as %ZEN.Datatype.string(MAXLEN="",XMLPROJECTION="attribute");
Name value of the current dimension level.
This can be a comma-delimited list of delimited values: "[2005],[2006]"