LegendTableTextStyle Class

class NXOpen.CAE.Xyplot.LegendTableTextStyle

Bases: NXOpen.CAE.Xyplot.TextStyleSetting

Manages the legend table text styles.

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.
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
UseGlobalFontSetting Returns or sets a value indicating whether to use the global setting of text font, font style and font size.
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.
GetMargin Gets the margin value of legend table
SetMargin Sets the margin value of legend table

Property Detail

Owner

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

Visibility

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

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

GetMargin

LegendTableTextStyle.GetMargin

Gets the margin value of legend table

Signature GetMargin(marginOption)

Parameters:marginOption (NXOpen.CAE.Xyplot.TextBoxMarginOption) – margin option
Returns:
Return type:float

New in version NX12.0.0.

License requirements: None.

SetMargin

LegendTableTextStyle.SetMargin

Sets the margin value of legend table

Signature SetMargin(marginOption, marginValue)

Parameters:

New in version NX12.0.0.

License requirements: None.