COMPLEX
Converts real and imaginary coefficients into a complex number.
Syntax
expression.COMPLEX(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 real coefficient of the complex number. | |
| arg2 | Required | ApiRange | ApiName | number | The imaginary coefficient of the complex number. | |
| arg3 | Optional | ApiRange | ApiName | string | The suffix for the imaginary component of the complex number. It can be either "i" or "j" in lowercase. If it is omitted, the function will assume suffix to be "i". |
Returns
number
Example
This example shows how to convert real and imaginary coefficients into a complex number.
- Code
- Result
// How to create a complex number using coefficients.
// Use function to convert real and imaginary coefficients into a complex number.
let worksheet = Api.GetActiveSheet();
let func = Api.GetWorksheetFunction();
worksheet.GetRange("A1").SetValue(func.COMPLEX(-2, 2.5, "i"));