OnPathDimension Class¶
-
class
NXOpen.BlockStyler.OnPathDimension¶ Bases:
NXOpen.BlockStyler.UIBlockRepresents a On Path Dimension block
New in version NX8.5.0.
Properties¶
| Property | Description |
|---|---|
| AdaptiveScaleLimits | Returns or sets the AdaptiveScaleLimits. |
| BalloonTooltipImage | Returns or sets the BalloonTooltipImage |
| BalloonTooltipLayoutAsString | Returns or sets the BalloonTooltipLayout as string |
| BalloonTooltipText | Returns or sets the BalloonTooltipText |
| Enable | Returns or sets the Enable. |
| Expanded | Returns or sets the Expanded |
| ExpressionObject | Returns or sets the ExpressionObject |
| Formula | Returns or sets the Formula |
| Group | Returns or sets the Group |
| Label | Returns or sets the Label |
| LineIncrement | Returns or sets the LineIncrement value. |
| LocationOptionAsString | Returns or sets the LocationOption as string |
| MaxInclusive | Returns or sets the MaxInclusive |
| MaximumValue | Returns or sets the MaximumValue |
| MinInclusive | Returns or sets the MinInclusive |
| MinimumValue | Returns or sets the MinimumValue |
| Name | Returns the name of the block or BlockID |
| OptionMask | Returns or sets the OptionMask |
| OptionMenuTitle | Returns or sets the OptionMenuTitle |
| PageIncrement | Returns or sets the PageIncrement value. |
| Path | Returns or sets the Path |
| Show | Returns or sets the Visibility of block. |
| ShowFocusHandle | Returns or sets the ShowFocusHandle |
| SnapPointTypesOnByDefault | Returns or sets the SnapPointTypesOnByDefault |
| Tag | Returns the Tag for this object. |
| Type | Returns the type of block |
| Units | Returns or sets the Units |
| Value | Returns or sets the Value. |
| WithScale | Returns or sets the WithScale. |
Methods¶
| Method | Description |
|---|---|
| Focus | Focuses on the block. |
| GetBalloonTooltipLayoutMembers | Gets the BalloonTooltipLayout members @return Values to get from the property. |
| GetLocationOptionMembers | Gets the LocationOption members @return Values to get from the property |
| GetProperties | Returns the properties of the block @return |
Property Detail¶
AdaptiveScaleLimits¶
-
OnPathDimension.AdaptiveScaleLimits¶ Returns or sets the AdaptiveScaleLimits.
If true, indicates that the scale should be adaptive.
-------------------------------------Getter Method
Signature
AdaptiveScaleLimits()Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AdaptiveScaleLimits(scaleLimits)Parameters: scaleLimits (bool) – New in version NX9.0.0.
License requirements: None.
BalloonTooltipImage¶
-
OnPathDimension.BalloonTooltipImage¶ Returns or sets the BalloonTooltipImage
-------------------------------------Getter Method
Signature
BalloonTooltipImage()Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BalloonTooltipImage(imageString)Parameters: imageString (str) – New in version NX8.5.0.
License requirements: None.
BalloonTooltipLayoutAsString¶
-
OnPathDimension.BalloonTooltipLayoutAsString¶ Returns or sets the BalloonTooltipLayout as string
-------------------------------------Getter Method
Signature
BalloonTooltipLayoutAsString()Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BalloonTooltipLayoutAsString(enumString)Parameters: enumString (str) – New in version NX8.5.0.
License requirements: None.
BalloonTooltipText¶
-
OnPathDimension.BalloonTooltipText¶ Returns or sets the BalloonTooltipText
-------------------------------------Getter Method
Signature
BalloonTooltipText()Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BalloonTooltipText(balloonTooltipText)Parameters: balloonTooltipText (str) – New in version NX8.5.0.
License requirements: None.
ExpressionObject¶
-
OnPathDimension.ExpressionObject¶ Returns or sets the ExpressionObject
-------------------------------------Getter Method
Signature
ExpressionObject()Returns: Return type: NXOpen.TaggedObjectNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ExpressionObject(expressionObj)Parameters: expressionObj ( NXOpen.TaggedObject) –New in version NX8.5.0.
License requirements: None.
Formula¶
-
OnPathDimension.Formula¶ Returns or sets the Formula
-------------------------------------Getter Method
Signature
Formula()Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Formula(formula)Parameters: formula (str) – New in version NX8.5.0.
License requirements: None.
LineIncrement¶
-
OnPathDimension.LineIncrement¶ Returns or sets the LineIncrement value.
Specifies the increment/decrement when the user presses the arrow keys on the keyboard. Only available when PresentationStyle is set to Scale or ScaleKeyin.
-------------------------------------Getter Method
Signature
LineIncrement()Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LineIncrement(lineIncrement)Parameters: lineIncrement (float) – New in version NX9.0.0.
License requirements: None.
LocationOptionAsString¶
-
OnPathDimension.LocationOptionAsString¶ Returns or sets the LocationOption as string
-------------------------------------Getter Method
Signature
LocationOptionAsString()Returns: Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
LocationOptionAsString(enumString)Parameters: enumString (str) – New in version NX8.5.0.
License requirements: None.
MaxInclusive¶
-
OnPathDimension.MaxInclusive¶ Returns or sets the MaxInclusive
-------------------------------------Getter Method
Signature
MaxInclusive()Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MaxInclusive(maxInclusive)Parameters: maxInclusive (bool) – New in version NX8.5.0.
License requirements: None.
MaximumValue¶
-
OnPathDimension.MaximumValue¶ Returns or sets the MaximumValue
-------------------------------------Getter Method
Signature
MaximumValue()Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MaximumValue(maxValue)Parameters: maxValue (float) – New in version NX8.5.0.
License requirements: None.
MinInclusive¶
-
OnPathDimension.MinInclusive¶ Returns or sets the MinInclusive
-------------------------------------Getter Method
Signature
MinInclusive()Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MinInclusive(minInclusive)Parameters: minInclusive (bool) – New in version NX8.5.0.
License requirements: None.
MinimumValue¶
-
OnPathDimension.MinimumValue¶ Returns or sets the MinimumValue
-------------------------------------Getter Method
Signature
MinimumValue()Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
MinimumValue(minValue)Parameters: minValue (float) – New in version NX8.5.0.
License requirements: None.
OptionMask¶
-
OnPathDimension.OptionMask¶ Returns or sets the OptionMask
-------------------------------------Getter Method
Signature
OptionMask()Returns: Return type: int New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
OptionMask(maskVal)Parameters: maskVal (int) – New in version NX8.5.0.
License requirements: None.
PageIncrement¶
-
OnPathDimension.PageIncrement¶ Returns or sets the PageIncrement value.
Specifies the increment/decrement when the user presses the Page Up or Page Down keys on the keyboard. Only available when PresentationStyle is set to Scale or ScaleKeyin.
-------------------------------------Getter Method
Signature
PageIncrement()Returns: Return type: float New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PageIncrement(pageIncrement)Parameters: pageIncrement (float) – New in version NX9.0.0.
License requirements: None.
Path¶
-
OnPathDimension.Path¶ Returns or sets the Path
-------------------------------------Getter Method
Signature
Path()Returns: Return type: NXOpen.TaggedObjectNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Path(path)Parameters: path ( NXOpen.TaggedObject) –New in version NX8.5.0.
License requirements: None.
ShowFocusHandle¶
-
OnPathDimension.ShowFocusHandle¶ Returns or sets the ShowFocusHandle
-------------------------------------Getter Method
Signature
ShowFocusHandle()Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ShowFocusHandle(showFocus)Parameters: showFocus (bool) – New in version NX8.5.0.
License requirements: None.
SnapPointTypesOnByDefault¶
-
OnPathDimension.SnapPointTypesOnByDefault¶ Returns or sets the SnapPointTypesOnByDefault
-------------------------------------Getter Method
Signature
SnapPointTypesOnByDefault()Returns: Return type: int New in version NX8.5.0.
Deprecated since version NX9.0.0: This call can be safely removed as this is now a no-op.
License requirements: None.
-------------------------------------Setter Method
Signature
SnapPointTypesOnByDefault(pointType)Parameters: pointType (int) – New in version NX8.5.0.
Deprecated since version NX9.0.0: This call can be safely removed as this is now a no-op.
License requirements: None.
Units¶
-
OnPathDimension.Units¶ Returns or sets the Units
-------------------------------------Getter Method
Signature
Units()Returns: Return type: NXOpen.TaggedObjectNew in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Units(units)Parameters: units ( NXOpen.TaggedObject) –New in version NX8.5.0.
License requirements: None.
Value¶
-
OnPathDimension.Value¶ Returns or sets the Value.
-------------------------------------Getter Method
Signature
Value()Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
Value(dimensionValue)Parameters: dimensionValue (float) – New in version NX8.5.0.
License requirements: None.
WithScale¶
-
OnPathDimension.WithScale¶ Returns or sets the WithScale.
If true,the slider bar is shown.
-------------------------------------Getter Method
Signature
WithScale()Returns: Return type: bool New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
WithScale(withScale)Parameters: withScale (bool) – New in version NX8.5.0.
License requirements: None.