Preference Class¶
-
class
NXOpen.CAE.Xyplot.
Preference
¶ Bases:
NXOpen.TaggedObject
Manages the preference data.
Not support KF.
New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
AfuRecordZValue | Returns or sets the Z value type for afu record in 3D plot |
MaximumLegendsInGraph | Returns or sets the maximum legend count on a graph. |
MaximumSubGraphsInStack | Returns or sets the maximum sub-graph count in a stacked graph |
NewWindowSetting | Returns or sets the new window setting value. |
Tag | Returns the Tag for this object. |
TargetWindowSetting | Returns or sets the target window setting value |
UpdateOverlayingAxisLimitsAutomatically | Returns or sets the status whether to update the axis limits automatically when overlaying records at next time |
Methods¶
Method | Description |
---|---|
Save | Saves preference settings to memory file so that preference setting could be shared among sessions |
Enumerations¶
PreferenceNewWindowChoice Enumeration | Defines whether to always show plot graph on a new separate graphic window |
PreferenceTargetGraphicWindowOption Enumeration | Defines the target graphic window type |
Property Detail¶
AfuRecordZValue¶
-
Preference.
AfuRecordZValue
¶ Returns or sets the Z value type for afu record in 3D plot
-------------------------------------
Getter Method
Signature
AfuRecordZValue()
Returns: The afu record z value Return type: NXOpen.CAE.FTK.DataManagerAfuRecordZValue
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AfuRecordZValue(afuZValue)
Parameters: afuZValue ( NXOpen.CAE.FTK.DataManagerAfuRecordZValue
) – The 3D afu record z valueNew in version NX10.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)
MaximumLegendsInGraph¶
-
Preference.
MaximumLegendsInGraph
¶ Returns or sets the maximum legend count on a graph.
If the record count on a graph exceeds this maximum number, legends will not be displayed and synchronized probing will be disabled.
-------------------------------------
Getter Method
Signature
MaximumLegendsInGraph()
Returns: The maximum legend count Return type: int New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MaximumLegendsInGraph(legendCount)
Parameters: legendCount (int) – The maximum legend count New in version NX10.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)
MaximumSubGraphsInStack¶
-
Preference.
MaximumSubGraphsInStack
¶ Returns or sets the maximum sub-graph count in a stacked graph
-------------------------------------
Getter Method
Signature
MaximumSubGraphsInStack()
Returns: The maximum sub-graph count Return type: int New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MaximumSubGraphsInStack(graphCount)
Parameters: graphCount (int) – The maximum sub-graph count New in version NX10.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)
NewWindowSetting¶
-
Preference.
NewWindowSetting
¶ Returns or sets the new window setting value.
Avaliable when
CAE.Xyplot.Preference.TargetWindowSetting`
isCAE.Xyplot.PreferenceTargetGraphicWindowOption.Separate
.-------------------------------------
Getter Method
Signature
NewWindowSetting()
Returns: New window setting Return type: NXOpen.CAE.Xyplot.PreferenceNewWindowChoice
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NewWindowSetting(newWindowSetting)
Parameters: newWindowSetting ( NXOpen.CAE.Xyplot.PreferenceNewWindowChoice
) – New window settingNew in version NX9.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)
TargetWindowSetting¶
-
Preference.
TargetWindowSetting
¶ Returns or sets the target window setting value
-------------------------------------
Getter Method
Signature
TargetWindowSetting()
Returns: Return type: NXOpen.CAE.Xyplot.PreferenceTargetGraphicWindowOption
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TargetWindowSetting(targetWindowSetting)
Parameters: targetWindowSetting ( NXOpen.CAE.Xyplot.PreferenceTargetGraphicWindowOption
) –New in version NX9.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)
UpdateOverlayingAxisLimitsAutomatically¶
-
Preference.
UpdateOverlayingAxisLimitsAutomatically
¶ Returns or sets the status whether to update the axis limits automatically when overlaying records at next time
-------------------------------------
Getter Method
Signature
UpdateOverlayingAxisLimitsAutomatically()
Returns: Whether to update axis limits Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UpdateOverlayingAxisLimitsAutomatically(updateAxisLimits)
Parameters: updateAxisLimits (bool) – Whether to update axis limits New in version NX10.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)