PlotWindow Object

Signatures

Description

PlotWindow()

Creates a new PlotWindow with no series and a default mode of XYPlot. Series must be added manually using the AddSeries method.

PlotWindow({Object} objectsToPlot)

Creates a new PlotWindow which will plot the objects specified by objectsToPlot.

PlotWindow({Object} objectsToPlot, Variable updateOnStep)

Creates a new PlotWindow which will plot the objects specified by objectsToPlot and whose update mode is specified by updateOnStep.

Name

Description

Attributes

BackgroundColor

Sets the background color for the entire plot.

Type:   Variable

Access: Read/Write

BackgroundColorPalette

The color palette which will be used to stylize the plot displayed in this PlotWindow.

Type:   String

Access: Read-Only

DeclaredName

The name of the object as declared.

Type:   String

Access: Read-Only

HighQualityRendering

Sets the plot to render the image with a much higher quality. This will have an inverse effect on performance.

Type:   Variable

Access: Read/Write

ID

The unique ID number used to reference the visualization output window.

Type:   Variable

Access: Read-Only

InterlacedColor

Sets the interlaced color that will be alternated between grid lines with the color specified by PlotWindow.PlotAreaColor.

Type:   Variable

Access: Read/Write

InterlacedDirection

Sets the direction of the interlaced color that will be alternated between grid lines with the color specified by PlotWindow.PlotAreaColor. Choices include Vertical, Horizontal, and None. Default is None.

Type:   Variable

Access: Read/Write

Legend

Provides access to the PlotWindow's Legend properties.

Type:   PlotLegend

Access: Read/Write

LineType

Sets whether or not all series in this plot will be drawn with lines or points. Once this property is set, any series that is added to this chart will have the LineVisible and MarkersVisible properties set to match this property.

Type:   Variable

Access: Read/Write

MaxPoints

Determines the maximum number of points drawn for each series on a plot at any one time. If a series in the plot is sent more data points than MaxPoints, the plot will begin thinning the data dynamically.

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

PlotAreaColor

Sets the color of the chart panel. This property will only color the section of the plot where series points appear.

Type:   Variable

Access: Read/Write

PlotSubTitle

Provides access to the PlotWindow's SubTitle properties.

Type:   PlotTitle

Access: Read/Write

PlotTitle

Provides access to the PlotWindow's Title properties.

Type:   PlotTitle

Access: Read/Write

PlotType

The type of Plot.

Type:   String

Access: Read/Write

PointsToUpdate

Determines the number of points the system will collect before updating the plot. Larger values can improve overall runtime performance. When using the Throttle slider and it is not on full, this property is ignored and the plot will update with each step. The Throttle slider can be enabled in User Preferences.

Type:   Variable

Access: Read/Write

RAxis

Provides access to the PlotWindow's Radial Axis properties. Note: this does not have any effect on X-Y Scatter Plots.

Type:   PlotAxis

Access: Read/Write

Series

The array of series objects that have been added to the PlotWindow. Provides access to each individual series' properties.

Type:   Array of PlotSeries

Access: Read-Only

SeriesColorPalette

The color palette which will be used to stylize the series displayed in this PlotWindow.

Type:   String

Access: Read-Only

ShowDataLabels

Determines if value labels are shown at each data point. Once this property is set, any series that is added to this chart will have have the DataLabelsVisible property set to match this property.

Type:   Variable

Access: Read/Write

ShowGridLines

Determines if grid lines are shown on the plot.

Type:   Variable

Access: Read/Write

TargetDisplayMode

If the window is updated automatically, this property determines how the window updates will be controlled when a targeting loop is entered.

Type:   String

Access: Read/Write

ThetaAxis

Provides access to the PlotWindow's Theta Axis properties. Note: this does not have any effect on X-Y Scatter Plots.

Type:   PlotAxis

Access: Read/Write

UseMonitorMode

Determines if monitor mode is used. When in monitor mode, plots will begin erasing the oldest data points once the number of points reaches or exceeds MaxPoints, so that plots will only display the most recent data. This can be useful for viewing real-time data or data trends over a certain period of time.

Type:   Variable

Access: Read/Write

WindowTitle

Sets the title for the output window.

Type:   String

Access: Read/Write

XAxis

Provides access to the PlotWindow's X Axis properties. Note: this does not have any effect on polar plots.

Type:   PlotAxis

Access: Read/Write

YAxis

Provides access to the PlotWindow's Y Axis properties. Note: this does not have any effect on polar plots.

Type:   PlotAxis

Access: Read/Write

Name

Description

AddSeries

Adds the PlotSeries object to the PlotWindow object and draws any data stored by the PlotSeries object. Returns the index of the added series, which can be used with the PlotWindow.Series array property. As a note, to add an empty PlotWindow.Series to the PlotWindow you must specify both the series name and series type.

BeginBatchUpdate

This method marks the beginning of a period where any update to the window will be queued and only processed when the PlotWindow.EndBatchUpdate method is called.

BoldAllText

Sets whether all text within this PlotWindow will be rendered in bold typeface.

ClearData

After calling this method all data will be cleared from the plot.

ClearSavedStates

Clears previous saved states for this object.

CloseWindow

Closes the window.

EndBatchUpdate

Processes all updates to the window that have occurred since the PlotWindow.BeginBatchUpdate method was called.

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.

ItalicizeAllText

Sets whether all text within this PlotWindow will be rendered in italic typeface.

NewWindow

Resets the OutputWindow so that a new window will be created next time Update is called.

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.

RemoveAllSeries

Removes all series from the PlotWindow, except any series that were added in the constructor.

RemoveSeries

Removes the series from the PlotWindow object. 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.

Restore

Restore an object's state from a previously saved state.

Resume

Causes the window to resume updating.

Save

Save the object's state so that it can be restored later.

SaveImage

Saves an image of the OutputWindow to a file. Note that this only works with FF.exe if the --windowed-output-mode switch is used.

SavePlotData

Saves the data of the plot to file. Note that this only works with FF.exe if the --windowed-output-mode switch is used. When exporting to OpenDocument format the date will be truncated and will always use the format MM/DD/YYYY.

SavePlotImage

Saves an image of the plot to file. Note that this only works with FF.exe if the --windowed-output-mode switch is used. When exporting to OpenDocument format the date will be truncated and will always use the format MM/DD/YYYY.

ScaleTextSize

Scales all text rendered within this PlotWindow according to the specified title text size.

SetAxisLimits

Sets the limits for the specified axis. Specifying a value of -999 will set this value to be automatically determined. Note that this is not valid for the Theta axis when using a polar plot, and will report an error.

SetAxisTitles

Sets the titles to be used on the axes of this PlotWindow.

SetBackgroundColorPalette

Sets the color palette to be used when drawing the background of this PlotWindow. The background palette includes the background, chart area, font, grid, and interlace colors.

SetLineVisibility

Sets whether lines will be shown for each Series contained within this PlotWindow.

SetLineWidth

Sets the width at which lines rendered in this PlotWindow will be drawn.

SetMarkerSize

Sets the size at which markers rendered in this PlotWindow will be drawn. Note that this is not valid for polynomial series and will have no effect if called.

SetMarkerVisibility

Sets whether markers will be shown on each Series contained within this PlotWindow. Note that this is not valid for polynomial series and will have no effect if called.

SetSeriesColorPalette

Sets the color palette to be used when drawing the Series contained within this PlotWindow. Any series added after this method is called will not be affected.

SetSeriesLabels

Sets the labels to be used on the series contained within this PlotWindow.

SetTextSize

Sets the size of the font to be used by all rendered text within this PlotWindow.

SetTypeface

Sets the font to be used by all rendered text within this PlotWindow.

Suspend

Causes the window to ignore updates until Resume is called.

Update

Updates the window contents using current object values.

Name

Description

Attributes

RAxisFont

The font to use on the plot R-Axis.

This property has been Deprecated. Please use PlotWindow.RAxis.Font.Typeface instead.

Type:   String

Access: Read/Write

RAxisFontBold

Determines if the title font is bold.

This property has been Deprecated. Please use PlotWindow.RAxis.Font.Bold instead.

Type:   Variable

Access: Read/Write

RAxisFontItalic

Determines if the title font is italic.

This property has been Deprecated. Please use PlotWindow.RAxis.Font.Italic instead.

Type:   Variable

Access: Read/Write

RAxisLabel

The text used for the R-Axis label of a plot window.

This property has been Deprecated. Please use PlotWindow.RAxis.Title.Text instead.

Type:   String

Access: Read/Write

RAxisSize

The font size to use on the plot R-Axis.

This property has been Deprecated. Please use PlotWindow.RAxis.Font.Size instead.

Type:   Variable

Access: Read/Write

Units:   points

SubTitle

The text used for the subtitle of the plot window.

This property has been Deprecated. Please use PlotWindow.PlotSubTitle.Text instead.

Type:   String

Access: Read/Write

SubtitleFont

The font to use on the plot subtitle. If the selected font is not installed on the system the default will be used.

This property has been Deprecated. Please use PlotWindow.PlotSubTitle.Font.Typeface instead.

Type:   String

Access: Read/Write

SubtitleFontBold

Determines if the sub-title font is bold.

This property has been Deprecated. Please use PlotWindow.PlotSubTitle.Font.Bold instead.

Type:   Variable

Access: Read/Write

SubtitleFontItalic

Determines if the sub-title font is italic.

This property has been Deprecated. Please use PlotWindow.PlotSubTitle.Font.Italic instead.

Type:   Variable

Access: Read/Write

SubtitleSize

The font size to use on the plot subtitle.

This property has been Deprecated. Please use PlotWindow.PlotSubTitle.Font.Size instead.

Type:   Variable

Access: Read/Write

Units:   points

ThetaAxisFont

The font to use on the plot Theta-Axis.

This property has been Deprecated. Please use PlotWindow.ThetaAxis.Font.Typeface instead.

Type:   String

Access: Read/Write

ThetaAxisFontBold

Determines if the Theta-Axis font is bold.

This property has been Deprecated. Please use PlotWindow.ThetaAxis.Font.Bold instead.

Type:   Variable

Access: Read/Write

ThetaAxisFontItalic

Determines if the Theta-Axis font is italic.

This property has been Deprecated. Please use PlotWindow.ThetaAxis.Font.Italic instead.

Type:   Variable

Access: Read/Write

ThetaAxisLabel

The text used for the Theta-Axis label of the plot window.

This property has been Deprecated. Please use PlotWindow.ThetaAxis.Title.Text instead.

Type:   String

Access: Read/Write

ThetaAxisSize

The font size to use on the plot Theta-Axis.

This property has been Deprecated. Please use PlotWindow.ThetaAxis.Font.Size instead.

Type:   Variable

Access: Read/Write

Units:   points

Title

The text used for the main title of the plot window.

This property has been Deprecated. Please use PlotWindow.PlotTitle.Text instead.

Type:   String

Access: Read/Write

TitleFont

The font to use on the plot title. If the selected font is not installed on the system the default will be used.

This property has been Deprecated. Please use PlotWindow.PlotTitle.Font.Typeface instead.

Type:   String

Access: Read/Write

TitleFontBold

Determines if the title font is bold.

This property has been Deprecated. Please use PlotWindow.PlotTitle.Font.Bold instead.

Type:   Variable

Access: Read/Write

TitleFontItalic

Determines if the title font is italic.

This property has been Deprecated. Please use PlotWindow.PlotTitle.Font.Italic instead.

Type:   Variable

Access: Read/Write

TitleFontSize

The font size to use on the plot title.

This property has been Deprecated. Please use PlotWindow.PlotTitle.Font.Size instead.

Type:   Variable

Access: Read/Write

Units:   points

XAxisFont

The font to use on the plot X-Axis.

This property has been Deprecated. Please use PlotWindow.XAxis.Text instead.

Type:   String

Access: Read/Write

XAxisFontBold

Determines if the X-Axis font is bold.

This property has been Deprecated. Please use PlotWindow.XAxis.Font.Bold instead.

Type:   Variable

Access: Read/Write

XAxisFontItalic

Determines if the X-Axis font is italic.

This property has been Deprecated. Please use PlotWindow.XAxis.Font.Italic instead.

Type:   Variable

Access: Read/Write

XAxisLabel

The text used for the X-Axis label of the plot window.

This property has been Deprecated. Please use PlotWindow.XAxis.Title.Text instead.

Type:   String

Access: Read/Write

XAxisSize

The font size to use on the plot X-Axis.

This property has been Deprecated. Please use PlotWindow.XAxis.Font.Size instead.

Type:   Variable

Access: Read/Write

Units:   points

YAxisFont

The font to use on the plot Y-Axis.

This property has been Deprecated. Please use PlotWindow.YAxis.Font.Typeface instead.

Type:   String

Access: Read/Write

YAxisFontBold

Determines if the Y-Axis font is bold.

This property has been Deprecated. Please use PlotWindow.YAxis.Font.Bold instead.

Type:   Variable

Access: Read/Write

YAxisFontItalic

Determines if the Y-Axis font is italic.

This property has been Deprecated. Please use PlotWindow.YAxis.Font.Italic instead.

Type:   Variable

Access: Read/Write

YAxisLabel

The text used for the Y-Axis label of the plot window.

This property has been Deprecated. Please use PlotWindow.YAxis.Title.Text instead.

Type:   String

Access: Read/Write

YAxisSize

The font size to use on the plot Y-Axis.

This property has been Deprecated. Please use PlotWindow.YAxis.Font.Size instead.

Type:   Variable

Access: Read/Write

Units:   points

Name

Description

Maximize

Maximizes the window.

This method has been Deprecated. Please use OutputLayout.SetWindowState method instead.

Minimize

Minimizes the window.

This method has been Deprecated. Please use OutputLayout.SetWindowState method instead.