PlotWindow.RemoveSeries(Variable) Method

Top 

Description

Removes the series from the PlotWindow object by index. The removed series will no longer be drawn by the PlotWindow object. Only series that have been added with the AddSeries method can be removed. Throws an error if the index corresponds to a series that was added in the constructor.

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

 

Method Signature

PlotWindow.RemoveSeries(

Variable index)

 

 

Arguments

index


Description:

The index of the series to remove from the PlotWindow object.

Valid Range:

index ≥ 0

 

 

 

Return Value

Type:

boolean

 

 

Returns true if the series was successfully removed from the PlotWindow object and false if the series could not be found in the PlotWindow.

 

Syntax

myVariable1 = myPlotWindow1.RemoveSeries(myVariable2);

 

 

See also

PlotWindow Object

PlotWindow.RemoveSeries

PlotWindow Guide