interface
Source: totals.ts ↗
ITotal
Describes type and granularity for calculation of Totals.
export interface ITotal
Remarks
Total is calculated for particular measure and on some granularity - specified by an attribute by which the measure is sliced by.
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (Optional) Specifies custom name for the calculated total. This will be included in result metadata. | ||
Local identifier of attribute - specifies granularity of the calculation. | |||
Local identifier of measure for which to calculate total. | |||
Type of total calculation. |
Property details
ITotal.aliasproperty
Specifies custom name for the calculated total. This will be included in result metadata.
alias?: string;
ITotal.attributeIdentifierproperty
Local identifier of attribute - specifies granularity of the calculation.
attributeIdentifier: Identifier;
ITotal.measureIdentifierproperty
Local identifier of measure for which to calculate total.
measureIdentifier: Identifier;
ITotal.typeproperty
Type of total calculation.
type: TotalType;