AxisStyleSetting Class

class NXOpen.CAE.Xyplot.AxisStyleSetting

Bases: NXOpen.CAE.Xyplot.BaseDisplayStyleSetting

Represents the axis display style.

Call CAE.Xyplot.BaseDisplayStyleSetting.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.
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
LimitsType	Returns or sets the limits type
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
UnitSystemType	Returns or sets the unit system type

Methods

Method	Description
CommitChange	Commits any edits that have been applied to the display style.
Find	Finds the NXOpen.TaggedObject with the given identifier as recorded in a journal.
GetDBSettings	Gets the dB settings
GetDisplayUnit	Gets display unit
GetFixedLimits	Gets the fixed limits
GetLabelStyle	Gets the label style
GetNumberStyle	Gets the number style
LogUnitChangedEvent	Logs an update event for changing display unit before committing AxisStyleSetting change.
SetFixedLimits	Sets the fixed limits

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

Parameters:axisType (NXOpen.CAE.Xyplot.AxisType) –

New in version NX9.0.0.

License requirements: None.

DbDecades

AxisStyleSetting.DbDecades

Returns or sets the number of dB decades to display.

Avaliable when CAE.Xyplot.AxisStyleSetting.AxisType`() is CAE.XyplotAxisType.Db.

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

Getter Method

Signature DbDecades

Returns: Return type:int

New in version NX9.0.0.

Deprecated since version NX12.0.0: Removed without replacement.

License requirements: None.

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

Setter Method

Signature DbDecades

Parameters:dbDecades (int) –

New in version NX9.0.0.

Deprecated since version NX12.0.0: Removed without replacement.

License requirements: None.

DbRef

AxisStyleSetting.DbRef

Returns or sets the dB reference value for a dB axis type.

Avaliable when CAE.Xyplot.AxisStyleSetting.AxisType`() is CAE.XyplotAxisType.Db.

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

Getter Method

Signature DbRef

Returns: Return type:float

New in version NX9.0.0.

Deprecated since version NX12.0.0: Use NXOpen.CAE.SignalProcessingDBSettings.DBReference()

License requirements: None.

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

Setter Method

Signature DbRef

Parameters:dbRef (float) –

New in version NX9.0.0.

Deprecated since version NX12.0.0: Use NXOpen.CAE.SignalProcessingDBSettings.SetDBReference()

License requirements: None.

DbScale

AxisStyleSetting.DbScale

Returns or sets the dB scale.

Avaliable when CAE.Xyplot.AxisStyleSetting.AxisType`() is CAE.XyplotAxisType.Db.

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

Getter Method

Signature DbScale

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

New in version NX9.0.0.

Deprecated since version NX12.0.0: Use NXOpen.CAE.SignalProcessingDBSettings.DBFormat()

License requirements: None.

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

Setter Method

Signature DbScale

Parameters:dbScale (NXOpen.CAE.Xyplot.AxisDBScale) –

New in version NX9.0.0.

Deprecated since version NX12.0.0: Use NXOpen.CAE.SignalProcessingDBSettings.SetDBFormat()

License requirements: None.

GraphOverhead

AxisStyleSetting.GraphOverhead

Returns or sets the round value to display.

It is a percent value. Avaliable when CAE.Xyplot.AxisStyleSetting.AxisType`() is not CAE.XyplotAxisType.Auto.

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

Getter Method

Signature GraphOverhead

Returns: Return type:int

New in version NX9.0.0.

Deprecated since version NX12.0.0: Removed without replacement.

License requirements: None.

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

Setter Method

Signature GraphOverhead

Parameters:graphOverhead (int) –

New in version NX9.0.0.

Deprecated since version NX12.0.0: Removed without replacement.

License requirements: None.

LimitsType

AxisStyleSetting.LimitsType

Returns or sets the limits type

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

Getter Method

Signature LimitsType

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

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature LimitsType

Parameters:limitsType (NXOpen.CAE.Xyplot.LimitsType) –

New in version NX12.0.0.

License requirements: None.

LogDecades

AxisStyleSetting.LogDecades

Returns or sets the number of Log decades to display.

Avaliable when CAE.Xyplot.AxisStyleSetting.AxisType`() is CAE.XyplotAxisType.Log.

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

Getter Method

Signature LogDecades

Returns: Return type:int

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature LogDecades

Parameters:logDecades (int) –

New in version NX9.0.0.

License requirements: None.

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.

Deprecated since version NX12.0.0: Use NXOpen.CAE.Xyplot.AxisStyleSetting.UnitSystemType() instead.

License requirements: None.

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

Setter Method

Signature UnitSystem

Parameters:unitSystem (NXOpen.CAE.Xyplot.UnitSystem) –

New in version NX9.0.0.

Deprecated since version NX12.0.0: Use NXOpen.CAE.Xyplot.AxisStyleSetting.UnitSystemType() instead.

License requirements: None.

UnitSystemType

AxisStyleSetting.UnitSystemType

Returns or sets the unit system type

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

Getter Method

Signature UnitSystemType

Returns: Return type:NXOpen.CAE.XyFunctionUnitSystem

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature UnitSystemType

Parameters:unitSystemType (NXOpen.CAE.XyFunctionUnitSystem) –

New in version NX12.0.0.

License requirements: None.

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: None.

GetDBSettings

AxisStyleSetting.GetDBSettings

Gets the dB settings

Signature GetDBSettings()

Returns: Return type:NXOpen.CAE.SignalProcessingDBSettings

New in version NX11.0.0.

License requirements: None.

GetDisplayUnit

AxisStyleSetting.GetDisplayUnit

Gets display unit

Signature GetDisplayUnit()

Returns: Return type:NXOpen.CAE.FTK.BaseUnit

New in version NX12.0.0.

License requirements: None.

GetFixedLimits

AxisStyleSetting.GetFixedLimits

Gets the fixed limits

Signature GetFixedLimits()

Returns:a tuple Return type:A tuple consisting of (lowerLimit, upperLimit) lowerLimit is a float. upperLimit is a float.

New in version NX12.0.0.

License requirements: None.

GetLabelStyle

AxisStyleSetting.GetLabelStyle

Gets the label style

Signature GetLabelStyle()

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

New in version NX11.0.0.

License requirements: None.

GetNumberStyle

AxisStyleSetting.GetNumberStyle

Gets the number style

Signature GetNumberStyle()

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

New in version NX11.0.0.

License requirements: None.

LogUnitChangedEvent

AxisStyleSetting.LogUnitChangedEvent

Logs an update event for changing display unit before committing AxisStyleSetting change.

Signature LogUnitChangedEvent()

New in version NX12.0.0.

License requirements: None.

SetFixedLimits

AxisStyleSetting.SetFixedLimits

Sets the fixed limits

Signature SetFixedLimits(lowerLimit, upperLimit)

Parameters:

• lowerLimit (float) –
• upperLimit (float) –

New in version NX12.0.0.

License requirements: None.