SheetElementBuilder Class¶
-
class
NXOpen.Diagramming.
SheetElementBuilder
¶ Bases:
NXOpen.Diagramming.BaseObjectBuilder
Represents a SheetElementBuilder.
This is an abstract class and cannot be directly instantiated
New in version NX10.0.0.
Properties¶
Property | Description |
---|---|
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. |
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 |
---|---|
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. |
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. |
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. |
Enumerations¶
SheetElementBuilderResizeOptionType Enumeration | Represents the resize option for a NXOpen.Diagramming.SheetElementBuilder . |
Property Detail¶
Height¶
-
SheetElementBuilder.
Height
¶ Returns or sets the height.
-------------------------------------
Getter Method
Signature
Height()
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Height(height)
Parameters: height (float) – New in version NX10.0.0.
License requirements: None.
HeightPolicy¶
-
SheetElementBuilder.
HeightPolicy
¶ Returns or sets the height policy.
-------------------------------------
Getter Method
Signature
HeightPolicy()
Returns: Return type: NXOpen.Diagramming.DiagrammingSizingpolicy
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HeightPolicy(heightPolicy)
Parameters: heightPolicy ( NXOpen.Diagramming.DiagrammingSizingpolicy
) –New in version NX10.0.0.
License requirements: None.
Internal¶
-
SheetElementBuilder.
Internal
¶ Returns the flag that indicates if the sheet element is internal.
If false it is not part of the user’s data model; for example, an Annotation is not part of the user’s model of Nodes and Connections.
-------------------------------------
Getter Method
Signature
Internal()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
Label¶
-
SheetElementBuilder.
Label
¶ Returns the label of this sheet element.
-------------------------------------
Getter Method
Signature
Label()
Returns: Return type: NXOpen.Diagramming.Annotation
New in version NX10.0.0.
License requirements: None.
LabelName¶
-
SheetElementBuilder.
LabelName
¶ Returns or sets the label name of this sheet element.
-------------------------------------
Getter Method
Signature
LabelName()
Returns: Return type: str New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LabelName(labelname)
Parameters: labelname (str) – New in version NX10.0.0.
License requirements: None.
Location¶
-
SheetElementBuilder.
Location
¶ Returns the location of the sheet element relative to another sheet element.
-------------------------------------
Getter Method
Signature
Location()
Returns: Return type: NXOpen.Diagramming.LocationBuilder
New in version NX10.0.0.
License requirements: None.
LocationStyle¶
-
SheetElementBuilder.
LocationStyle
¶ Returns or sets the location style.
-------------------------------------
Getter Method
Signature
LocationStyle()
Returns: Return type: NXOpen.Diagramming.DiagrammingLocationstyle
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LocationStyle(locationStyle)
Parameters: locationStyle ( NXOpen.Diagramming.DiagrammingLocationstyle
) –New in version NX10.0.0.
License requirements: None.
MirrorX¶
-
SheetElementBuilder.
MirrorX
¶ Returns or sets the sheet element to Mirror along the X axis.
-------------------------------------
Getter Method
Signature
MirrorX()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MirrorX(mirrorX)
Parameters: mirrorX (bool) – New in version NX10.0.0.
License requirements: None.
MirrorY¶
-
SheetElementBuilder.
MirrorY
¶ Returns or sets the sheet element to Mirror along the Y axis.
-------------------------------------
Getter Method
Signature
MirrorY()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MirrorY(mirrorY)
Parameters: mirrorY (bool) – New in version NX10.0.0.
License requirements: None.
Owner¶
-
SheetElementBuilder.
Owner
¶ Returns or sets the owning sheet element.
-------------------------------------
Getter Method
Signature
Owner()
Returns: Return type: NXOpen.Diagramming.SheetElement
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Owner(owner)
Parameters: owner ( NXOpen.Diagramming.SheetElement
) –New in version NX10.0.0.
License requirements: None.
OwningSheet¶
-
SheetElementBuilder.
OwningSheet
¶ Returns the owning sheet.
-------------------------------------
Getter Method
Signature
OwningSheet()
Returns: Return type: NXOpen.Diagramming.Sheet
New in version NX10.0.0.
License requirements: None.
ResizeOption¶
-
SheetElementBuilder.
ResizeOption
¶ Returns or sets the resize option of the sheet element
-------------------------------------
Getter Method
Signature
ResizeOption()
Returns: Return type: NXOpen.Diagramming.SheetElementBuilderResizeOptionType
New in version NX11.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ResizeOption(resizeOption)
Parameters: resizeOption ( NXOpen.Diagramming.SheetElementBuilderResizeOptionType
) –New in version NX11.0.0.
License requirements: None.
Rotation¶
-
SheetElementBuilder.
Rotation
¶ Returns or sets the rotation angle that is counter clockwise and relative to the owner.
-------------------------------------
Getter Method
Signature
Rotation()
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Rotation(angle)
Parameters: angle (float) – New in version NX10.0.0.
License requirements: None.
SourceElement¶
-
SheetElementBuilder.
SourceElement
¶ Returns the source element that records which sheet element it is a copy of.
-------------------------------------
Getter Method
Signature
SourceElement()
Returns: Return type: NXOpen.Diagramming.SheetElement
New in version NX10.0.0.
License requirements: None.
UpToDate¶
-
SheetElementBuilder.
UpToDate
¶ Returns the flag that indicates if the sheet element is up to date.
-------------------------------------
Getter Method
Signature
UpToDate()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
Visible¶
-
SheetElementBuilder.
Visible
¶ Returns the flag that indicates if the sheet element is visible.
If true it is visible.
-------------------------------------
Getter Method
Signature
Visible()
Returns: Return type: bool New in version NX10.0.0.
License requirements: None.
Width¶
-
SheetElementBuilder.
Width
¶ Returns or sets the width.
-------------------------------------
Getter Method
Signature
Width()
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Width(width)
Parameters: width (float) – New in version NX10.0.0.
License requirements: None.
WidthPolicy¶
-
SheetElementBuilder.
WidthPolicy
¶ Returns or sets the width policy.
-------------------------------------
Getter Method
Signature
WidthPolicy()
Returns: Return type: NXOpen.Diagramming.DiagrammingSizingpolicy
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
WidthPolicy(widthPolicy)
Parameters: widthPolicy ( NXOpen.Diagramming.DiagrammingSizingpolicy
) –New in version NX10.0.0.
License requirements: None.
X¶
-
SheetElementBuilder.
X
¶ Returns or sets the absolute x coordinate.
-------------------------------------
Getter Method
Signature
X()
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
X(x)
Parameters: x (float) – New in version NX10.0.0.
License requirements: None.
Y¶
-
SheetElementBuilder.
Y
¶ Returns or sets the absolute y coordinate.
-------------------------------------
Getter Method
Signature
Y()
Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Y(y)
Parameters: y (float) – New in version NX10.0.0.
License requirements: None.
ZDepth¶
-
SheetElementBuilder.
ZDepth
¶ Returns or sets the Z depth.
Higher values of the Z depth indicates that the object is rendered on top of objects with a lower value.
-------------------------------------
Getter Method
Signature
ZDepth()
Returns: Return type: int New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ZDepth(zDepth)
Parameters: zDepth (int) – New in version NX10.0.0.
License requirements: None.
Method Detail¶
GetAllowedTransformations¶
-
SheetElementBuilder.
GetAllowedTransformations
¶ Get the allowed transformations of the sheet element.
Signature
GetAllowedTransformations()
Returns: a tuple Return type: A tuple consisting of (isAllowedTranslation, isAllowedRotation, isAllowedScale, isAllowedShear). isAllowedTranslation is a bool. isAllowedRotation is a bool. isAllowedScale is a bool. isAllowedShear is a bool. New in version NX10.0.0.
License requirements: None.
GetMinNodeSize¶
-
SheetElementBuilder.
GetMinNodeSize
¶ Gets the minimum node size values
Signature
GetMinNodeSize()
Returns: Minimum node size values as output Return type: list of float New in version NX11.0.0.
License requirements: None.
SetMinNodeSize¶
-
SheetElementBuilder.
SetMinNodeSize
¶ Sets the minimum node size values
Signature
SetMinNodeSize(sizeValues)
Parameters: sizeValues (list of float) – Minimum node size values as input New in version NX11.0.0.
License requirements: None.
SetOwningSheet¶
-
SheetElementBuilder.
SetOwningSheet
¶ Set the owning sheet when the sheet element is created.
It is not allowed to change the owning sheet when editing the sheet element.
Signature
SetOwningSheet(owningSheet)
Parameters: owningSheet ( NXOpen.Diagramming.Sheet
) –New in version NX10.0.0.
License requirements: None.
Validate¶
-
SheetElementBuilder.
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.