XYPlotManager Class — NXOpen Python API Reference 12.0.0 documentation

# 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.

WindowManager

Returns the `NXOpen.CAE.Xyplot.WindowManager` belonging.
  This class is restricted to being called from a program running during an interactive NX session. If run from a non-interactive session it will return None.

# Methods

Method | Description
--- | ---
FindObject | Finds the `CAE.Xyplot.Plot` with the given identifier as recorded in a journal
GetAvailableWindowDevices | Gets all window devices on which XY graph could be plotted
GetCurrentPlot | Gets the current plot on the view port of specific device
GetPlots | Gets all plots on a view of specified window device
GetWindowDevicesViews | Gets view count and views for specified 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
PlotRecords | Creates plot with given parameters
ReturnToModelView | Clears all plots on a view of main graphics windows and returns to model view
ShowNextPlot | Shows the next plot on the view port of specific device
ShowPreviousPlot | Shows the previous plot on the view port of specific device
WriteImageToClipBoard | Write the image of current plot on a view to Windows’s ClipBoard

# 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: None.

## 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: None.

## WindowManager

`XYPlotManager.``WindowManager`

  Returns the `NXOpen.CAE.Xyplot.WindowManager` belonging.

  This class is restricted to being called from a program running during an interactive NX session. If run from a non-interactive session it will return None.

  Signature `WindowManager`

  New in version NX9.0.0.

  Returns: |
  Return type: | `NXOpen.CAE.Xyplot.WindowManager`

# Method Detail

## FindObject

`XYPlotManager.``FindObject`

  Finds the `CAE.Xyplot.Plot` with the given identifier as recorded in a journal

  Signature `FindObject(journalIdentifier)`

  Parameters: | journalIdentifier (str) – Identifier of the `CAE.Xyplot.Plot` to be found
  Returns: | Plot object found, or null if no such plot exists
  Return type: | `NXOpen.CAE.Xyplot.Plot`

  New in version NX12.0.0.

  License requirements: None.

## 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: None.

## 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: None.

## 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: None.

## 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: None.

## 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: None.

## 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: None.

## 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: None.

## 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: None.

## ReturnToModelView

`XYPlotManager.``ReturnToModelView`

  Clears all plots on a view of main graphics windows and returns to model view

  Signature `ReturnToModelView(view)`

  Parameters: | view (int) – View index

  New in version NX11.0.0.

  License requirements: None.

## 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: None.

## 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: None.

## WriteImageToClipBoard

`XYPlotManager.``WriteImageToClipBoard`

  Write the image of current plot on a view to Windows’s ClipBoard

  Signature `WriteImageToClipBoard(deviceIndex, viewIndex, isUseWhiteBackGround)`

  Parameters:

  - deviceIndex (int) – Device index
  - viewIndex (int) – View index
  - isUseWhiteBackGround (bool) –

  New in version NX12.0.0.

  License requirements: None.