OverlayParameters Class¶
-
class
NXOpen.CAE.Xyplot.
OverlayParameters
¶ Bases:
NXOpen.CAE.Xyplot.BasePlotParameters
Represents the parameters passed to overlay plot records on an existing plot graph.
To create a new instance of this class, use
NXOpen.CAE.Xyplot.XYPlotManager.NewOverlayParameters()
New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
DeviceIndex | Returns or sets the index of device on which plot graph will be shown. |
SubGraphInStack | Returns or sets the index of subgraph on a stacked plot, on which the records will be overlaied. |
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¶
SubGraphInStack¶
-
OverlayParameters.
SubGraphInStack
¶ Returns or sets the index of subgraph on a stacked plot, on which the records will be overlaied.
The property is only available when overlaying records on a stacked plot. The index value is between 0 and the property value of
CAE.Xyplot.Plot.SubGraphCountInStack()
.-------------------------------------
Getter Method
Signature
SubGraphInStack()
Returns: The sub-graph index Return type: int New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SubGraphInStack(subGraphIndex)
Parameters: subGraphIndex (int) – The sub-graph index New in version NX10.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)