LeaderBundle Class¶
-
class
NXOpen.Annotations.LeaderBundle¶ Bases:
NXOpen.TransientObjectRepresents the data for all the leaders of an annotation
New in version NX3.0.0.
Properties¶
| Property | Description |
|---|---|
| LeaderAlignment | Returns or sets the leader alignment |
| LeaderSide | Returns or sets the leader side |
| LeaderType | Returns or sets the leader type |
| NumberOfLeaders | Returns or sets the number of leaders. |
Methods¶
| Method | Description |
|---|---|
| Dispose | Frees the object from memory. |
| SetLeaderData | Sets the leader data for the nth leader |
Property Detail¶
LeaderAlignment¶
-
LeaderBundle.LeaderAlignment¶ Returns or sets the leader alignment
-------------------------------------Getter Method
Signature
LeaderAlignment()Returns: Return type: NXOpen.Annotations.LeaderAlignmentNew in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LeaderAlignment(leaderAlignment)Parameters: leaderAlignment ( NXOpen.Annotations.LeaderAlignment) –New in version NX3.0.0.
License requirements: None.
LeaderSide¶
-
LeaderBundle.LeaderSide¶ Returns or sets the leader side
-------------------------------------Getter Method
Signature
LeaderSide()Returns: Return type: NXOpen.Annotations.LeaderSideNew in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LeaderSide(leaderSide)Parameters: leaderSide ( NXOpen.Annotations.LeaderSide) –New in version NX3.0.0.
License requirements: None.
LeaderType¶
-
LeaderBundle.LeaderType¶ Returns or sets the leader type
-------------------------------------Getter Method
Signature
LeaderType()Returns: Return type: NXOpen.Annotations.LeaderTypeNew in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LeaderType(leaderType)Parameters: leaderType ( NXOpen.Annotations.LeaderType) –New in version NX3.0.0.
License requirements: None.
NumberOfLeaders¶
-
LeaderBundle.NumberOfLeaders¶ Returns or sets the number of leaders.
Must not exceed
AnnotationsConstants.MaxLeaders. The only leader types that permit more than one leader are the following: Plain, Around, PlainAligned, and AroundAligned. PlainAligned and AroundAligned require at least one leader.-------------------------------------Getter Method
Signature
NumberOfLeaders()Returns: Return type: int New in version NX3.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
NumberOfLeaders(numLeaders)Parameters: numLeaders (int) – New in version NX3.0.0.
License requirements: None.
Method Detail¶
Dispose¶
-
LeaderBundle.Dispose¶ Frees the object from memory.
After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.
Signature
Dispose()New in version NX3.0.0.
License requirements: None.
SetLeaderData¶
-
LeaderBundle.SetLeaderData¶ Sets the leader data for the nth leader
Signature
SetLeaderData(n, attachmentType, attachmentObject, attachmentView, endPoint, angle, intermediatePoints)Parameters: - n (int) – The leader to set the data for
- attachmentType (
NXOpen.Annotations.LeaderAttachment) – - attachmentObject (
NXOpen.NXObject) – Attachment object. Should be None if the attachment type is Screen. Must not be None if the attachment type is OnObject. - attachmentView (
NXOpen.View) – The view that the leader will be associated with. Must not be None - endPoint (
NXOpen.Point3d) – The coordinates of the leader’s end point. If the attachment type is Screen, the coordinates will be view coordinates. If the attachment type is OnObject, the coordinates will be in the absolute coordinate system of the model that owns the attachment object - angle (float) –
- intermediatePoints (list of
NXOpen.Point3d) – Intermediate points for the leader. The number of points must not exceedAnnotationsConstants.MaxLeaderIntermediatePoints. The points are in the view coordinate system. The only leader types that permit intermediate points are the following: Plain, Around, PlainAligned, AroundAligned, DatumArrow, and GbDatumArrow.
New in version NX3.0.0.
License requirements: None.