NodeBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# NodeBuilder Class

class `NXOpen.Diagramming.``NodeBuilder`

  Bases: `NXOpen.Diagramming.ConnectableElementBuilder`

  Represents a NodeBuilder.

  To create a new instance of this class, use `NXOpen.Diagramming.NodeCollection.CreateNodeBuilder()`

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
Expanded | Returns or sets the node state of expanded or collapsed.
Fullfillment | Returns the flag that indicates if the node is a fulfillment object.
GroupingAllowed | Returns or sets the flag that indicates if the node is allowed to be a nested node and contain other child sheet elements.
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.
OffsheetReference | Returns or sets the referenced offsheet node.
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.
Tag | Returns the Tag for this object.
UpToDate | Returns the flag that indicates if the sheet element is up to date.
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
--- | ---
AddGroupMember | Adds a node to this node group.
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetAllPorts | Gets all ports of this connectable element.
GetAllowedTransformations | Get the allowed transformations of the sheet element.
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.
GetPorts | Gets ports of this connectable element by the direction.
RemoveAllGroupMembers | Remove all members.
RemoveGroupMember | Removes a node from this node group.
SetMinNodeSize | Sets the minimum node size values
SetOwningSheet | Set the owning sheet when the sheet element is created.
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

## Expanded

`NodeBuilder.``Expanded`

  Returns or sets the node state of expanded or collapsed.

  If true the node is expanded.

  `-------------------------------------`

  Getter Method

  Signature `Expanded`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Expanded`

  Parameters: | expanded (bool) –

  New in version NX10.0.0.

  License requirements: None.

## Fullfillment

`NodeBuilder.``Fullfillment`

  Returns the flag that indicates if the node is a fulfillment object.

  If true the node represents a physical object such as a piece of equipment from a library.

  `-------------------------------------`

  Getter Method

  Signature `Fullfillment`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

## GroupingAllowed

`NodeBuilder.``GroupingAllowed`

  Returns or sets the flag that indicates if the node is allowed to be a nested node and contain other child sheet elements.

  `-------------------------------------`

  Getter Method

  Signature `GroupingAllowed`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `GroupingAllowed`

  Parameters: | isGroupingAllowed (bool) –

  New in version NX10.0.0.

  License requirements: None.

## OffsheetReference

`NodeBuilder.``OffsheetReference`

  Returns or sets the referenced offsheet node.

  It could be elsewhere on the same sheet or on a different sheet and it can be None.

  `-------------------------------------`

  Getter Method

  Signature `OffsheetReference`

  Returns: |
  Return type: | `NXOpen.Diagramming.Node`

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `OffsheetReference`

  Parameters: | offsheetReference (`NXOpen.Diagramming.Node`) –

  New in version NX10.0.0.

  License requirements: None.

# Method Detail

## AddGroupMember

`NodeBuilder.``AddGroupMember`

  Adds a node to this node group.

  Signature `AddGroupMember(member)`

  Parameters: | member (`NXOpen.Diagramming.SheetElement`) –

  New in version NX10.0.0.

  License requirements: None.

## RemoveAllGroupMembers

`NodeBuilder.``RemoveAllGroupMembers`

  Remove all members.

  Signature `RemoveAllGroupMembers()`

  New in version NX10.0.0.

  License requirements: None.

## RemoveGroupMember

`NodeBuilder.``RemoveGroupMember`

  Removes a node from this node group.

  Signature `RemoveGroupMember(member)`

  Parameters: | member (`NXOpen.Diagramming.SheetElement`) –

  New in version NX10.0.0.

  License requirements: None.

## Validate

`NodeBuilder.``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.