X11EquationWizardView.setEquationPeriod

Syntax

setEquationPeriod(periodMetadata: Object);

Parameters

periodMetadata. Time series metadata that contains information about seasonal effect calculation periods. Period value is set with the PP.TS.Ui.DimCalendarLvl enumeration.

Description

The setEquationPeriod method manages availability of controls in seasonal adjustment wizard in accordance with seasonal effect calculation periods.

Example

To execute the example, the HTML page must contain the WorkbookBox component named workbookBox (see Example of Creating the WorkbookBox Component). Get seasonal adjustment wizard and show it in the workbook side panel:

// Get workbook properties panel
var propertyBar = workbookBox.getPropertyBarView();
// Get parameters panel
var parametersPanel = propertyBar.getParametersPanel();
// Show panel
parametersPanel.show();
// Expand panel
parametersPanel.expand();
// Get seasonality selection wizard
var x11EquationWizard = parametersPanel._X11EquationWizard;
// Show wizard
x11EquationWizard.show();

After the specified scenario is executed, the seasonal adjustment wizard looks as follows:

Set annual calculation period for this wizard:

After executing the example annual calculation period of effect seasonality is set for seasonal adjustment wizard, which makes some wizard controls unavailable: