LOGEST

Returns statistics that describe an exponential curve matching known data points.

Syntax

expression.LOGEST(arg1, arg2, arg3, arg4);

expression - A variable that represents a ApiWorksheetFunction class.

Parameters

Name	Required/Optional	Data type	Default	Description
arg1	Required	ApiRange	ApiName	ApiRange
arg2	Required	ApiRange	ApiName	ApiRange
arg3	Required	ApiRange	ApiName	boolean
arg4	Required	ApiRange	ApiName	boolean

Returns

number

Example

const oWorksheet = Api.GetActiveSheet();

//configure function parameters
var yValues = [1500, 1230, 1700, 1000, 980, 1470, 1560, 1640, 1420, 1100];
var xValues = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
var constant = true;
var stats = false;

//set values in cells
for (var i = 0; i < yValues.length; i++) {
  oWorksheet.GetRange("A" + (i + 1)).SetValue(yValues[i]);
}
for (var i = 0; i < xValues.length; i++) {
  oWorksheet.GetRange("B" + (i + 1)).SetValue(xValues[i]);
}

//get x and y ranges
var yRange = oWorksheet.GetRange("A1:A10");
var xRange = oWorksheet.GetRange("B1:B10");

var oFunction = Api.GetWorksheetFunction();
//invoke LOGEST method
var ans = oFunction.LOGEST(yRange, xRange, constant, stats);

//print answer
oWorksheet.GetRange("D1").SetValue(ans);