ILanerSeries.RemoveSeries

Fore Syntax

RemoveSeries(Value: ILanerSeriesSet);

Fore.NET Syntax

RemoveSeries(Value: Prognoz.Platform.Interop.Laner.ILanerSeriesSet);

Parameters

Value. Series to remove.

Description

The RemoveSeries method removes the specified series from the workbook

Comments

To remove a separate series, use the ILanerSeries.Remove, ILanerSeries.RemoveByKey and ILanerSeries.RemoveGroupedByKey methods.

Fore Example

Executing the example requires that the repository contains a workbook with the WORKBOOK_SERIES identifier that contains more than two series.

Add links to the Express, Laner and Metabase system assemblies.

Sub UserProc;
Var
    mb: IMetabase;
    WbkObj: IMetabaseObject;
    EaxAn: IEaxAnalyzer;
    Laner: ILaner;
    Series: ILanerSeries;
    SeriesSet: ILanerSeriesSet;
Begin
    // Get workbook
    mb := MetabaseClass.Active;
    WbkObj := mb.ItemById("WORKBOOK_SERIES").Edit;
    EaxAn := WbkObj As IEaxAnalyzer;
    Laner := EaxAn.Laner;
    // Get workbook series
    Series := Laner.Series;
    // Create a series set
    SeriesSet := Series.CreateSet;
    // Add the first two series to the set
    SeriesSet.Add(Series.Item(0));
    SeriesSet.Add(Series.Item(1));
    // Remove the series included in the set from the workbook
    Series.RemoveSeries(SeriesSet);
    // Save changes
    WbkObj.Save;
End Sub UserProc;

After executing the example the first two data series are removed from the workbook.

Fore.NET Example

The requirements and result of the Fore.NET example execution match with those in the Fore example.

Imports Prognoz.Platform.Interop.Express;
Imports Prognoz.Platform.Interop.Laner;
…
Public Shared Sub UserProc(Params: StartParams);
Var
    mb: IMetabase;
    WbkObj: IMetabaseObject;
    EaxAn: IEaxAnalyzer;
    Laner: ILaner;
    Series: ILanerSeries;
    SeriesSet: ILanerSeriesSet;
Begin
    // Get workbook
    mb := Params.Metabase;
    WbkObj := mb.ItemById["WORKBOOK_SERIES"].Edit();
    EaxAn := WbkObj As IEaxAnalyzer;
    Laner := EaxAn.Laner;
    // Get workbook series
    Series := Laner.Series;
    // Create a series set
    SeriesSet := Series.CreateSet();
    // Add the first two series to the set
    SeriesSet.Add(Series.Item[0]);
    SeriesSet.Add(Series.Item[1]);
    // Remove the series included in the set from the workbook
    Series.RemoveSeries(SeriesSet);
    // Save changes
    WbkObj.Save();
End Sub UserProc;