GridBuilder Class¶
-
class
NXOpen.Display.
GridBuilder
¶ Bases:
NXOpen.Builder
Represents the builder for adding a grid
NXOpen.Display.Grid
This is an abstract class, and cannot be instantiated.
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
LineColor | Returns or sets the line color |
MajorLineSpacing | Returns or sets the major line spacing |
MajorLineStyle | Returns or sets the major line style |
MajorLineWeight | Returns or sets the major line weight |
MinorLineStyle | Returns or sets the minor line style |
MinorLineWeight | Returns or sets the minor line weight |
MinorLinesPerMajor | Returns or sets the minor lines per major |
Show | Returns or sets the show |
ShowMajorLines | Returns or sets the show major lines |
ShowOnTop | Returns or sets the show on top |
SnapPointsPerMinor | Returns or sets the snap points per minor |
SnapToGrid | Returns or sets the snap to grid |
Tag | Returns the Tag for this object. |
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. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
InheritSettings | Inherits the settings from the specified grid. |
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¶
GridBuilderLineStyleType Enumeration | Specifies line style to be used for major and minor lines of the grid. |
GridBuilderLineWeightType Enumeration | Specifies line weight to be used for major and minor lines of the grid. |
Property Detail¶
LineColor¶
-
GridBuilder.
LineColor
¶ Returns or sets the line color
-------------------------------------
Getter Method
Signature
LineColor
Returns: Return type: Id New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LineColor
Parameters: lineColor (Id) – New in version NX6.0.0.
License requirements: None.
MajorLineSpacing¶
-
GridBuilder.
MajorLineSpacing
¶ Returns or sets the major line spacing
-------------------------------------
Getter Method
Signature
MajorLineSpacing
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MajorLineSpacing
Parameters: majorLineSpacing (float) – New in version NX6.0.0.
License requirements: None.
MajorLineStyle¶
-
GridBuilder.
MajorLineStyle
¶ Returns or sets the major line style
-------------------------------------
Getter Method
Signature
MajorLineStyle
Returns: Return type: NXOpen.Display.GridBuilderLineStyleType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MajorLineStyle
Parameters: majorLineStyle ( NXOpen.Display.GridBuilderLineStyleType
) –New in version NX6.0.0.
License requirements: None.
MajorLineWeight¶
-
GridBuilder.
MajorLineWeight
¶ Returns or sets the major line weight
-------------------------------------
Getter Method
Signature
MajorLineWeight
Returns: Return type: NXOpen.Display.GridBuilderLineWeightType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MajorLineWeight
Parameters: majorLineWeight ( NXOpen.Display.GridBuilderLineWeightType
) –New in version NX6.0.0.
License requirements: None.
MinorLineStyle¶
-
GridBuilder.
MinorLineStyle
¶ Returns or sets the minor line style
-------------------------------------
Getter Method
Signature
MinorLineStyle
Returns: Return type: NXOpen.Display.GridBuilderLineStyleType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MinorLineStyle
Parameters: minorLineStyle ( NXOpen.Display.GridBuilderLineStyleType
) –New in version NX6.0.0.
License requirements: None.
MinorLineWeight¶
-
GridBuilder.
MinorLineWeight
¶ Returns or sets the minor line weight
-------------------------------------
Getter Method
Signature
MinorLineWeight
Returns: Return type: NXOpen.Display.GridBuilderLineWeightType
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MinorLineWeight
Parameters: minorLineWeight ( NXOpen.Display.GridBuilderLineWeightType
) –New in version NX6.0.0.
License requirements: None.
MinorLinesPerMajor¶
-
GridBuilder.
MinorLinesPerMajor
¶ Returns or sets the minor lines per major
-------------------------------------
Getter Method
Signature
MinorLinesPerMajor
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MinorLinesPerMajor
Parameters: minorLinesPerMajor (int) – New in version NX6.0.0.
License requirements: None.
Show¶
-
GridBuilder.
Show
¶ Returns or sets the show
-------------------------------------
Getter Method
Signature
Show
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Show
Parameters: show (bool) – New in version NX6.0.0.
License requirements: None.
ShowMajorLines¶
-
GridBuilder.
ShowMajorLines
¶ Returns or sets the show major lines
-------------------------------------
Getter Method
Signature
ShowMajorLines
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowMajorLines
Parameters: showMajorLines (bool) – New in version NX6.0.0.
License requirements: None.
ShowOnTop¶
-
GridBuilder.
ShowOnTop
¶ Returns or sets the show on top
-------------------------------------
Getter Method
Signature
ShowOnTop
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowOnTop
Parameters: showOnTop (bool) – New in version NX6.0.0.
License requirements: None.
SnapPointsPerMinor¶
-
GridBuilder.
SnapPointsPerMinor
¶ Returns or sets the snap points per minor
-------------------------------------
Getter Method
Signature
SnapPointsPerMinor
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SnapPointsPerMinor
Parameters: snapPointsPerMinor (int) – New in version NX6.0.0.
License requirements: None.
SnapToGrid¶
-
GridBuilder.
SnapToGrid
¶ Returns or sets the snap to grid
-------------------------------------
Getter Method
Signature
SnapToGrid
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SnapToGrid
Parameters: snapToGrid (bool) – New in version NX6.0.0.
License requirements: None.
Method Detail¶
InheritSettings¶
-
GridBuilder.
InheritSettings
¶ Inherits the settings from the specified grid.
These includes settings such as
Display.GridBuilder.MajorLineSpacing`()
.Signature
InheritSettings(grid)
Parameters: grid ( NXOpen.Display.Grid
) – The grid. None is invalid.New in version NX6.0.0.
License requirements: None.
Validate¶
-
GridBuilder.
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.