NXOpen .NET Reference  12.0.0
Public Member Functions | Properties | List of all members
NXOpen.CAE.Xyplot.XYPlotManager Class Reference

XYPlot function manager More...

Inheritance diagram for NXOpen.CAE.Xyplot.XYPlotManager:

Public Member Functions

unsafe NXOpen.CAE.Xyplot.Plot PlotRecords (NXOpen.CAE.Xyplot.PlotParameters plotParameters)
 Creates plot with given parameters More...
 
unsafe NXOpen.CAE.Xyplot.Plot OverlayRecords (NXOpen.CAE.Xyplot.OverlayParameters overlayParameters)
 Overlay records with given parameters More...
 
unsafe NXOpen.CAE.Xyplot.Plot GetCurrentPlot (int deviceIndex, int viewIndex)
 Gets the current plot on the view port of specific device More...
 
unsafe void ShowNextPlot (int deviceIndex, int viewIndex)
 Shows the next plot on the view port of specific device More...
 
unsafe void ShowPreviousPlot (int deviceIndex, int viewIndex)
 Shows the previous plot on the view port of specific device More...
 
unsafe
NXOpen.CAE.Xyplot.PlotParameters 
NewPlotParameters ()
 Creates an transient object NXOpen.CAE.Xyplot.PlotParameters to contain the settings required by creating a plot. More...
 
unsafe
NXOpen.CAE.Xyplot.OverlayParameters 
NewOverlayParameters ()
 Creates an transient object NXOpen.CAE.Xyplot.PlotParameters to contain the settings required by overlaying new records on a plot. More...
 
unsafe int[] GetAvailableWindowDevices ()
 Gets all window devices on which XY graph could be plotted More...
 
unsafe int[] GetWindowDevicesViews (int windowDevice)
 Gets view count and views for specified window device More...
 
unsafe NXOpen.CAE.Xyplot.Plot[] GetPlots (int windowDevice, int view)
 Gets all plots on a view of specified window device More...
 
unsafe void ReturnToModelView (int view)
 Clears all plots on a view of main graphics windows and returns to model view More...
 
unsafe void WriteImageToClipBoard (int deviceIndex, int viewIndex, bool isUseWhiteBackGround)
 Write the image of current plot on a view to Windows's ClipBoard More...
 
unsafe NXOpen.CAE.Xyplot.Plot FindObject (string journalIdentifier)
 Finds the CAE.Xyplot.Plot with the given identifier as recorded in a journal More...
 

Properties

Tag Tag [get]
 Returns the tag of this object. More...
 
NXOpen.CAE.Xyplot.WindowManager WindowManager [get]
 Returns the NXOpen.CAE.Xyplot.WindowManager belonging. More...
 
unsafe NXOpen.CAE.Xyplot.Preference Preference [get]
 Returns the preference More...
 
unsafe
NXOpen.CAE.Xyplot.BaseTemplateManager 
TemplateManager [get]
 Returns the template manager. More...
 

Detailed Description

XYPlot function manager

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

Created in NX7.5.0

Member Function Documentation

unsafe NXOpen.CAE.Xyplot.Plot NXOpen.CAE.Xyplot.XYPlotManager.FindObject ( string  journalIdentifier)

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

Created in NX12.0.0

License requirements: None.

Parameters
journalIdentifierIdentifier of the CAE.Xyplot.Plot to be found
Returns
Plot object found, or null if no such plot exists
unsafe int [] NXOpen.CAE.Xyplot.XYPlotManager.GetAvailableWindowDevices ( )

Gets all window devices on which XY graph could be plotted

Created in NX9.0.0

License requirements: None.

Returns
Available Plot Winodw Devices
unsafe NXOpen.CAE.Xyplot.Plot NXOpen.CAE.Xyplot.XYPlotManager.GetCurrentPlot ( int  deviceIndex,
int  viewIndex 
)

Gets the current plot on the view port of specific device

Created in NX9.0.0

License requirements: None.

Parameters
deviceIndexDevice index
viewIndexView index
Returns
Current plot
unsafe NXOpen.CAE.Xyplot.Plot [] NXOpen.CAE.Xyplot.XYPlotManager.GetPlots ( int  windowDevice,
int  view 
)

Gets all plots on a view of specified window device

Created in NX9.0.0

License requirements: None.

Parameters
windowDevicePlot index
viewView index
Returns
Plots
unsafe int [] NXOpen.CAE.Xyplot.XYPlotManager.GetWindowDevicesViews ( int  windowDevice)

Gets view count and views for specified window device

Created in NX9.0.0

License requirements: None.

Parameters
windowDevicewindow index
Returns
the views on window device
unsafe NXOpen.CAE.Xyplot.OverlayParameters NXOpen.CAE.Xyplot.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.

Created in NX9.0.0

License requirements: None.

Returns
the overlay parameters object created
unsafe NXOpen.CAE.Xyplot.PlotParameters NXOpen.CAE.Xyplot.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.

Created in NX9.0.0

License requirements: None.

Returns
the plot parameters object created
unsafe NXOpen.CAE.Xyplot.Plot NXOpen.CAE.Xyplot.XYPlotManager.OverlayRecords ( NXOpen.CAE.Xyplot.OverlayParameters  overlayParameters)

Overlay records with given parameters

Created in NX9.0.0

License requirements: None.

Parameters
overlayParametersthe overlay parameters
Returns
Overlayed plot
unsafe NXOpen.CAE.Xyplot.Plot NXOpen.CAE.Xyplot.XYPlotManager.PlotRecords ( NXOpen.CAE.Xyplot.PlotParameters  plotParameters)

Creates plot with given parameters

Created in NX9.0.0

License requirements: None.

Parameters
plotParametersthe plot parameters
Returns
Created plot
unsafe void NXOpen.CAE.Xyplot.XYPlotManager.ReturnToModelView ( int  view)

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

Created in NX11.0.0

License requirements: None.

Parameters
viewView index
unsafe void NXOpen.CAE.Xyplot.XYPlotManager.ShowNextPlot ( int  deviceIndex,
int  viewIndex 
)

Shows the next plot on the view port of specific device

Created in NX9.0.0

License requirements: None.

Parameters
deviceIndexDevice index
viewIndexView index
unsafe void NXOpen.CAE.Xyplot.XYPlotManager.ShowPreviousPlot ( int  deviceIndex,
int  viewIndex 
)

Shows the previous plot on the view port of specific device

Created in NX9.0.0

License requirements: None.

Parameters
deviceIndexDevice index
viewIndexView index
unsafe void NXOpen.CAE.Xyplot.XYPlotManager.WriteImageToClipBoard ( int  deviceIndex,
int  viewIndex,
bool  isUseWhiteBackGround 
)

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

Created in NX12.0.0

License requirements: None.

Parameters
deviceIndexDevice index
viewIndexView index
isUseWhiteBackGround

Property Documentation

unsafe NXOpen.CAE.Xyplot.Preference NXOpen.CAE.Xyplot.XYPlotManager.Preference
get

Returns the preference

Created in NX9.0.0

License requirements: None.

Tag NXOpen.CAE.Xyplot.XYPlotManager.Tag
get

Returns the tag of this object.

unsafe NXOpen.CAE.Xyplot.BaseTemplateManager NXOpen.CAE.Xyplot.XYPlotManager.TemplateManager
get

Returns the template manager.

Created in NX10.0.0

License requirements: None.

NXOpen.CAE.Xyplot.WindowManager NXOpen.CAE.Xyplot.XYPlotManager.WindowManager
get

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 a null reference (Nothing in Visual Basic).

Created in NX9.0.0


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.