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
DeviceIndex	Returns or sets the index of device on which plot graph will be shown.
GraphTemplate	Returns the graph template to be used by the plot
Is2DPlot	Returns or sets the value indicates whether to create a 2D 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 @return Records
SetRecords	Sets the records to be plotted

Property Detail

GraphTemplate

PlotParameters.GraphTemplate

Returns the graph template to be used by the plot

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

Getter Method

Signature GraphTemplate()

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

New in version NX9.0.0.

Deprecated since version NX10.0.0: Use CAE.Xyplot.PlotParameters.PlotTemplate instead.

License requirements: None.

Is2DPlot

PlotParameters.Is2DPlot

Returns or sets the value indicates whether to create a 2D plot

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

Getter Method

Signature Is2DPlot()

Returns: Return type:bool

New in version NX9.0.0.

Deprecated since version NX10.0.0: Use CAE.Xyplot.PlotParameters.PlotType instead.

License requirements: None.

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

Setter Method

Signature Is2DPlot(is2DPlot)

Parameters:is2DPlot (bool) –

New in version NX9.0.0.

Deprecated since version NX10.0.0: Use CAE.Xyplot.PlotParameters.PlotType instead.

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(plotType)

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

New in version NX10.0.0.

License requirements: None.