ILanerBoxMethodSettings.Param

Syntax

Param: Variant;

Description

The Param property is used to define parameters of series transformation. It is used when the ILanerBox.ExecuteMethodEx method has the Method parameter set to LanerBoxMethod.TermInfoMethod. Method parameters are passed as an array containing four elements at maximum:

Param[0]: MsInversion . Determines the method of initial transformation applied to the series.
Param[1]: MsInversionLag . Determines the period in which the initial series transformation is to be performed.
Param[2]: Integer. Determines lag for the period of initial series transformation. This element is to be taken into account if value of the Param[1] element is set.
Param[3]. The following mutually exclusive options are available:
- Param[3]: String. Lag is passed.
- Param[3]: DateTime. Date is passed.
- Param[3]: Boolean. Indicates that a data series is passed.

Example

Executing the example requires a form with a button named Button1 on it, the LanerBox component named LanerBox1 and the UiErAnalyzer component which is used as a data source for LanerBox. Workbook of the time series database must be loaded to UiErAnalyzer1.

This example is executed on clicking the button.

Sub Button1OnClick(Sender: Object; Args: IMouseEventArgs);

Var

Sett: ILanerBoxMethodSettings;

Param: Array[4] Of Variant;

Begin

Sett := New LanerBoxMethodSettings.Create;

Sett.TrySelfExecute := True;

Sett.CreateDerivedSeries := False;

Param[0] := MsInversion.Diff;

Param[1] := MsInversionLag.PrecidingYear;

Param[2] := -3;

Sett.Param := Param;

LanerBox1.ExecuteMethodEx(LanerBoxMethod.TermInfoMethod, Sett);

End Sub Button1OnClick;

After executing this example selected workbook series are converted to calculated ones calculated as increase of series values to the previous year with a lag of 3.