RRI
Returns an equivalent interest rate for the growth of an investment.
Syntax
expression.RRI(arg1, arg2, arg3);
expression - A variable that represents an ApiWorksheetFunction class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| arg1 | Required | ApiRange | ApiName | number | The number of periods for the investment. | |
| arg2 | Required | ApiRange | ApiName | number | The present value of the investment. | |
| arg3 | Required | ApiRange | ApiName | number | The future value of the investment. |
Returns
number
Example
Calculate the interest rate from an investment's growth in a spreadsheet.
// How do I find the interest rate when I know the investment's start and end value in a spreadsheet?
// Determine the annual growth rate from investment performance data in a spreadsheet.
let worksheet = Api.GetActiveSheet();
let func = Api.WorksheetFunction;
worksheet.GetRange("A1").SetValue(func.RRI(12, 10000, 20000));