Skip to main content

IMAGINARY

Returns the imaginary coefficient of a complex number.

Syntax

expression.IMAGINARY(arg1);

expression - A variable that represents a ApiWorksheetFunction class.

Parameters

NameRequired/OptionalData typeDefaultDescription
arg1RequiredApiRange | ApiName | numberA complex number expressed in the <em>x + yi</em> or <em>x + yj</em> form.

Returns

number

Example

let worksheet = Api.GetActiveSheet();
let func = Api.GetWorksheetFunction();
worksheet.GetRange("A1").SetValue(func.IMAGINARY("-2+2.5i"));