AxisLabelStyle Class — NXOpen Python API Reference 12.0.0 documentation

# AxisLabelStyle Class

class `NXOpen.CAE.Xyplot.``AxisLabelStyle`

  Bases: `NXOpen.CAE.Xyplot.CustomTextStyleSetting`

  Represents the axis label display style.

  Call `CAE.Xyplot.IDisplayStyle.CommitChange()` to apply style changes to corresponding plot after it’s modified.

  Not support KF.

  New in version NX12.0.0.

# Properties

Property | Description
--- | ---
Alignment | Returns or sets the text alignment.
Color | Returns or sets the text color
Font | Returns or sets the text font
FontStyle | Returns or sets the text font style.
FontType | Returns or sets the text font type
GlobalSizeScale | Returns or sets the scale of global text size.
IncludeMeasureType | Returns or sets the option specifies whether to include measure type in axis label
IncludeUnit | Returns or sets the option specifies whether to include unit information in axis label
IsGlobalSizeAutoScaled | Returns or sets a value indicating whether to automatically adjust the scale of global text size to fit the screen.
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object.
LeaderStyle | Returns the leader style
NumberFormat | Returns the number format options
Orientation | Returns or sets the text orientation.
Owner | Returns the owner style
Size | Returns or sets the text size.
Tag | Returns the Tag for this object.
TextBoxStyle | Returns the style of text box
UseAutomatic | Returns or sets a value indicating whether to define text content automatically .
UseGlobalFontSetting | Returns or sets a value indicating whether to use the global setting of text font, font style and font size.
UseSingleLine | Returns or sets the option specifies whether to display axis label in a single line
Visibility | Returns or sets the visibility
Weight | Returns or sets the text weight.

# 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.
GetUserDefinedText | Returns the text content defined by user.
SetUserDefinedText | Sets the text content defined by user.

# Property Detail

## IncludeMeasureType

`AxisLabelStyle.``IncludeMeasureType`

  Returns or sets the option specifies whether to include measure type in axis label

  `-------------------------------------`

  Getter Method

  Signature `IncludeMeasureType`

  Returns: | include measure type
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IncludeMeasureType`

  Parameters: | hasIncludeMeasureType (bool) – include measure type

  New in version NX12.0.0.

  License requirements: None.

## IncludeUnit

`AxisLabelStyle.``IncludeUnit`

  Returns or sets the option specifies whether to include unit information in axis label

  `-------------------------------------`

  Getter Method

  Signature `IncludeUnit`

  Returns: | include unit
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IncludeUnit`

  Parameters: | hasIncludeUnit (bool) – include unit

  New in version NX12.0.0.

  License requirements: None.

## Owner

`AxisLabelStyle.``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.

## UseSingleLine

`AxisLabelStyle.``UseSingleLine`

  Returns or sets the option specifies whether to display axis label in a single line

  `-------------------------------------`

  Getter Method

  Signature `UseSingleLine`

  Returns: | sinle line
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `UseSingleLine`

  Parameters: | isSingleLine (bool) – sinle line

  New in version NX12.0.0.

  License requirements: None.

## Visibility

`AxisLabelStyle.``Visibility`

  Returns or sets the visibility

  `-------------------------------------`

  Getter Method

  Signature `Visibility`

  Returns: |
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Visibility`

  Parameters: | visibility (bool) –

  New in version NX12.0.0.

  License requirements: None.

# Method Detail

## CommitChange

`AxisLabelStyle.``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.