ArimaWizardView.CurrentState

Syntax

CurrentState: Object;

Description

The CurrentState property determines current state of the ARIMA calculation wizard.

Example

To execute the example, the page must contain the WorkbookBox component named workbookBox (see Example of Creating the WorkbookBox Component), and also add the following code in the handler, that processes document opening event:

var getCurrentStateButt = new PP.Ui.Button({
	ParentNode: document.body, //DOM parent node
	Content: "Get Current State", //Title 
	Click: PP.Delegate(onClickGetCurrentState)
}); 
function onClickGetCurrentState()
	{
		//Get panel that must contain ARIMA method parameters wizard panel
		var parametersPanel = workbookBox.getPropertyBarView().getParametersPanel();
		//Get ARIMA method parameters wizard panel
		var arimaWizard = parametersPanel._ArimaWizard;		
		//If formula type of the selected series differs from ARIMA, clicking the 
		//"Get Current State" button displays a message saying that ARIMA method parameters wizard panel cannot be applied to the selected series
		if (!arimaWizard) return alert('ARIMA method parameters wizard panel cannot be applied to the selected series. \n Select another series.');
		//Get CurrentState of parameter setup wizard of the ARIMA calculation method
		var state = arimaWizard.getCurrentState();
		alert(JSON.stringify(state));
	}

After executing the example the page will contain the WorkbookBox component and a button named Get Current State. Click the Forecasting button in the Calculations ribbon tab, select ARIMA in the drop-down menu, open the Parameters panel in the Series tab of the side panel and click the Get Current State button. A message that contains defined parameters of the ARIMA calculation method appears in the screen. If the selected series has a formula type other than ARIMA, the following message appears on clicking the Get Current State button: Panel of the wizard for setting up ARIMA calculation method parameters cannot be applied to the selected series. Select another series.

See also:

ArimaWizardView