LegendTableStyle Class — NXOpen Python API Reference 12.0.0 documentation

# LegendTableStyle Class

class `NXOpen.CAE.Xyplot.``LegendTableStyle`

  Bases: `NXOpen.CAE.Xyplot.BaseDisplayStyleSetting`

  Manages the legend table styles.

  Not support KF.

  New in version NX12.0.0.

# Properties

Property | Description
--- | ---
BackgroundColor | Returns or sets the legend table header background color
GridBackgroundColor | Returns or sets the grid background color
IsBorderLineVisible | Returns or sets the border line visibility
IsGridBackgroundFilled | Returns or sets the value of controlling whether the grid background is filled
IsGridLineVisible | Returns or sets the grid line visibility
IsHeaderVisible | Returns or sets the legend table header visibility
JournalIdentifier | Returns the identifier that would be recorded in a journal for this object.
MaximumLegendItemCount | Returns or sets the maximum displayable functions count on legend table page
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.
GetBorderLineStyle | Gets the border line style.
GetColumnTitles | Gets the legend table column titles
GetGridLineStyle | Gets the grid line style.
GetPositionType | Gets the legend table style type
GetTextStyle | Gets the text style.
SetColumnTitles | Sets the legend table column titles

# Property Detail

## BackgroundColor

`LegendTableStyle.``BackgroundColor`

  Returns or sets the legend table header background color

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

  Getter Method

  Signature `BackgroundColor`

  Returns: |
  Return type: | Id

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `BackgroundColor`

  Parameters: | backgroundColor (Id) –

  New in version NX12.0.0.

  License requirements: None.

## GridBackgroundColor

`LegendTableStyle.``GridBackgroundColor`

  Returns or sets the grid background color

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

  Getter Method

  Signature `GridBackgroundColor`

  Returns: |
  Return type: | Id

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `GridBackgroundColor`

  Parameters: | gridBackgroundColor (Id) –

  New in version NX12.0.0.

  License requirements: None.

## IsBorderLineVisible

`LegendTableStyle.``IsBorderLineVisible`

  Returns or sets the border line visibility

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

  Getter Method

  Signature `IsBorderLineVisible`

  Returns: |
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IsBorderLineVisible`

  Parameters: | isBorderLineVisible (bool) –

  New in version NX12.0.0.

  License requirements: None.

## IsGridBackgroundFilled

`LegendTableStyle.``IsGridBackgroundFilled`

  Returns or sets the value of controlling whether the grid background is filled

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

  Getter Method

  Signature `IsGridBackgroundFilled`

  Returns: |
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IsGridBackgroundFilled`

  Parameters: | isGridBackgroundFilled (bool) –

  New in version NX12.0.0.

  License requirements: None.

## IsGridLineVisible

`LegendTableStyle.``IsGridLineVisible`

  Returns or sets the grid line visibility

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

  Getter Method

  Signature `IsGridLineVisible`

  Returns: |
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IsGridLineVisible`

  Parameters: | isGridLineVisible (bool) –

  New in version NX12.0.0.

  License requirements: None.

## IsHeaderVisible

`LegendTableStyle.``IsHeaderVisible`

  Returns or sets the legend table header visibility

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

  Getter Method

  Signature `IsHeaderVisible`

  Returns: |
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `IsHeaderVisible`

  Parameters: | isHeaderVisible (bool) –

  New in version NX12.0.0.

  License requirements: None.

## MaximumLegendItemCount

`LegendTableStyle.``MaximumLegendItemCount`

  Returns or sets the maximum displayable functions count on legend table page

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

  Getter Method

  Signature `MaximumLegendItemCount`

  Returns: |
  Return type: | int

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `MaximumLegendItemCount`

  Parameters: | maxLegendItemCount (int) –

  New in version NX12.0.0.

  License requirements: None.

## Owner

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

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

## GetBorderLineStyle

`LegendTableStyle.``GetBorderLineStyle`

  Gets the border line style.

  Signature `GetBorderLineStyle()`

  Returns: | Border Line style
  Return type: | `NXOpen.CAE.Xyplot.CurveDisplaySettings`

  New in version NX12.0.0.

  License requirements: None.

## GetColumnTitles

`LegendTableStyle.``GetColumnTitles`

  Gets the legend table column titles

  Signature `GetColumnTitles()`

  Returns: | column titles
  Return type: | list of str

  New in version NX12.0.0.

  License requirements: None.

## GetGridLineStyle

`LegendTableStyle.``GetGridLineStyle`

  Gets the grid line style.

  Signature `GetGridLineStyle()`

  Returns: | Grid Line style
  Return type: | `NXOpen.CAE.Xyplot.CurveDisplaySettings`

  New in version NX12.0.0.

  License requirements: None.

## GetPositionType

`LegendTableStyle.``GetPositionType`

  Gets the legend table style type

  Signature `GetPositionType()`

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

  New in version NX12.0.0.

  License requirements: None.

## GetTextStyle

`LegendTableStyle.``GetTextStyle`

  Gets the text style.

  Signature `GetTextStyle()`

  Returns: | Text display style
  Return type: | `NXOpen.CAE.Xyplot.LegendTableTextStyle`

  New in version NX12.0.0.

  License requirements: None.

## SetColumnTitles

`LegendTableStyle.``SetColumnTitles`

  Sets the legend table column titles

  Signature `SetColumnTitles(columnTitles)`

  Parameters: | columnTitles (list of str) – column titles

  New in version NX12.0.0.

  License requirements: None.