LeaderData Class

class NXOpen.Annotations.LeaderData

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Represents a NXOpen.Annotations.LeaderData.

This class is used to construct the definition for a single leader object.

To create a new instance of this class, use NXOpen.Annotations.AnnotationManager.CreateLeaderData()

New in version NX6.0.0.

Properties

Property	Description
Arrowhead	Returns or sets the arrowhead
DatumOnDotTerminatedArrowhead	Returns or sets the datum arrowhead type for the datum portion of a datum on dot terminated leader
DatumOnDotTerminatedEndPoint	Returns or sets the datum end point for the leader segment of the datum portion of a datum on dot terminated leadet
DatumOnDotTerminatedStartPoint	Returns or sets the datum start point for the leader segment of the datum portion of a datum on dot terminated leader
Jogs	Returns the jogs
Leader	Returns the leader
LeaderPerpendicular	Returns or sets the perpendicular relationship between the first segment and attachement object
Perpendicular	Returns or sets the perpendicular relationship between the first segment and stub
StubSide	Returns or sets the stub side
StubSize	Returns or sets the stub size
Tag	Returns the Tag for this object.
TerminatorType	Returns or sets the terminator type
VerticalAttachment	Returns or sets the vertical attachment

Methods

Method	Description
GetStubEndPoint	Returns the end point of the leader.
GetStubStartPoint	Returns the start point of the leader.
HasStub	Returns the stub status of the defined leader.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

LeaderDataArrowheadType Enumeration	the set of arrowhead types used to define a leader arrowhead
LeaderDataLeaderType Enumeration	the set of datatypes used to define the types of leaders that can be applied to an annotation

Property Detail

Arrowhead

LeaderData.Arrowhead

Returns or sets the arrowhead

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

Getter Method

Signature Arrowhead

Returns: Return type:NXOpen.Annotations.LeaderDataArrowheadType

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature Arrowhead

Parameters:arrowhead (NXOpen.Annotations.LeaderDataArrowheadType) –

New in version NX6.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

DatumOnDotTerminatedArrowhead

LeaderData.DatumOnDotTerminatedArrowhead

Returns or sets the datum arrowhead type for the datum portion of a datum on dot terminated leader

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

Getter Method

Signature DatumOnDotTerminatedArrowhead

Returns: Return type:NXOpen.Annotations.LeaderDataArrowheadType

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature DatumOnDotTerminatedArrowhead

Parameters:arrowhead (NXOpen.Annotations.LeaderDataArrowheadType) –

New in version NX9.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

DatumOnDotTerminatedEndPoint

LeaderData.DatumOnDotTerminatedEndPoint

Returns or sets the datum end point for the leader segment of the datum portion of a datum on dot terminated leadet

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

Getter Method

Signature DatumOnDotTerminatedEndPoint

Returns: Return type:NXOpen.Point3d

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature DatumOnDotTerminatedEndPoint

Parameters:endpoint (NXOpen.Point3d) –

New in version NX9.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

DatumOnDotTerminatedStartPoint

LeaderData.DatumOnDotTerminatedStartPoint

Returns or sets the datum start point for the leader segment of the datum portion of a datum on dot terminated leader

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

Getter Method

Signature DatumOnDotTerminatedStartPoint

Returns: Return type:NXOpen.Point3d

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature DatumOnDotTerminatedStartPoint

Parameters:startpoint (NXOpen.Point3d) –

New in version NX9.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

Jogs

LeaderData.Jogs

Returns the jogs

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

Getter Method

Signature Jogs

Returns: Return type:NXOpen.SelectDisplayableObjectList

New in version NX6.0.0.

License requirements: None.

Leader

LeaderData.Leader

Returns the leader

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

Getter Method

Signature Leader

Returns: Return type:NXOpen.SelectDisplayableObject

New in version NX6.0.0.

License requirements: None.

LeaderPerpendicular

LeaderData.LeaderPerpendicular

Returns or sets the perpendicular relationship between the first segment and attachement object

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

Getter Method

Signature LeaderPerpendicular

Returns: Return type:bool

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature LeaderPerpendicular

Parameters:isLeaderPerpendicular (bool) –

New in version NX10.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

Perpendicular

LeaderData.Perpendicular

Returns or sets the perpendicular relationship between the first segment and stub

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

Getter Method

Signature Perpendicular

Returns: Return type:bool

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature Perpendicular

Parameters:isPerpendicular (bool) –

New in version NX7.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

StubSide

LeaderData.StubSide

Returns or sets the stub side

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

Getter Method

Signature StubSide

Returns: Return type:NXOpen.Annotations.LeaderSide

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature StubSide

Parameters:stubSide (NXOpen.Annotations.LeaderSide) –

New in version NX6.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

StubSize

LeaderData.StubSize

Returns or sets the stub size

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

Getter Method

Signature StubSize

Returns: Return type:float

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature StubSize

Parameters:stubSize (float) –

New in version NX6.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

TerminatorType

LeaderData.TerminatorType

Returns or sets the terminator type

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

Getter Method

Signature TerminatorType

Returns: Return type:NXOpen.Annotations.LeaderDataLeaderType

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature TerminatorType

Parameters:terminatorType (NXOpen.Annotations.LeaderDataLeaderType) –

New in version NX6.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

VerticalAttachment

LeaderData.VerticalAttachment

Returns or sets the vertical attachment

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

Getter Method

Signature VerticalAttachment

Returns: Return type:NXOpen.Annotations.LeaderVerticalAttachment

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature VerticalAttachment

Parameters:verticalAttachment (NXOpen.Annotations.LeaderVerticalAttachment) –

New in version NX10.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

Method Detail

GetStubEndPoint

LeaderData.GetStubEndPoint

Returns the end point of the leader.

Signature GetStubEndPoint()

Returns: Return type:NXOpen.Point3d

New in version NX11.0.0.

License requirements: None.

GetStubStartPoint

LeaderData.GetStubStartPoint

Returns the start point of the leader.

Signature GetStubStartPoint()

Returns: Return type:NXOpen.Point3d

New in version NX11.0.0.

License requirements: None.

HasStub

LeaderData.HasStub

Returns the stub status of the defined leader.

Signature HasStub()

Returns: Return type:bool

New in version NX11.0.0.

License requirements: None.

Validate

LeaderData.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.