ColorScaleStyle Class — NXOpen Python API Reference 12.0.0 documentation

# ColorScaleStyle Class

class `NXOpen.CAE.Xyplot.``ColorScaleStyle`

  Bases: `NXOpen.CAE.Xyplot.BaseDisplayStyleSetting`

  Represents the color scale display style.

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

  Not support KF.

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
AutoLevel | Returns or sets the option indicates whether to define color level automatically
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object.
Level | Returns or sets the level setting
Owner | Returns the owner style
Tag | Returns the Tag for this object.

# 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.

# Property Detail

## AutoLevel

`ColorScaleStyle.``AutoLevel`

  Returns or sets the option indicates whether to define color level automatically

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

  Getter Method

  Signature `AutoLevel`

  Returns: | Auto level setting
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AutoLevel`

  Parameters: | useAutoLevel (bool) – Auto Level setting

  New in version NX12.0.0.

  License requirements: None.

## Level

`ColorScaleStyle.``Level`

  Returns or sets the level setting

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

  Getter Method

  Signature `Level`

  Returns: | level setting
  Return type: | int

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Level`

  Parameters: | level (int) – Level setting

  New in version NX11.0.0.

  License requirements: None.

## Owner

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

# Method Detail

## CommitChange

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