Home > @gooddata/sdk-ui-charts > Xirr
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Xirr computes the Internal Rate of Return from the given measure and date dimension.
Xirr: (props: IXirrProps) => JSX.Element
The "X" in the name means that the returns do not have to happen periodically (as in the standard IRR), but they can happen at any day. You must specify both the measure and date dimension.
For date parsing, we currently use the browser's Date constructor. There might be some differences between how browsers implement this, so for best results use the Day granularity if possible.
See IXirrProps to learn how to configure the Xirr.