LeaderLineBuilder Class

class NXOpen.Diagramming.LeaderLineBuilder

Bases: NXOpen.Diagramming.SheetElementBuilder

Represents a LeaderLineBuilder.

To create a new instance of this class, use NXOpen.Diagramming.LeaderLineCollection.CreateLeaderLineBuilder()

New in version NX10.0.0.

Properties

Property Description
ArrowType Returns or sets the arrow type of the end arrow
Height Returns or sets the height.
HeightPolicy Returns or sets the height policy.
Internal Returns the flag that indicates if the sheet element is internal.
Label Returns the label of this sheet element.
LabelName Returns or sets the label name of this sheet element.
Location Returns the location of the sheet element relative to another sheet element.
LocationStyle Returns or sets the location style.
MirrorX Returns or sets the sheet element to Mirror along the X axis.
MirrorY Returns or sets the sheet element to Mirror along the Y axis.
Owner Returns or sets the owning sheet element.
OwningSheet Returns the owning sheet.
ResizeOption Returns or sets the resize option of the sheet element
Rotation Returns or sets the rotation angle that is counter clockwise and relative to the owner.
SourceElement Returns the source element that records which sheet element it is a copy of.
StubLength Returns or sets the stub length of this leader line.
StubSides Returns or sets the stub sides of this leader line.
Tag Returns the Tag for this object.
UpToDate Returns the flag that indicates if the sheet element is up to date.
VerticalAlignment Returns or sets the vertical alignment option.
Visible Returns the flag that indicates if the sheet element is visible.
Width Returns or sets the width.
WidthPolicy Returns or sets the width policy.
NXOpen.Diagramming.SheetElementBuilder.X Returns or sets the absolute x coordinate.
NXOpen.Diagramming.SheetElementBuilder.Y Returns or sets the absolute y coordinate.
ZDepth Returns or sets the Z depth.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetAllowedTransformations Get the allowed transformations of the sheet element.
GetBendPoints Get bending points for polyline to render the leader line.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetMinNodeSize Gets the minimum node size values
GetObject Returns the object currently being edited by this builder.
GetTerminator Gets the terminator of the leader.
SetBendPoints Set bending points for polyline to render the leader line.
SetMinNodeSize Sets the minimum node size values
SetOwningSheet Set the owning sheet when the sheet element is created.
SetTerminator Sets the terminator of the leader.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

ArrowType

LeaderLineBuilder.ArrowType

Returns or sets the arrow type of the end arrow

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

Getter Method

Signature ArrowType

Returns:
Return type:NXOpen.Diagramming.DiagrammingArrowtype

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature ArrowType

Parameters:arrowTypeOption (NXOpen.Diagramming.DiagrammingArrowtype) –

New in version NX10.0.0.

License requirements: None.

StubLength

LeaderLineBuilder.StubLength

Returns or sets the stub length of this leader line.

The negative value is not expected.

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

Getter Method

Signature StubLength

Returns:
Return type:float

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature StubLength

Parameters:stubLength (float) –

New in version NX10.0.0.

License requirements: None.

StubSides

LeaderLineBuilder.StubSides

Returns or sets the stub sides of this leader line.

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

Getter Method

Signature StubSides

Returns:
Return type:NXOpen.Diagramming.DiagrammingStubsides

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature StubSides

Parameters:stubSides (NXOpen.Diagramming.DiagrammingStubsides) –

New in version NX10.0.0.

License requirements: None.

VerticalAlignment

LeaderLineBuilder.VerticalAlignment

Returns or sets the vertical alignment option.

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

Getter Method

Signature VerticalAlignment

Returns:
Return type:NXOpen.Diagramming.LeaderLineBuilderVerticalAlignmentOption

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature VerticalAlignment

Parameters:alignmentOption (NXOpen.Diagramming.LeaderLineBuilderVerticalAlignmentOption) –

New in version NX10.0.0.

License requirements: None.

Method Detail

GetBendPoints

LeaderLineBuilder.GetBendPoints

Get bending points for polyline to render the leader line.

Signature GetBendPoints()

Returns:
Return type:list of NXOpen.Point2d

New in version NX10.0.0.

License requirements: None.

GetTerminator

LeaderLineBuilder.GetTerminator

Gets the terminator of the leader.

Signature GetTerminator()

Returns:a tuple
Return type:A tuple consisting of (terminator, segmentId, percentX, inputX, percentY, inputY). terminator is a NXOpen.Diagramming.SheetElement. segmentId is a int. percentX is a float. inputX is a float. percentY is a float. inputY is a float.

New in version NX11.0.0.

License requirements: None.

SetBendPoints

LeaderLineBuilder.SetBendPoints

Set bending points for polyline to render the leader line.

Signature SetBendPoints(points)

Parameters:points (list of NXOpen.Point2d) –

New in version NX10.0.0.

License requirements: None.

SetTerminator

LeaderLineBuilder.SetTerminator

Sets the terminator of the leader.

Signature SetTerminator(terminator, segmentId, percentX, inputX, percentY, inputY)

Parameters:

New in version NX11.0.0.

License requirements: None.

Validate

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