RenderingPropertiesBuilder Class¶
-
class
NXOpen.Diagramming.RenderingPropertiesBuilder¶ Bases:
NXOpen.Diagramming.BaseSubObjectBuilderRepresents a RenderingPropertiesBuilder.
This is a sub-builder class and cannot be directly instantiated
New in version NX10.0.0.
Properties¶
| Property | Description |
|---|---|
| FillColor | Returns or sets the fill color. |
| FillOpacity | Returns or sets the fill opacity. |
| StrokeColor | Returns or sets the stroke color. |
| StrokeOpacity | Returns or sets the stroke opacity. |
| StrokeWidth | Returns or sets the stroke width. |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| GetDashArray | Get the lengths of dashes and gaps which compose the pattern of a dash line. |
| SetDashArray | Set the lengths of dashs and gaps which compose the pattern of a dash line. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
FillColor¶
-
RenderingPropertiesBuilder.FillColor¶ Returns or sets the fill color.
-------------------------------------Getter Method
Signature
FillColor()Returns: Return type: Id New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FillColor(colorId)Parameters: colorId (Id) – New in version NX10.0.0.
License requirements: None.
FillOpacity¶
-
RenderingPropertiesBuilder.FillOpacity¶ Returns or sets the fill opacity.
The range of opacity is from 0.0 to 1.0. 0.0 is completely transparent and 1.0 is completely opaque.
-------------------------------------Getter Method
Signature
FillOpacity()Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FillOpacity(opacity)Parameters: opacity (float) – New in version NX10.0.0.
License requirements: None.
StrokeColor¶
-
RenderingPropertiesBuilder.StrokeColor¶ Returns or sets the stroke color.
-------------------------------------Getter Method
Signature
StrokeColor()Returns: Return type: Id New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
StrokeColor(colorId)Parameters: colorId (Id) – New in version NX10.0.0.
License requirements: None.
StrokeOpacity¶
-
RenderingPropertiesBuilder.StrokeOpacity¶ Returns or sets the stroke opacity.
The range of opacity is from 0.0 to 1.0. 0.0 is completely transparent and 1.0 is completely opaque.
-------------------------------------Getter Method
Signature
StrokeOpacity()Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
StrokeOpacity(opacity)Parameters: opacity (float) – New in version NX10.0.0.
License requirements: None.
StrokeWidth¶
-
RenderingPropertiesBuilder.StrokeWidth¶ Returns or sets the stroke width.
It should be greater than 0.
-------------------------------------Getter Method
Signature
StrokeWidth()Returns: Return type: float New in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
StrokeWidth(width)Parameters: width (float) – New in version NX10.0.0.
License requirements: None.
Method Detail¶
GetDashArray¶
-
RenderingPropertiesBuilder.GetDashArray¶ Get the lengths of dashes and gaps which compose the pattern of a dash line.
The two output arrays have the same length.
Signature
GetDashArray()Returns: a tuple Return type: A tuple consisting of (dashArray, gapArray). dashArray is a list of int. gapArray is a list of int. New in version NX10.0.0.
License requirements: None.
SetDashArray¶
-
RenderingPropertiesBuilder.SetDashArray¶ Set the lengths of dashs and gaps which compose the pattern of a dash line.
The two input arrays should have the same length
Signature
SetDashArray(dashArray, gapArray)Parameters: - dashArray (list of int) –
- gapArray (list of int) –
New in version NX10.0.0.
License requirements: None.
Validate¶
-
RenderingPropertiesBuilder.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.