AxisStyleSetting Class¶
-
class
NXOpen.CAE.Xyplot.
AxisStyleSetting
¶ Bases:
NXOpen.TaggedObject
,NXOpen.CAE.Xyplot.IDisplayStyle
Represents the axis display style.
Call
CAE.Xyplot.IDisplayStyle.CommitChange()
to apply style changes to corresponding plot after it’s modified.Not support KF.
New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
AxisType | Returns or sets the axis scale type |
DbDecades | Returns or sets the number of dB decades to display. |
DbRef | Returns or sets the dB reference value for a dB axis type. |
DbScale | Returns or sets the dB scale. |
GraphOverhead | Returns or sets the round value to display. |
LogDecades | Returns or sets the number of Log decades to display. |
Owner | Returns the owner style |
Tag | Returns the Tag for this object. |
UnitSystem | Returns or sets the unit system |
Methods¶
Method | Description |
---|---|
CommitChange | Commits any edits that have been applied to the display style. |
Find | Finds the NXOpen.NXObject with the given identifier as recorded in a journal. |
Property Detail¶
AxisType¶
-
AxisStyleSetting.
AxisType
¶ Returns or sets the axis scale type
-------------------------------------
Getter Method
Signature
AxisType()
Returns: Return type: NXOpen.CAE.Xyplot.AxisType
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AxisType(axisType)
Parameters: axisType ( NXOpen.CAE.Xyplot.AxisType
) –New in version NX9.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)
DbDecades¶
-
AxisStyleSetting.
DbDecades
¶ Returns or sets the number of dB decades to display.
Avaliable when
CAE.Xyplot.AxisStyleSetting.AxisType`()
isCAE.XyplotAxisType.Db
.-------------------------------------
Getter Method
Signature
DbDecades()
Returns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DbDecades(dbDecades)
Parameters: dbDecades (int) – New in version NX9.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)
DbRef¶
-
AxisStyleSetting.
DbRef
¶ Returns or sets the dB reference value for a dB axis type.
Avaliable when
CAE.Xyplot.AxisStyleSetting.AxisType`()
isCAE.XyplotAxisType.Db
.-------------------------------------
Getter Method
Signature
DbRef()
Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DbRef(dbRef)
Parameters: dbRef (float) – New in version NX9.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)
DbScale¶
-
AxisStyleSetting.
DbScale
¶ Returns or sets the dB scale.
Avaliable when
CAE.Xyplot.AxisStyleSetting.AxisType`()
isCAE.XyplotAxisType.Db
.-------------------------------------
Getter Method
Signature
DbScale()
Returns: Return type: NXOpen.CAE.Xyplot.AxisDBScale
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DbScale(dbScale)
Parameters: dbScale ( NXOpen.CAE.Xyplot.AxisDBScale
) –New in version NX9.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)
GraphOverhead¶
-
AxisStyleSetting.
GraphOverhead
¶ Returns or sets the round value to display.
It is a percent value. Avaliable when
CAE.Xyplot.AxisStyleSetting.AxisType`()
is notCAE.XyplotAxisType.Auto
.-------------------------------------
Getter Method
Signature
GraphOverhead()
Returns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GraphOverhead(graphOverhead)
Parameters: graphOverhead (int) – New in version NX9.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)
LogDecades¶
-
AxisStyleSetting.
LogDecades
¶ Returns or sets the number of Log decades to display.
Avaliable when
CAE.Xyplot.AxisStyleSetting.AxisType`()
isCAE.XyplotAxisType.Log
.-------------------------------------
Getter Method
Signature
LogDecades()
Returns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LogDecades(logDecades)
Parameters: logDecades (int) – New in version NX9.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)
Owner¶
-
AxisStyleSetting.
Owner
¶ Returns the owner style
-------------------------------------
Getter Method
Signature
Owner()
Returns: Return type: NXOpen.CAE.Xyplot.IDisplayStyle
New in version NX10.0.0.
License requirements: None.
UnitSystem¶
-
AxisStyleSetting.
UnitSystem
¶ Returns or sets the unit system
-------------------------------------
Getter Method
Signature
UnitSystem()
Returns: Return type: NXOpen.CAE.Xyplot.UnitSystem
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UnitSystem(unitSystem)
Parameters: unitSystem ( NXOpen.CAE.Xyplot.UnitSystem
) –New in version NX9.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)
Method Detail¶
CommitChange¶
-
AxisStyleSetting.
CommitChange
¶ Commits any edits that have been applied to the display style.
Triggers the corresponding plot to update graph.
Signature
CommitChange()
New in version NX9.0.0.
License requirements: nx_ftk (“NX Advanced Graphing”)
Find¶
-
AxisStyleSetting.
Find
¶ Finds the
NXOpen.NXObject
with the given identifier as recorded in a journal.An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.
An exception will be thrown if no object can be found with the given journal identifier.
Signature
Find(journalIdentifier)
Parameters: journalIdentifier (str) – Journal identifier of the object Returns: Return type: NXOpen.TaggedObject
New in version NX10.0.0.
License requirements: None.