DiagramDisplayStyles Class — NXOpen Python API Reference 12.0.0 documentation

# DiagramDisplayStyles Class

class `NXOpen.CAE.Xyplot.``DiagramDisplayStyles`

  Bases: `NXOpen.CAE.Xyplot.BaseDisplayStyleSetting`

  Manages the diagram display styles.

  Not support KF.

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object.
Owner | Returns the owner style
StyleCount | Returns the style count
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.
GetBarStyleSetting | Gets the bar display style.
GetGraphStyle | Gets the graph style.
GetLineStyleSetting | Gets the line display style.
GetPlateStyleSetting | Gets the plate display style.
GetScatterStyleSetting | Gets the scatter display style.
GetSurfaceStyleSetting | Gets the surface display style.
GetVectorStyleSetting | Gets the vector display style.
SetGraphStyle | Sets the graph style.

# Property Detail

## Owner

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

## StyleCount

`DiagramDisplayStyles.``StyleCount`

  Returns the style count

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

  Getter Method

  Signature `StyleCount`

  Returns: | Style count
  Return type: | int

  New in version NX10.0.0.

  License requirements: None.

# Method Detail

## CommitChange

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

## GetBarStyleSetting

`DiagramDisplayStyles.``GetBarStyleSetting`

  Gets the bar display style.

  The style index must be greater than or equal to 0 and less than `CAE.Xyplot.DiagramDisplayStyles.StyleCount()`.

  Signature `GetBarStyleSetting(styleIndex)`

  Parameters: | styleIndex (int) – Style index
  Returns: | Bar style
  Return type: | `NXOpen.CAE.Xyplot.BaseBarStyleSetting`

  New in version NX10.0.0.

  License requirements: None.

## GetGraphStyle

`DiagramDisplayStyles.``GetGraphStyle`

  Gets the graph style.

  The style index must be greater than or equal to 0 and less than `CAE.Xyplot.DiagramDisplayStyles.StyleCount()`.

  Signature `GetGraphStyle(styleIndex)`

  Parameters: | styleIndex (int) – Style index
  Returns: | Graph style
  Return type: | `NXOpen.CAE.Xyplot.GraphStyle`

  New in version NX10.0.0.

  License requirements: None.

## GetLineStyleSetting

`DiagramDisplayStyles.``GetLineStyleSetting`

  Gets the line display style.

  The style index must be greater than or equal to 0 and less than `CAE.Xyplot.DiagramDisplayStyles.StyleCount()`.

  Signature `GetLineStyleSetting(styleIndex)`

  Parameters: | styleIndex (int) – Style index
  Returns: | Line style
  Return type: | `NXOpen.CAE.Xyplot.BaseLineStyleSetting`

  New in version NX10.0.0.

  License requirements: None.

## GetPlateStyleSetting

`DiagramDisplayStyles.``GetPlateStyleSetting`

  Gets the plate display style.

  The style index must be greater than or equal to 0 and less than `CAE.Xyplot.DiagramDisplayStyles.StyleCount()`.

  Signature `GetPlateStyleSetting(styleIndex)`

  Parameters: | styleIndex (int) – Style index
  Returns: | Plate style
  Return type: | `NXOpen.CAE.Xyplot.BasePlateStyleSetting`

  New in version NX10.0.0.

  Deprecated since version NX12.0.0: There is no replacement for this function

  License requirements: None.

## GetScatterStyleSetting

`DiagramDisplayStyles.``GetScatterStyleSetting`

  Gets the scatter display style.

  The style index must be greater than or equal to 0 and less than `CAE.Xyplot.DiagramDisplayStyles.StyleCount()`.

  Signature `GetScatterStyleSetting(styleIndex)`

  Parameters: | styleIndex (int) – Style index
  Returns: | Scatter style
  Return type: | `NXOpen.CAE.Xyplot.ScatterStyleSetting`

  New in version NX10.0.0.

  License requirements: None.

## GetSurfaceStyleSetting

`DiagramDisplayStyles.``GetSurfaceStyleSetting`

  Gets the surface display style.

  The style index must be greater than or equal to 0 and less than `CAE.Xyplot.DiagramDisplayStyles.StyleCount()`.

  Signature `GetSurfaceStyleSetting(styleIndex)`

  Parameters: | styleIndex (int) – Style index
  Returns: | Surface style
  Return type: | `NXOpen.CAE.Xyplot.SurfaceStyleSetting`

  New in version NX10.0.0.

  License requirements: None.

## GetVectorStyleSetting

`DiagramDisplayStyles.``GetVectorStyleSetting`

  Gets the vector display style.

  The style index must be greater than or equal to 0 and less than `CAE.Xyplot.DiagramDisplayStyles.StyleCount()`.

  Signature `GetVectorStyleSetting(styleIndex)`

  Parameters: | styleIndex (int) – Style index
  Returns: | Line style
  Return type: | `NXOpen.CAE.Xyplot.VectorStyle2DSetting`

  New in version NX12.0.0.

  License requirements: None.

## SetGraphStyle

`DiagramDisplayStyles.``SetGraphStyle`

  Sets the graph style.

  The style index must be greater than or equal to 0 and less than `CAE.Xyplot.DiagramDisplayStyles.StyleCount()`.

  Signature `SetGraphStyle(styleIndex, graphStyle)`

  Parameters:

  - styleIndex (int) – Style index
  - graphStyle (`NXOpen.CAE.Xyplot.GraphStyle`) – Graph style

  New in version NX10.0.0.

  License requirements: None.