PlotScatterSeries Object

The PlotScatterSeries object is used to configure the data points and display of a scatter series on a plot. The data points can be displayed as lines and/or points. A PlotScatterSeries object can be created in FreeForm script and added or removed from a PlotWindow object, or created through the PlotWindow constructor.

Available In Editions:

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.

Name	Description	Attributes
Data	Provides access to the data stored in the series object. The dimension of this matrix cannot be changed, except through the AddPoints, ClearPoints, and RemovePoints methods.	Type: Matrix Access: Read/Write
DataLabels	The labels associated with each data point.	Type: StringArray Access: Read/Write
DataLabelsBackgroundColor	Sets the background color for the data labels.	Type: Variable Access: Read/Write
DataLabelsBackgroundVisible	Sets whether or not the background is visible for the data labels.	Type: Variable Access: Read/Write
DataLabelsFont	The font used to render the data label text.	Type: PlotFont Access: Read/Write
DataLabelsStyle	Sets the format of the data labels. Choices are Label, Label And Percent, Label And Percent Total, etc.	Type: Variable Access: Read/Write
DataLabelsTextColor	Sets the text color for the data labels.	Type: Variable Access: Read/Write
DataLabelsVisible	Specifies whether the data labels are visible for this series. Note: This property can be overwritten by the PlotWindow Output Properties GUI.	Type: Variable Access: Read/Write
DeclaredName	The name of the object as declared.	Type: String Access: Read-Only
EnableDataCulling	Determines whether or not the series will be subject to data culling. Disabling data culling for a series will affect performance for PlotScatterSeries with a large number of points.	Type: Variable Access: Read/Write
Label	Gets or sets the name of the series that appears in the legend.	Type: String Access: Read/Write
LineColor	Sets the color of the lines that connect the data points.	Type: Variable Access: Read/Write
LineStyle	Sets the style of the lines that connect the data points. Choices include Solid, Dash, Dot, Dash-Dot, and Dash-Dot-Dot.	Type: Variable Access: Read/Write
LineVisible	Sets whether or not the lines that connect the data points are visible for this series. Note: This property can be overwritten by the PlotWindow Output Properties GUI.	Type: Variable Access: Read/Write
LineWidth	Sets the width in pixels of the lines that connect the data points. Note: This property can be overwritten by the PlotWindow Output Properties GUI.	Type: Variable Access: Read/Write
MarkersColor	Sets the color of the markers at each data point.	Type: Variable Access: Read/Write
MarkersSize	Sets the vertical and horizontal size of the markers in pixels. Valid range is 1-5. Note: This property can be overwritten by the PlotWindow Output Properties GUI.	Type: Variable Access: Read/Write
MarkersStyle	Sets the type of marker that will be used for this series.	Type: Variable Access: Read/Write
MarkersVisible	Sets whether the markers are visible for this series. Note: This property can be overwritten by the PlotWindow Output Properties GUI.	Type: Variable Access: Read/Write
Name	The name displayed for this object in output windows such as views, plots, and reports.	Type: String Access: Read/Write
ObjectId	The unique identifier for the object.	Type: Variable Access: Read-Only
ObjectType	The type of the object.	Type: String Access: Read-Only
PointCount	Returns the number of points that are in the series not including line breaks.	Type: Variable Access: Read-Only
ShowInLegend	Sets whether the series is visible in the legend. Note: This property can be overwritten by the PlotWindow Ouput Properties GUI.	Type: Variable Access: Read/Write

Name	Description
AddPoints	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.
ClearPoints	Clears all points in the PlotScatterSeries.Data matrix.
ClearSavedStates	Clears previous saved states for this object.
GetFromFile	Load the object state from the specified FreeFlyer object file.
GetFromString	Load the object state from the specified string.
InsertLineBreak	Inserts a line break in the series. The two points on either side of a line break will not be connected by a line.
PutToFile	Convert the object state to FreeFlyer object xml and write to a file.
PutToString	Convert the object state to FreeFlyer object xml and return as a string.
ReferenceEquals	Returns 1 if the argument refers to the calling object and 0 otherwise.
RemovePoints	Removes the point at the specified index from the PlotScatterSeries.Data matrix. Throws an error if the index does not correspond to a valid data point.
Restore	Restore an object's state from a previously saved state.
Save	Save the object's state so that it can be restored later.

PlotScatterSeries Object

Description

Available In Editions:

Timing Precision Mode