GraphOptionsStyle2D Class — NXOpen Python API Reference 12.0.0 documentation

# GraphOptionsStyle2D Class

class `NXOpen.CAE.Xyplot.``GraphOptionsStyle2D`

  Bases: `NXOpen.CAE.Xyplot.BaseDisplayStyleSetting`

  Manages the specific settings for 2D graph.

  Not support KF.

  New in version NX12.0.0.

# Properties

Property | Description
--- | ---
FrequencyBandSummationBandType | Returns or sets a value specifies the frequency band summation band type
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object.
Owner | Returns the owner style
ShowFrequencyBandSummation | Returns or sets a value specifies whether to show frequency band summation
ShowTotalResponseLineForPolar | Returns or sets a value specifies whether to show total response line for 2D polar plot
ShowTotalResponseLineForVector | Returns or sets a value specifies whether to show total response line for 2D vector plot
Tag | Returns the Tag for this object.
TotalResponseLineSetting | Returns the total response line setting

# 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

## FrequencyBandSummationBandType

`GraphOptionsStyle2D.``FrequencyBandSummationBandType`

  Returns or sets a value specifies the frequency band summation band type

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

  Getter Method

  Signature `FrequencyBandSummationBandType`

  Returns: |
  Return type: | `NXOpen.CAE.Xyplot.FrequencyBandSummationBandType`

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `FrequencyBandSummationBandType`

  Parameters: | freqBandSummationBandType (`NXOpen.CAE.Xyplot.FrequencyBandSummationBandType`) –

  New in version NX12.0.0.

  License requirements: None.

## Owner

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

## ShowFrequencyBandSummation

`GraphOptionsStyle2D.``ShowFrequencyBandSummation`

  Returns or sets a value specifies whether to show frequency band summation

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

  Getter Method

  Signature `ShowFrequencyBandSummation`

  Returns: |
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ShowFrequencyBandSummation`

  Parameters: | showFreqBandSummation (bool) –

  New in version NX12.0.0.

  License requirements: None.

## ShowTotalResponseLineForPolar

`GraphOptionsStyle2D.``ShowTotalResponseLineForPolar`

  Returns or sets a value specifies whether to show total response line for 2D polar plot

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

  Getter Method

  Signature `ShowTotalResponseLineForPolar`

  Returns: |
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ShowTotalResponseLineForPolar`

  Parameters: | showTotalResponseLineForPolar (bool) –

  New in version NX12.0.0.

  License requirements: None.

## ShowTotalResponseLineForVector

`GraphOptionsStyle2D.``ShowTotalResponseLineForVector`

  Returns or sets a value specifies whether to show total response line for 2D vector plot

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

  Getter Method

  Signature `ShowTotalResponseLineForVector`

  Returns: |
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ShowTotalResponseLineForVector`

  Parameters: | showTotalResponseLineForVector (bool) –

  New in version NX12.0.0.

  License requirements: None.

## TotalResponseLineSetting

`GraphOptionsStyle2D.``TotalResponseLineSetting`

  Returns the total response line setting

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

  Getter Method

  Signature `TotalResponseLineSetting`

  Returns: |
  Return type: | `NXOpen.CAE.Xyplot.CurveDisplaySettings`

  New in version NX12.0.0.

  License requirements: None.

# Method Detail

## CommitChange

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