PlotScatterSeries.AddPoints(StringArray, StringArray, StringArray) Method

Top

Description

Adds a point to the PlotScatterSeries.Data matrix. If the series has been attached to a PlotWindow, the point will be added to the plot. If the series has not been attached to a PlotWindow, the data will be stored in a buffer until it is attached. Note, points may not be immediately visible in a PlotWindow due to the default value for the PlotWindow.PointsToUpdate property being 25. If you want the PlotWindow to be updated each time a point is added, set the PlotWindow.PointsToUpdate property equal to 1.

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

PlotScatterSeries.AddPoints(	StringArray xPoints,
	StringArray yPoints,
	StringArray labels)

Arguments

xPoints
Description:	An array of X values to add to the series. All string values must be a UTC epoch in the 'Mmm DD YYYY hh:mm:ss.fs' format.

yPoints
Description:	An array of Y values to add to the series. All string values must be a UTC epoch in the 'Mmm DD YYYY hh:mm:ss.fs' format.

labels
Description:	The labels for the points.

Return Value

Type:

number

Returns the index of the last added point.

Syntax

myVariable1 = myPlotScatterSeries1.AddPoints(myStringArray1, myStringArray2, myStringArray3);