IXirrBucketProps
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
export interface IXirrBucketProps
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(BETA) (Optional) The date dimension to use for the computation. This allows you to set the granularity (day, month, etc.) for the IRR calculation. | |||
(BETA) (Optional) Specify filters to apply on the data to compute with. | |||
(BETA) The measure to calculate the Internal Rate of Return for. | |||
any | (BETA) (Optional) Resolution context for composed placeholders. |
Property details
IXirrBucketProps.attributepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The date dimension to use for the computation. This allows you to set the granularity (day, month, etc.) for the IRR calculation.
attribute?: AttributeOrPlaceholder;
IXirrBucketProps.filterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Specify filters to apply on the data to compute with.
filters?: NullableFiltersOrPlaceholders;
IXirrBucketProps.measurepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The measure to calculate the Internal Rate of Return for.
measure: MeasureOrPlaceholder;
Remarks
For the result to make sense, the measure should start with a negative value at some point in time (the investment) followed by other values (the returns).
IXirrBucketProps.placeholdersResolutionContextpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Resolution context for composed placeholders.
placeholdersResolutionContext?: any;