PivotMeasure
A handle on one data field (“measure”) of a pivot table, addressed by its definition entry, so it
survives reordering and a cache refresh alike. remove, or a refresh that drops the source
column, marks it removed (isRemoved), after which it refuses mutation. Mutators must run
inside PivotManager.update.
Properties
Section titled “Properties”readonly field: PivotField;readonly table: PivotTable;Accessors
Section titled “Accessors”aggregation
Section titled “aggregation”Get Signature
Section titled “Get Signature”get aggregation(): PivotDataFieldAggregation;Returns
Section titled “Returns”isRemoved
Section titled “isRemoved”Get Signature
Section titled “Get Signature”get isRemoved(): boolean;Returns
Section titled “Returns”boolean
Get Signature
Section titled “Get Signature”get name(): string;Returns
Section titled “Returns”string
numberFormat
Section titled “numberFormat”Get Signature
Section titled “Get Signature”get numberFormat(): string | undefined;Returns
Section titled “Returns”string | undefined
position
Section titled “position”Get Signature
Section titled “Get Signature”get position(): number;Returns
Section titled “Returns”number
showDataAs
Section titled “showDataAs”Get Signature
Section titled “Get Signature”get showDataAs(): | PivotMeasureShowDataAs | null;Returns
Section titled “Returns”| PivotMeasureShowDataAs
| null
Methods
Section titled “Methods”remove()
Section titled “remove()”remove(): void;Returns
Section titled “Returns”void
setAggregation()
Section titled “setAggregation()”setAggregation(aggregation): void;Parameters
Section titled “Parameters”aggregation
Section titled “aggregation”Returns
Section titled “Returns”void
setName()
Section titled “setName()”setName(name): void;Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
setNumberFormat()
Section titled “setNumberFormat()”setNumberFormat(format): void;Parameters
Section titled “Parameters”format
Section titled “format”string | undefined
Returns
Section titled “Returns”void
setShowDataAs()
Section titled “setShowDataAs()”setShowDataAs(value): void;Parameters
Section titled “Parameters”| PivotMeasureShowDataAs
| null
Returns
Section titled “Returns”void
Throws
Section titled “Throws”value.baseField belongs to another pivot table, or a cache refresh removed it