PlotParameters Class

class NXOpen.CAE.Xyplot.PlotParameters

Bases: NXOpen.CAE.Xyplot.BasePlotParameters

Represents the parameters passed to create a plot.

To create a new instance of this class, use NXOpen.CAE.Xyplot.XYPlotManager.NewPlotParameters()

New in version NX9.0.0.

Properties

Property	Description
ComplexOption	Returns or sets the complex options,if complex option is smaller than zero, it will use default complex option from active template file
DeviceIndex	Returns or sets the index of device on which plot graph will be shown.
IsToCreateStandalonePlot	Returns or sets the create standalone plot
PlotTemplate	Returns the plot template to be used by the plot
PlotType	Returns or sets the plot type
ViewPortIndex	Returns or sets the index of a view port on main graphic window, on which plot graph will be shown.

Methods

Method	Description
Dispose	Destroys the object
GetRecords	Gets the records to be plotted
SetRecords	Sets the records to be plotted

Property Detail

ComplexOption

PlotParameters.ComplexOption

Returns or sets the complex options,if complex option is smaller than zero, it will use default complex option from active template file

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

Getter Method

Signature ComplexOption

Returns: Return type:int

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature ComplexOption

Parameters:complexOption (int) –

New in version NX11.0.0.

License requirements: None.

IsToCreateStandalonePlot

PlotParameters.IsToCreateStandalonePlot

Returns or sets the create standalone plot

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

Getter Method

Signature IsToCreateStandalonePlot

Returns: Return type:bool

New in version NX11.0.0.

License requirements: None.

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

Setter Method

Signature IsToCreateStandalonePlot

Parameters:isToCreateStandalonePlot (bool) –

New in version NX11.0.0.

License requirements: None.

PlotTemplate

PlotParameters.PlotTemplate

Returns the plot template to be used by the plot

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

Getter Method

Signature PlotTemplate

Returns: Return type:NXOpen.CAE.Xyplot.PlotGraphTemplate

New in version NX10.0.0.

License requirements: None.

PlotType

PlotParameters.PlotType

Returns or sets the plot type

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

Getter Method

Signature PlotType

Returns: Return type:NXOpen.CAE.Xyplot.PlotType

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature PlotType

Parameters:plotType (NXOpen.CAE.Xyplot.PlotType) –

New in version NX10.0.0.

License requirements: None.