FORECAST_ETS_SEASONALITY

Returns the length of the repetitive pattern an application detects for the specified time series.

Syntax

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

expression - A variable that represents a ApiWorksheetFunction class.

Parameters

Name	Required/Optional	Data type	Default	Description
arg1	Required	ApiRange | ApiName | number[]		A range or an array of numeric data that determines the historical values for which a new point will be predicted.
arg2	Required	ApiRange | ApiName		A range of date/time values that correspond to the historical values.\ The timeline range must be of the same size as the second argument. Date/time values must have a constant step between them and can't be zero.
arg3	Optional	ApiRange | ApiName | number		An optional numeric value to handle missing values. The default value of 1 replaces missing values by interpolation, and 0 replaces them with zeros.
arg4	Optional	ApiRange | ApiName | number		An optional numeric value to aggregate multiple values with the same time stamp.

Returns

number

Example

• Code
• Result

let worksheet = Api.GetActiveSheet();
let func = Api.GetWorksheetFunction();
let dates = ["10/1/2017", "11/1/2017", "12/1/2017", "1/1/2018", "2/1/2018"];
let numbers = [12558, 14356, 16345, 18678, 14227];

for (let i = 0; i < dates.length; i++) {
    worksheet.GetRange("A" + (i + 1)).SetValue(dates[i]);
}
for (let j = 0; j < numbers.length; j++) {
    worksheet.GetRange("B" + (j + 1)).SetValue(numbers[j]);
}

let range1 = worksheet.GetRange("B1:B5");
let range2 = worksheet.GetRange("A1:A5");
worksheet.GetRange("B6").SetValue(func.FORECAST_ETS_SEASONALITY(range1, range2, 1, 1));