XYPlotManager Class¶

class NXOpen.CAE.Xyplot.XYPlotManager¶

Bases: object

XYPlot function manager

To obtain an instance of this class use NXOpen.Session.XYPlotManager.

New in version NX7.5.0.

Properties¶

Property	Description
Preference	Returns the preference
TemplateManager	Returns the template manager.

Methods¶

Method	Description
GetAvailableWindowDevices	Gets all window devices on which XY graph could be plotted @return Available Plot Winodw Devices
GetCurrentPlot	Gets the current plot on the view port of specific device @return Current plot
GetPlots	Gets all plots on a view of specified window device @return Plots
GetTemplateManager2d	Gets the 2D template manager @return 2D template manager
GetTemplateManager3d	Gets the 3D template manager @return 3D template manager
GetWindowDevicesViews	Gets view count and views for specified window device @return the views on window device
NewOverlayParameters	Creates an transient object `NXOpen.CAE.Xyplot.PlotParameters` to contain the settings required by overlaying new records on a plot.
NewPlotParameters	Creates an transient object `NXOpen.CAE.Xyplot.PlotParameters` to contain the settings required by creating a plot.
OverlayRecords	Overlay records with given parameters @return Overlayed plot
PlotRecords	Creates plot with given parameters @return Created plot
ShowNextPlot	Shows the next plot on the view port of specific device
ShowPreviousPlot	Shows the previous plot on the view port of specific device

Property Detail¶

Preference¶

XYPlotManager.Preference¶

Returns the preference

-------------------------------------

Getter Method

Signature Preference()

Returns:
Return type:	`NXOpen.CAE.Xyplot.Preference`

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

TemplateManager¶

XYPlotManager.TemplateManager¶

Returns the template manager.

-------------------------------------

Getter Method

Signature TemplateManager()

Returns:	Template manager
Return type:	`NXOpen.CAE.Xyplot.BaseTemplateManager`

New in version NX10.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

Method Detail¶

GetAvailableWindowDevices¶

XYPlotManager.GetAvailableWindowDevices¶

Gets all window devices on which XY graph could be plotted

Signature GetAvailableWindowDevices()

Returns:	Available Plot Winodw Devices
Return type:	list of int

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

GetCurrentPlot¶

XYPlotManager.GetCurrentPlot¶

Gets the current plot on the view port of specific device

Signature GetCurrentPlot(deviceIndex, viewIndex)

Parameters:	deviceIndex (int) – Device index viewIndex (int) – View index
Returns:	Current plot
Return type:	`NXOpen.CAE.Xyplot.Plot`

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

GetPlots¶

XYPlotManager.GetPlots¶

Gets all plots on a view of specified window device

Signature GetPlots(windowDevice, view)

Parameters:	windowDevice (int) – Plot index view (int) – View index
Returns:	Plots
Return type:	list of `NXOpen.CAE.Xyplot.Plot`

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

GetTemplateManager2d¶

XYPlotManager.GetTemplateManager2d¶

Gets the 2D template manager

Signature GetTemplateManager2d()

Returns:	2D template manager
Return type:	`NXOpen.CAE.Xyplot.BaseTemplateManager`

New in version NX7.5.0.

Deprecated since version NX10.0.0: Use NXOpen.CAE.Xyplot.XYPlotManager.TemplateManager instead.

License requirements: nx_ftk (“NX Advanced Graphing”)

GetTemplateManager3d¶

XYPlotManager.GetTemplateManager3d¶

Gets the 3D template manager

Signature GetTemplateManager3d()

Returns:	3D template manager
Return type:	`NXOpen.CAE.Xyplot.BaseTemplateManager`

New in version NX7.5.0.

Deprecated since version NX10.0.0: Use NXOpen.CAE.Xyplot.XYPlotManager.TemplateManager instead.

License requirements: nx_ftk (“NX Advanced Graphing”)

GetWindowDevicesViews¶

XYPlotManager.GetWindowDevicesViews¶

Gets view count and views for specified window device

Signature GetWindowDevicesViews(windowDevice)

Parameters:	windowDevice (int) – window index
Returns:	the views on window device
Return type:	list of int

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

NewOverlayParameters¶

XYPlotManager.NewOverlayParameters¶

Creates an transient object NXOpen.CAE.Xyplot.PlotParameters to contain the settings required by overlaying new records on a plot.

The object should be destroyed after overlaying plot is created.

Signature NewOverlayParameters()

Returns:	the overlay parameters object created
Return type:	`NXOpen.CAE.Xyplot.OverlayParameters`

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

NewPlotParameters¶

XYPlotManager.NewPlotParameters¶

Creates an transient object NXOpen.CAE.Xyplot.PlotParameters to contain the settings required by creating a plot.

The object should be destroyed after plot is created.

Signature NewPlotParameters()

Returns:	the plot parameters object created
Return type:	`NXOpen.CAE.Xyplot.PlotParameters`

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

OverlayRecords¶

XYPlotManager.OverlayRecords¶

Overlay records with given parameters

Signature OverlayRecords(overlayParameters)

Parameters:	overlayParameters (`NXOpen.CAE.Xyplot.OverlayParameters`) – the overlay parameters
Returns:	Overlayed plot
Return type:	`NXOpen.CAE.Xyplot.Plot`

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

PlotRecords¶

XYPlotManager.PlotRecords¶

Creates plot with given parameters

Signature PlotRecords(plotParameters)

Parameters:	plotParameters (`NXOpen.CAE.Xyplot.PlotParameters`) – the plot parameters
Returns:	Created plot
Return type:	`NXOpen.CAE.Xyplot.Plot`

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

ShowNextPlot¶

XYPlotManager.ShowNextPlot¶

Shows the next plot on the view port of specific device

Signature ShowNextPlot(deviceIndex, viewIndex)

Parameters:	deviceIndex (int) – Device index viewIndex (int) – View index

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

ShowPreviousPlot¶

XYPlotManager.ShowPreviousPlot¶

Shows the previous plot on the view port of specific device

Signature ShowPreviousPlot(deviceIndex, viewIndex)

Parameters:	deviceIndex (int) – Device index viewIndex (int) – View index

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)