Desktop User Guides > Professional > Table scripting > Table Object Model reference > Elements and element properties
 
Elements and element properties
The Element object supports the following read/write properties (in addition to some more properties that are read-only):
AnalysisVariable
CalculationScope
CutOffValue
Decimals
Expression
Factor
IncludeInBase
IsFixed
IsHidden
IsHiddenWhenColumn
IsHiddenWhenRow
IsUnweighted
Label
Multiplier
Weight
The IsFixed, IsHidden, IsHiddenWhenColumn, IsHiddenWhenRow, and Label properties can be specified for all elements. The default values for the IsFixed, IsHidden, IsHiddenWhenColumn, and IsHiddenWhenRow properties depend on the element; see the table below. For elements based on an MDM element, the Label property is the label of the MDM element, otherwise it will be empty.
The CutOffValue property can only be specified for the ePercentile element type.
The table below shows the remaining properties. For the AnalysisVariable, Decimals, Expression, Multiplier, Weight, and IncludeInBase properties, “Yes” indicates that a value can be set, while “No” indicates an error occurs when trying to set the property value. Note that “Yes” doesn’t mean the value has an effect – see the footnotes for more information. For the CalculationScope and Factor properties “Yes” indicates the property has an effect and “No” indicates that the property doesn’t apply to that element type. For IsUnweighted an error occurs when trying to set the property to False for the eBase and eUnweightedBase elements, otherwise a “No” in the column indicates IsUnweighted doesn’t apply to that element type.
Analysis variable
Calculation Scope
Decimals
Expression
Is Un - weighted
Multiplier
Weight
Include In Base
Factor
 
 
 
 
 
 
 
 
 
 
eCategory
No
No
No
No
Yes
Yes
Yes
Yes
Yes
eBase
No
No
No
Yes [4]
No
Yes [1]
Yes [1]
No
No
eTableStatistic
No
No
Yes
No
No
No
No
No
No
eEffectiveBase
No
No
No
No
No
No
No
No
No
eSumWeights Squared
No
No
No
Yes [4]
Yes
Yes
Yes
No
No
eSumN
No
No
No
Yes [4]
Yes
Yes
Yes
No
No
eSumX
Yes
No
No
Yes [4]
Yes
Yes
Yes
No
No
eSumX Squared
Yes
No
No
Yes [4]
Yes
Yes
Yes
No
No
eSumUn weighted N
No
No
No
Yes [4]
Yes
Yes
Yes
No
No
eMean
Yes
Yes
Yes
Yes [4]
Yes
Yes
Yes
No
No
eStdDev
Yes
Yes
Yes
Yes [4]
Yes
Yes
Yes
No
No
eStdErr
Yes
Yes
Yes
Yes [4]
Yes
Yes
Yes
No
No
eSampleVar
Yes
Yes
Yes
Yes [4]
Yes
Yes
Yes
No
No
eTotal
No
No
Yes
No
No
No
No
No
No
eSubTotal
No
No
Yes
No
No
No
No
No
No
eText
No
No
No
No
No
No
No
No
No
eNetDiffs
No
No
No
No
No
No
No
No
No
ePairedPref
No
No
No
No
No
No
No
No
No
eMinimum
Yes
No
Yes
Yes [4]
Yes [3]
Yes
Yes [3]
No
No
eMaximum
Yes
No
Yes
Yes [4]
Yes [3]
Yes
Yes [3]
No
No
eOther Derived
No
No
No
No
Yes
Yes
Yes
No
No
eNet
No
Yes
No
No
Yes
Yes
Yes
No
Yes
eCombine
No
No
No
No
Yes
Yes
Yes
Yes[5]
Yes
eExpression
No
No
No
Yes
Yes
Yes
Yes
Yes[5]
Yes
eUnweighted Base
No
No
No
Yes [4]
No
Yes [2]
No
No
No
eNumeric
Yes
No
No
Yes [4]
Yes
Yes
Yes
No
No
eDerived
No
No
Yes
Yes [4]
No
No
No
No
No
eSum
Yes
No
Yes
Yes [4]
Yes
Yes
Yes
No
No
ePercentile
Yes
No
Yes
Yes [4]
Yes
Yes
Yes
No
No
eMedian
Yes
No
Yes
Yes [4]
Yes
Yes
Yes
No
No
eMode
Yes
No
Yes
Yes [4]
Yes
Yes
Yes
No
No
[1] For an eBase element it is possible to set the Weight and Multiplier properties. This only takes effect when an expression is specified for the element (i.e. the Expression property is set).
[2] As with the eBase element, a Multiplier can be specified for the eUnweightedBase element but this only takes effect if the element has an expression.
[3] Weighting (the Weight and IsUnweighted properties) has no effect on the eMinimum and eMaximum element types.
[4] Attempting to set an Expression for an element added via IElements.Add will generate an error. You can only set it for elements added via IElements.AddNew() and IElements.AddNewFromMdmVariable().
[5] When using the Adjust roundings so percentages add up to 100% option, the values will not add up to 100% when decimal places are not used. A work-around for this issue is to include the property IncludeInBase=False against the eCombine and eExpression elements.
IsFixed
IsHidden
IsHiddenWhenColumn
IsHiddenWhen Row
eCategory
FALSE
FALSE
FALSE
FALSE
eBase
TRUE
FALSE
FALSE
FALSE
eTableStatistic
TRUE
FALSE
FALSE
FALSE
eEffectiveBase
TRUE
TRUE
FALSE
FALSE
eSumWeightsSquared
TRUE
TRUE
FALSE
FALSE
eSumN
TRUE
TRUE
FALSE
FALSE
eSumX
TRUE
TRUE
FALSE
FALSE
eSumXSquared
TRUE
TRUE
FALSE
FALSE
eSumUnweightedN
TRUE
TRUE
FALSE
FALSE
eMean
TRUE
FALSE
FALSE
FALSE
eStdDev
TRUE
FALSE
FALSE
FALSE
eStdErr
TRUE
FALSE
FALSE
FALSE
eSampleVar
TRUE
FALSE
FALSE
FALSE
eTotal
TRUE
FALSE
FALSE
FALSE
eSubTotal
TRUE
FALSE
FALSE
FALSE
eText
TRUE
FALSE
FALSE
FALSE
eNetDiffs
TRUE
FALSE
FALSE
FALSE
ePairedPref
TRUE
FALSE
FALSE
FALSE
eMinimum
TRUE
FALSE
FALSE
FALSE
eMaximum
TRUE
FALSE
FALSE
FALSE
eOtherDerived
TRUE
FALSE
FALSE
FALSE
eNet
FALSE
FALSE
FALSE
FALSE
eCombine
FALSE
FALSE
FALSE
FALSE
eExpression
FALSE
FALSE
FALSE
FALSE
eUnweightedBase
TRUE
FALSE
FALSE
FALSE
eNumeric
FALSE
FALSE
FALSE
FALSE
eDerived
FALSE
FALSE
FALSE
FALSE
eSum
TRUE
FALSE
FALSE
FALSE
ePercentile
TRUE
FALSE
FALSE
FALSE
eMedian
TRUE
FALSE
FALSE
FALSE
eMode
TRUE
FALSE
FALSE
FALSE
Table 2 shows the default values for the IsFixed, IsHidden, IsHiddenWhenColumn, and IsHiddenWhenRow properties.
The default value for the IsFixed property is shown in the table and only depends on the element type.
For elements added from the metadata (i.e. via IElements.Add() and AddNewFromMdmVariable() ), the default value for the IsHidden property depends on the setting of the “Hidden” custom metadata property for the element. Some element types (added from the metadata) will always be hidden by default (IsHidden=True) as shown in the table below. For elements added via IElements.AddNew() and IElements.AddNewFromMdmVariable() the IsHidden property will always default to False.
For elements added from the metadata, the default value for the IsHiddenWhenColumn and IsHiddenWhenRow properties depend on the setting of the “HiddenWhenRow” and “HiddenWhenCol” custom metadata property for the element (respectively). If the custom property isn’t, or the element was added via IElements.AddNew() and IElements.AddNewFromMdmVariable(), the default value is always False.
See also
Table Object Model reference