Skip to main content

%DeepSee.Component.pivotLevel

class %DeepSee.Component.pivotLevel extends %ZEN.Component.object

Defines an axis, measure, or filter level within a %DeepSee.Component.pivotTable component.

Property Inventory

Parameters

parameter NAMESPACE = http://www.intersystems.com/deepsee;
Inherited description: This is the XML namespace used for library components.

Properties

property advanced as %ZEN.Datatype.boolean;
If true, then spec contains an "advanced" specification (such as an advanced filter).
Property methods: advancedDisplayToLogical(), advancedGet(), advancedIsValid(), advancedLogicalToDisplay(), advancedLogicalToOdbc(), advancedLogicalToXSD(), advancedNormalize(), advancedSet(), advancedXSDToLogical()
property aggEnabled as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, apply the Aggregate function to this level.
Property methods: aggEnabledDisplayToLogical(), aggEnabledGet(), aggEnabledIsValid(), aggEnabledLogicalToDisplay(), aggEnabledLogicalToOdbc(), aggEnabledLogicalToXSD(), aggEnabledNormalize(), aggEnabledSet(), aggEnabledXSDToLogical()
property aggFunction as %ZEN.Datatype.string;
Aggregate function.
Property methods: aggFunctionDisplayToLogical(), aggFunctionGet(), aggFunctionIsValid(), aggFunctionLogicalToDisplay(), aggFunctionLogicalToOdbc(), aggFunctionNormalize(), aggFunctionSet()
property aggFunctionParm as %ZEN.Datatype.string;
Parameter for aggregate function (if any)
Property methods: aggFunctionParmDisplayToLogical(), aggFunctionParmGet(), aggFunctionParmIsValid(), aggFunctionParmLogicalToDisplay(), aggFunctionParmLogicalToOdbc(), aggFunctionParmNormalize(), aggFunctionParmSet()
property caption as %ZEN.Datatype.caption;
Optional caption for this level. This is used to hold the level caption when this level is used a filter.
Property methods: captionDisplayToLogical(), captionGet(), captionIsValid(), captionLogicalToDisplay(), captionLogicalToOdbc(), captionNormalize(), captionSet()
property childLevels as list of pivotLevel (XMLELEMENTREF = 1, XMLPROJECTION = "ELEMENT", ZENSETTING = 0);
Children of this level.
Property methods: childLevelsBuildValueArray(), childLevelsCollectionToDisplay(), childLevelsCollectionToOdbc(), childLevelsDisplayToCollection(), childLevelsGet(), childLevelsGetObject(), childLevelsGetObjectId(), childLevelsGetSwizzled(), childLevelsIsValid(), childLevelsOdbcToCollection(), childLevelsSet(), childLevelsSetObject(), childLevelsSetObjectId()
property drillLevel as %ZEN.Datatype.integer [ InitialExpression = 0 ];
Drill-level at which this level was defined.
Property methods: drillLevelDisplayToLogical(), drillLevelGet(), drillLevelIsValid(), drillLevelLogicalToDisplay(), drillLevelLogicalToOdbc(), drillLevelNormalize(), drillLevelSet()
property drilldownSpec as %ZEN.Datatype.string;
Drilldown spec.
Property methods: drilldownSpecDisplayToLogical(), drilldownSpecGet(), drilldownSpecIsValid(), drilldownSpecLogicalToDisplay(), drilldownSpecLogicalToOdbc(), drilldownSpecNormalize(), drilldownSpecSet()
property enabled as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
For filters, indicates if a filter is enabled.
Property methods: enabledDisplayToLogical(), enabledGet(), enabledIsValid(), enabledLogicalToDisplay(), enabledLogicalToOdbc(), enabledLogicalToXSD(), enabledNormalize(), enabledSet(), enabledXSDToLogical()
property filterEnabled as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, apply the FILTER function to this level.
Property methods: filterEnabledDisplayToLogical(), filterEnabledGet(), filterEnabledIsValid(), filterEnabledLogicalToDisplay(), filterEnabledLogicalToOdbc(), filterEnabledLogicalToXSD(), filterEnabledNormalize(), filterEnabledSet(), filterEnabledXSDToLogical()
property filterExpression as %ZEN.Datatype.string;
Filter expression for FILTER function.
Property methods: filterExpressionDisplayToLogical(), filterExpressionGet(), filterExpressionIsValid(), filterExpressionLogicalToDisplay(), filterExpressionLogicalToOdbc(), filterExpressionNormalize(), filterExpressionSet()
property headCount as %ZEN.Datatype.integer;
Count argument for HEAD function.
Property methods: headCountDisplayToLogical(), headCountGet(), headCountIsValid(), headCountLogicalToDisplay(), headCountLogicalToOdbc(), headCountNormalize(), headCountSet()
property headEnabled as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, apply the HEAD function to this level.
Property methods: headEnabledDisplayToLogical(), headEnabledGet(), headEnabledIsValid(), headEnabledLogicalToDisplay(), headEnabledLogicalToOdbc(), headEnabledLogicalToXSD(), headEnabledNormalize(), headEnabledSet(), headEnabledXSDToLogical()
property key as %ZEN.Datatype.string;
Key value of the current dimension level.
This can be a comma-delimited list of keys:
"14,25"
If there are multiple keys, they may be encoded as an MDX set. "{A,B}"
Property methods: keyDisplayToLogical(), keyGet(), keyIsValid(), keyLogicalToDisplay(), keyLogicalToOdbc(), keyNormalize(), keySet()
property levelCaption as %ZEN.Datatype.string;
Optional caption to apply to this element.
Property methods: levelCaptionDisplayToLogical(), levelCaptionGet(), levelCaptionIsValid(), levelCaptionLogicalToDisplay(), levelCaptionLogicalToOdbc(), levelCaptionNormalize(), levelCaptionSet()
property levelFormat as %ZEN.Datatype.string;
Optional format to apply to this element.
Property methods: levelFormatDisplayToLogical(), levelFormatGet(), levelFormatIsValid(), levelFormatLogicalToDisplay(), levelFormatLogicalToOdbc(), levelFormatNormalize(), levelFormatSet()
property levelHeaderStyle as %ZEN.Datatype.style;
Optional CSS style to apply to header's for this element.
Property methods: levelHeaderStyleDisplayToLogical(), levelHeaderStyleGet(), levelHeaderStyleIsValid(), levelHeaderStyleLogicalToDisplay(), levelHeaderStyleLogicalToOdbc(), levelHeaderStyleNormalize(), levelHeaderStyleSet()
property levelStyle as %ZEN.Datatype.style;
Optional CSS style to apply to this element.
Property methods: levelStyleDisplayToLogical(), levelStyleGet(), levelStyleIsValid(), levelStyleLogicalToDisplay(), levelStyleLogicalToOdbc(), levelStyleNormalize(), levelStyleSet()
property levelSummary as %ZEN.Datatype.string;
Optional pivot table summary to use for this element. If the pivotTable displays rowTotals or columnTotals, then this will override the summary aggregate used.
The value can be sum,min,max,count,avg,pct.
Property methods: levelSummaryDisplayToLogical(), levelSummaryGet(), levelSummaryIsValid(), levelSummaryLogicalToDisplay(), levelSummaryLogicalToOdbc(), levelSummaryNormalize(), levelSummarySet()
property levelType as %ZEN.Datatype.string (VALUELIST = ",value,space,mdx");
For row/column options, indicates the type of member defined.
Property methods: levelTypeDisplayToLogical(), levelTypeGet(), levelTypeIsValid(), levelTypeLogicalToDisplay(), levelTypeLogicalToOdbc(), levelTypeNormalize(), levelTypeSet()
property orderDirection as %ZEN.Datatype.string [ InitialExpression = "BDESC" ];
Direction argument for ORDER function.
Property methods: orderDirectionDisplayToLogical(), orderDirectionGet(), orderDirectionIsValid(), orderDirectionLogicalToDisplay(), orderDirectionLogicalToOdbc(), orderDirectionNormalize(), orderDirectionSet()
property orderEnabled as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, apply the ORDER function to this level.
Property methods: orderEnabledDisplayToLogical(), orderEnabledGet(), orderEnabledIsValid(), orderEnabledLogicalToDisplay(), orderEnabledLogicalToOdbc(), orderEnabledLogicalToXSD(), orderEnabledNormalize(), orderEnabledSet(), orderEnabledXSDToLogical()
property orderExpression as %ZEN.Datatype.string;
Sort expression for ORDER function.
Property methods: orderExpressionDisplayToLogical(), orderExpressionGet(), orderExpressionIsValid(), orderExpressionLogicalToDisplay(), orderExpressionLogicalToOdbc(), orderExpressionNormalize(), orderExpressionSet()
property spec as %ZEN.Datatype.string;
This specifies the dimension level displayed for this level of the pivot table.
For example, "[Product]" or "[Time].[Year]"
Property methods: specDisplayToLogical(), specGet(), specIsValid(), specLogicalToDisplay(), specLogicalToOdbc(), specNormalize(), specSet()
property suppress8020 as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, apply the 80/20 suppression to this level.
Property methods: suppress8020DisplayToLogical(), suppress8020Get(), suppress8020IsValid(), suppress8020LogicalToDisplay(), suppress8020LogicalToOdbc(), suppress8020LogicalToXSD(), suppress8020Normalize(), suppress8020Set(), suppress8020XSDToLogical()
property text as %ZEN.Datatype.caption;
Optional display name for this level. This is the text displayed by the pivot table when a level is used a filter.
Property methods: textDisplayToLogical(), textGet(), textIsValid(), textLogicalToDisplay(), textLogicalToOdbc(), textNormalize(), textSet()
property transient as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
If true, then is a filter that was passed in from a widget and should not be saved as part of the pivot state.
Property methods: transientDisplayToLogical(), transientGet(), transientIsValid(), transientLogicalToDisplay(), transientLogicalToOdbc(), transientLogicalToXSD(), transientNormalize(), transientSet(), transientXSDToLogical()
property value as %ZEN.Datatype.string;
Name value of the current dimension level.
This can be a comma-delimited list of delimited values: "[2005],[2006]"
Property methods: valueDisplayToLogical(), valueGet(), valueIsValid(), valueLogicalToDisplay(), valueLogicalToOdbc(), valueNormalize(), valueSet()

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab