BasePlotParameters Class¶
-
class
NXOpen.CAE.Xyplot.
BasePlotParameters
¶ Bases:
NXOpen.TransientObject
Represents the parameters passed to create or modify a plot.
This is an abstract class
New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
DeviceIndex | Returns or sets the index of device on which plot graph will be shown. |
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¶
DeviceIndex¶
-
BasePlotParameters.
DeviceIndex
¶ Returns or sets the index of device on which plot graph will be shown.
A value of 1 represents the main graphic window, a value greater than 2 represents separate graphic window.
-------------------------------------
Getter Method
Signature
DeviceIndex()
Returns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DeviceIndex(deviceIndex)
Parameters: deviceIndex (int) – New in version NX9.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)
ViewPortIndex¶
-
BasePlotParameters.
ViewPortIndex
¶ Returns or sets the index of a view port on main graphic window, on which plot graph will be shown.
Only available when
CAE.Xyplot.BasePlotParameters.DeviceIndex`
is 1.-------------------------------------
Getter Method
Signature
ViewPortIndex()
Returns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ViewPortIndex(viewIndex)
Parameters: viewIndex (int) – New in version NX9.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)
Method Detail¶
Dispose¶
-
BasePlotParameters.
Dispose
¶ Destroys the object
Signature
Dispose()
New in version NX9.0.0.
License requirements: None.
GetRecords¶
-
BasePlotParameters.
GetRecords
¶ Gets the records to be plotted
Signature
GetRecords()
Returns: Records Return type: list of NXOpen.CAE.FTK.BaseRecord
New in version NX9.0.0.
License requirements: None.
SetRecords¶
-
BasePlotParameters.
SetRecords
¶ Sets the records to be plotted
Signature
SetRecords(records)
Parameters: records (list of NXOpen.CAE.FTK.BaseRecord
) – RecordsNew in version NX9.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)