RRI
Returns an equivalent interest rate for the growth of an investment.
Syntax
expression.RRI(arg1, arg2, arg3);
expression - A variable that represents a 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
This example shows how to return an equivalent interest rate for the growth of an investment.
- Code
- Result
// How to get an investment growth interest rate.
// Use a function to an equivalent interest rate for the increase of an investment.
let worksheet = Api.GetActiveSheet();
let func = Api.WorksheetFunction;
worksheet.GetRange("A1").SetValue(func.RRI(12, 10000, 20000));