TextStyleSetting Class

class NXOpen.CAE.Xyplot.TextStyleSetting

Bases: NXOpen.TaggedObject, NXOpen.CAE.Xyplot.IDisplayStyle

Represents the text display style.

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

Not support KF.

New in version NX9.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.
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.
Weight	Returns or sets the text weight.

Methods

Method	Description
CommitChange	Commits any edits that have been applied to the display style.

Property Detail

Alignment

TextStyleSetting.Alignment

Returns or sets the text alignment.

Only valid for title options, legend options and axis label options.

-------------------------------------

Getter Method

Signature Alignment()

Returns: Return type:NXOpen.CAE.Xyplot.TextAlignment

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Alignment(alignment)

Parameters:alignment (NXOpen.CAE.Xyplot.TextAlignment) –

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

Color

TextStyleSetting.Color

Returns or sets the text color

-------------------------------------

Getter Method

Signature Color()

Returns: Return type:Id

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Color(color)

Parameters:color (Id) –

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

Font

TextStyleSetting.Font

Returns or sets the text font

-------------------------------------

Getter Method

Signature Font()

Returns: Return type:str

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Font(font)

Parameters:font (str) –

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

FontStyle

TextStyleSetting.FontStyle

Returns or sets the text font style.

Available when the text font is standard font.

-------------------------------------

Getter Method

Signature FontStyle()

Returns: Return type:NXOpen.Preferences.VisualizationFontsStyleType

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FontStyle(fontStyle)

Parameters:fontStyle (NXOpen.Preferences.VisualizationFontsStyleType) –

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

FontType

TextStyleSetting.FontType

Returns or sets the text font type

-------------------------------------

Getter Method

Signature FontType()

Returns: Return type:NXOpen.CAE.Xyplot.Fonttype

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FontType(fontType)

Parameters:fontType (NXOpen.CAE.Xyplot.Fonttype) –

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

GlobalSizeScale

TextStyleSetting.GlobalSizeScale

Returns or sets the scale of global text size.

It will be taken only when CAE.Xyplot.TextStyleSetting.UseGlobalFontSetting`() is true, and CAE.Xyplot.TextStyleSetting.IsGlobalSizeAutoScaled`() is false.

-------------------------------------

Getter Method

Signature GlobalSizeScale()

Returns: Return type:float

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature GlobalSizeScale(sizeScale)

Parameters:sizeScale (float) –

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

IsGlobalSizeAutoScaled

TextStyleSetting.IsGlobalSizeAutoScaled

Returns or sets a value indicating whether to automatically adjust the scale of global text size to fit the screen.

It will be taken only when CAE.Xyplot.TextStyleSetting.UseGlobalFontSetting`() is true.

-------------------------------------

Getter Method

Signature IsGlobalSizeAutoScaled()

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature IsGlobalSizeAutoScaled(isGlobalSizeAutoScaled)

Parameters:isGlobalSizeAutoScaled (bool) –

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

Orientation

TextStyleSetting.Orientation

Returns or sets the text orientation.

Only invalid for legend options.

-------------------------------------

Getter Method

Signature Orientation()

Returns: Return type:NXOpen.CAE.Xyplot.TextOrientation

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Orientation(orientation)

Parameters:orientation (NXOpen.CAE.Xyplot.TextOrientation) –

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

Owner

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

Size

TextStyleSetting.Size

Returns or sets the text size.

The acceptable range is 1-10.

-------------------------------------

Getter Method

Signature Size()

Returns: Return type:int

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Size(size)

Parameters:size (int) –

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

TextBoxStyle

TextStyleSetting.TextBoxStyle

Returns the style of text box

-------------------------------------

Getter Method

Signature TextBoxStyle()

Returns: Return type:NXOpen.CAE.Xyplot.TextBoxStyleSetting

New in version NX9.0.0.

License requirements: None.

UseGlobalFontSetting

TextStyleSetting.UseGlobalFontSetting

Returns or sets a value indicating whether to use the global setting of text font, font style and font size.

If True, you need to set text size scale by setting CAE.Xyplot.TextStyleSetting.IsGlobalSizeAutoScaled`() or CAE.Xyplot.TextStyleSetting.GlobalSizeScale`()

-------------------------------------

Getter Method

Signature UseGlobalFontSetting()

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature UseGlobalFontSetting(useGlobalFontSetting)

Parameters:useGlobalFontSetting (bool) –

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

Weight

TextStyleSetting.Weight

Returns or sets the text weight.

Available when the text font is NX font.

-------------------------------------

Getter Method

Signature Weight()

Returns: Return type:NXOpen.Display.TransientTextTextSize

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Weight(weight)

Parameters:weight (NXOpen.Display.TransientTextTextSize) –

New in version NX9.0.0.

License requirements: nx_ftk (“NX Advanced Graphing”)

Method Detail

CommitChange

TextStyleSetting.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: nx_ftk (“NX Advanced Graphing”)