VectorStyle2DSetting Class

class NXOpen.CAE.Xyplot.VectorStyle2DSetting

Bases: NXOpen.CAE.Xyplot.BaseLineStyleSetting

Represents the 2D vector display style.

Not support KF.

New in version NX12.0.0.

Properties

Property	Description
Color	Returns or sets the line color
DrawText	Returns or sets a value indicating whether to draw annotation text
Font	Returns or sets the line font
IsAutoTextCount	Returns or sets a value indicating whether to customize annotation text count
JournalIdentifier	Returns the identifier that would be recorded in a journal for this object.
MaximumTextCount	Returns or sets the maximum of customized text count
OverlapTextAndVector	Returns or sets a value indicating whether to allow the annotation text overlap with vector
Owner	Returns the owner style
PointMarker	Returns or sets the point marker
Tag	Returns the Tag for this object.
Width	Returns or sets the line width

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.
GetNthVectorColor	Get the nth vector display color
GetVectorColors	Get the vector display colors
SetNthVectorColors	Set the nth vector display color
SetVectorColors	Set the vector display colors

Property Detail

DrawText

VectorStyle2DSetting.DrawText

Returns or sets a value indicating whether to draw annotation text

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

Getter Method

Signature DrawText

Returns: Return type:bool

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature DrawText

Parameters:canDrawText (bool) –

New in version NX12.0.0.

License requirements: None.

IsAutoTextCount

VectorStyle2DSetting.IsAutoTextCount

Returns or sets a value indicating whether to customize annotation text count

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

Getter Method

Signature IsAutoTextCount

Returns: Return type:bool

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature IsAutoTextCount

Parameters:isAutoTextCount (bool) –

New in version NX12.0.0.

License requirements: None.

MaximumTextCount

VectorStyle2DSetting.MaximumTextCount

Returns or sets the maximum of customized text count

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

Getter Method

Signature MaximumTextCount

Returns: Return type:int

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature MaximumTextCount

Parameters:maximumTextCount (int) –

New in version NX12.0.0.

License requirements: None.

OverlapTextAndVector

VectorStyle2DSetting.OverlapTextAndVector

Returns or sets a value indicating whether to allow the annotation text overlap with vector

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

Getter Method

Signature OverlapTextAndVector

Returns:Whether to allow the annotation text to overlap with vector Return type:bool

New in version NX12.0.0.

License requirements: None.

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

Setter Method

Signature OverlapTextAndVector

Parameters:overlapTextAndVector (bool) – Whether to allow the annotation text to overlap with vector

New in version NX12.0.0.

License requirements: None.

Owner

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

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

GetNthVectorColor

VectorStyle2DSetting.GetNthVectorColor

Get the nth vector display color

Signature GetNthVectorColor(index)

Parameters:index (int) – Returns:Get the nth display vector color Return type:Id

New in version NX12.0.0.

License requirements: None.

GetVectorColors

VectorStyle2DSetting.GetVectorColors

Get the vector display colors

Signature GetVectorColors()

Returns:Get the display vector colors Return type:list of Id

New in version NX12.0.0.

License requirements: None.

SetNthVectorColors

VectorStyle2DSetting.SetNthVectorColors

Set the nth vector display color

Signature SetNthVectorColors(index, vectorColors)

Parameters:

• index (int) –
• vectorColors (Id) – Set the nth display vector color

New in version NX12.0.0.

License requirements: None.

SetVectorColors

VectorStyle2DSetting.SetVectorColors

Set the vector display colors

Signature SetVectorColors(vectorColors)

Parameters:vectorColors (list of Id) – Set the display vector colors

New in version NX12.0.0.

License requirements: None.