OrdinateStyleBuilder Class¶
-
class
NXOpen.Annotations.
OrdinateStyleBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents a
NXOpen.Annotations.OrdinateStyleBuilder
.This class queries and sets ordinate specific preferences when creating or editing an ordinate set or ordinate dimension.
New in version NX6.0.0.
Properties¶
Property | Description |
---|---|
AlignSymbolWithBaseline | Returns or sets the align symbol with baseline preference |
DisplayDimensionLine | Returns or sets the display dimension line preference for an ordinate set |
DisplayNameStyle | Returns or sets the name display style for an ordinate set |
DoglegAngle | Returns or sets the dogleg angle. |
DoglegCreationOption | Returns or sets the dogleg creation option |
DoglegEndOffset | Returns or sets the dogleg end offset. |
DoglegSetting | Returns or sets the dogleg setting. |
DoglegStartOffset | Returns or sets the dogleg start offset. |
MarginFirstOffset | Returns or sets the distance from the baseline to the first margin. |
MarginSpacing | Returns or sets the interval distance between successive margins |
NumberOfMargins | Returns or sets the number of margins to create. |
OrdinateTextAngle | Returns or sets the ordinate text angle |
OrdinateTextOrientation | Returns or sets the ordinate text orientation |
PositiveDirection | Returns or sets the positive direction of measurement for an ordinate set |
SymbolAngle | Returns or sets the symbol angle in degress with respect to the baseline. |
SymbolAspectRatio | Returns or sets the symbol aspect ratio |
SymbolHeight | Returns or sets the symbol height |
SymbolLength | Returns or sets the symbol length |
SymbolScale | Returns or sets the symbol scale |
Tag | Returns the Tag for this object. |
UserDefinedText | Returns or sets the ordinate origin user defined text |
Methods¶
Method | Description |
---|---|
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
AlignSymbolWithBaseline¶
-
OrdinateStyleBuilder.
AlignSymbolWithBaseline
¶ Returns or sets the align symbol with baseline preference
-------------------------------------
Getter Method
Signature
AlignSymbolWithBaseline()
Returns: Return type: bool New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AlignSymbolWithBaseline(alignSymbolWithBaseline)
Parameters: alignSymbolWithBaseline (bool) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
DisplayDimensionLine¶
-
OrdinateStyleBuilder.
DisplayDimensionLine
¶ Returns or sets the display dimension line preference for an ordinate set
-------------------------------------
Getter Method
Signature
DisplayDimensionLine()
Returns: Return type: NXOpen.Annotations.OrdinateLineArrowDisplayOption
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DisplayDimensionLine(displayDimensionLine)
Parameters: displayDimensionLine ( NXOpen.Annotations.OrdinateLineArrowDisplayOption
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
DisplayNameStyle¶
-
OrdinateStyleBuilder.
DisplayNameStyle
¶ Returns or sets the name display style for an ordinate set
-------------------------------------
Getter Method
Signature
DisplayNameStyle()
Returns: Return type: NXOpen.Annotations.OrdinateOriginDisplayOption
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DisplayNameStyle(displayNameStyle)
Parameters: displayNameStyle ( NXOpen.Annotations.OrdinateOriginDisplayOption
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
DoglegAngle¶
-
OrdinateStyleBuilder.
DoglegAngle
¶ Returns or sets the dogleg angle.
The valid range is greater than zero and less than or equal to 90 degrees
-------------------------------------
Getter Method
Signature
DoglegAngle()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DoglegAngle(doglegAngle)
Parameters: doglegAngle (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
DoglegCreationOption¶
-
OrdinateStyleBuilder.
DoglegCreationOption
¶ Returns or sets the dogleg creation option
-------------------------------------
Getter Method
Signature
DoglegCreationOption()
Returns: Return type: NXOpen.Annotations.OrdinateDoglegCreationOption
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DoglegCreationOption(doglegCreationOption)
Parameters: doglegCreationOption ( NXOpen.Annotations.OrdinateDoglegCreationOption
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
DoglegEndOffset¶
-
OrdinateStyleBuilder.
DoglegEndOffset
¶ Returns or sets the dogleg end offset.
This is the offset between the dimension line and the end position of the dogleg. This value must be greater than or equal to zero and less than or equal to the start offset
-------------------------------------
Getter Method
Signature
DoglegEndOffset()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DoglegEndOffset(doglegEndOffset)
Parameters: doglegEndOffset (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
DoglegSetting¶
-
OrdinateStyleBuilder.
DoglegSetting
¶ Returns or sets the dogleg setting.
This specifies which options are used to specify the dogleg
-------------------------------------
Getter Method
Signature
DoglegSetting()
Returns: Return type: NXOpen.Annotations.OrdinateDoglegDefinition
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DoglegSetting(doglegSetting)
Parameters: doglegSetting ( NXOpen.Annotations.OrdinateDoglegDefinition
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
DoglegStartOffset¶
-
OrdinateStyleBuilder.
DoglegStartOffset
¶ Returns or sets the dogleg start offset.
This is the offset between the dimension line and the start position of the dogleg. The value must be greater than or equal to zero
-------------------------------------
Getter Method
Signature
DoglegStartOffset()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DoglegStartOffset(doglegStartOffset)
Parameters: doglegStartOffset (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
MarginFirstOffset¶
-
OrdinateStyleBuilder.
MarginFirstOffset
¶ Returns or sets the distance from the baseline to the first margin.
This can be a positive or negative number. The positive direction is away from the view’s center
-------------------------------------
Getter Method
Signature
MarginFirstOffset()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MarginFirstOffset(marginFirstOffset)
Parameters: marginFirstOffset (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
MarginSpacing¶
-
OrdinateStyleBuilder.
MarginSpacing
¶ Returns or sets the interval distance between successive margins
-------------------------------------
Getter Method
Signature
MarginSpacing()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MarginSpacing(marginSpacing)
Parameters: marginSpacing (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
NumberOfMargins¶
-
OrdinateStyleBuilder.
NumberOfMargins
¶ Returns or sets the number of margins to create.
The maximum is 32
-------------------------------------
Getter Method
Signature
NumberOfMargins()
Returns: Return type: int New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NumberOfMargins(numberOfMargins)
Parameters: numberOfMargins (int) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
OrdinateTextAngle¶
-
OrdinateStyleBuilder.
OrdinateTextAngle
¶ Returns or sets the ordinate text angle
-------------------------------------
Getter Method
Signature
OrdinateTextAngle()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OrdinateTextAngle(ordinateTextAngle)
Parameters: ordinateTextAngle (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
OrdinateTextOrientation¶
-
OrdinateStyleBuilder.
OrdinateTextOrientation
¶ Returns or sets the ordinate text orientation
-------------------------------------
Getter Method
Signature
OrdinateTextOrientation()
Returns: Return type: NXOpen.Annotations.TextOrientation
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OrdinateTextOrientation(ordinateTextOrientation)
Parameters: ordinateTextOrientation ( NXOpen.Annotations.TextOrientation
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
PositiveDirection¶
-
OrdinateStyleBuilder.
PositiveDirection
¶ Returns or sets the positive direction of measurement for an ordinate set
-------------------------------------
Getter Method
Signature
PositiveDirection()
Returns: Return type: NXOpen.Annotations.OrdinatePositiveDirection
New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PositiveDirection(positiveDirection)
Parameters: positiveDirection ( NXOpen.Annotations.OrdinatePositiveDirection
) –New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
SymbolAngle¶
-
OrdinateStyleBuilder.
SymbolAngle
¶ Returns or sets the symbol angle in degress with respect to the baseline.
This option only applies if the name display style is User-Defined and the the value of the Align Symbol with Baseline preference is false
-------------------------------------
Getter Method
Signature
SymbolAngle()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SymbolAngle(symbolAngle)
Parameters: symbolAngle (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
SymbolAspectRatio¶
-
OrdinateStyleBuilder.
SymbolAspectRatio
¶ Returns or sets the symbol aspect ratio
-------------------------------------
Getter Method
Signature
SymbolAspectRatio()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SymbolAspectRatio(symbolAspectRatio)
Parameters: symbolAspectRatio (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
SymbolHeight¶
-
OrdinateStyleBuilder.
SymbolHeight
¶ Returns or sets the symbol height
-------------------------------------
Getter Method
Signature
SymbolHeight()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SymbolHeight(symbolHeight)
Parameters: symbolHeight (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
SymbolLength¶
-
OrdinateStyleBuilder.
SymbolLength
¶ Returns or sets the symbol length
-------------------------------------
Getter Method
Signature
SymbolLength()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SymbolLength(symbolLength)
Parameters: symbolLength (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
SymbolScale¶
-
OrdinateStyleBuilder.
SymbolScale
¶ Returns or sets the symbol scale
-------------------------------------
Getter Method
Signature
SymbolScale()
Returns: Return type: float New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SymbolScale(symbolScale)
Parameters: symbolScale (float) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
UserDefinedText¶
-
OrdinateStyleBuilder.
UserDefinedText
¶ Returns or sets the ordinate origin user defined text
-------------------------------------
Getter Method
Signature
UserDefinedText()
Returns: Return type: str New in version NX6.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UserDefinedText(userDefinedText)
Parameters: userDefinedText (str) – New in version NX6.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
Method Detail¶
Validate¶
-
OrdinateStyleBuilder.
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.