PrimaryVar¶
-
DisplayPropertiesBuilder.PrimaryVar¶ Returns the primary var name
-------------------------------------Getter Method
Signature
PrimaryVarReturns: Return type: NXOpen.ExpressionNew in version NX12.0.0.
License requirements: None.
NXOpen.Fields.DisplayPropertiesBuilder¶Bases: NXOpen.Builder
Represents a builder class for editing display properties of a NXOpen.Fields.Field
Used to edit a NXOpen.Fields.Field display properties.
To create a new instance of this class, use NXOpen.Fields.FieldManager.CreateDisplayPropertiesBuilder()
Default values.
| Property | Value |
|---|---|
| DepCalcSymblSize | 0.1 |
| DepDispType | Symbol |
| DepDomColor | Inherit |
| DepLabelValues | None |
| DepRangeMax | 0 |
| DepRangeMin | 0 |
| DisplayResolution | Standard |
| FaceAnalysis | 0 |
| FieldQuantity | Type0 |
| IndepDispType | Hide |
| Layer | 1 |
| LegendPosition | Left |
| LineFont | Solid |
| LineWidth | Normal |
| PartiallyShaded | 0 |
| PrimaryVar.Value | 0 (millimeters part), 0 (inches part) |
| Range | Auto |
| RangeMax | 1 |
| RangeMin | 1 |
| ShowAxis | 0 |
| ShowDefaultVal | 0 |
| ShowDescription | 0 |
| ShowLabels | 0 |
| ShowMapTopo | 0 |
| ShowName | 0 |
| ShowOverflowValues | 0 |
| ShowSrcTblVals | 1 |
| ShowUndefValues | 0 |
| ShowUnderflowValues | 0 |
| SpectrumLevels | 3 |
| SurfaceOffset | 0 |
| TblDepPtType (deprecated) | Hide |
| TblIndepPtType (deprecated) | Hide |
| Translucency | 0 |
| XMax.Value | 0 (millimeters part), 1 (inches part) |
| XMin.Value | 0 (millimeters part), 0 (inches part) |
| XNum | 1 |
| YMax.Value | 0 (millimeters part), 1 (inches part) |
| YMin.Value | 0 (millimeters part), 0 (inches part) |
| YNum | 1 |
| ZMax.Value | 0 (millimeters part), 1 (inches part) |
| ZMin.Value | 0 (millimeters part), 0 (inches part) |
| ZNum | 1 |
New in version NX6.0.1.
| Property | Description |
|---|---|
| AxisColor | Returns or sets the axis color |
| BasicColor | Returns or sets the basic color |
| DepCalcSymblSize | Returns or sets the dep calc symbl size |
| DepDispType | Returns or sets the dep disp type |
| DepDomColor | Returns or sets the dep dom color |
| DepLabelValues | Returns or sets the dep label values |
| DepRangeMax | Returns or sets the dep range max |
| DepRangeMin | Returns or sets the dependent range min |
| DepSelColor | Returns or sets the dep sel color |
| DepSymbolSize | Returns or sets the dep symbol size |
| DisplayResolution | Returns or sets the display resolution |
| DummyScale | Returns or sets the dummy scale |
| FaceAnalysis | Returns or sets the face analysis |
| FieldQuantity | Returns or sets the field quantity type |
| IndepDispType | Returns or sets the indep disp type |
| LabelColor | Returns or sets the label color |
| Layer | Returns or sets the layer |
| LegendPosition | Returns or sets the legend position |
| LineFont | Returns or sets the line font |
| LineWidth | Returns or sets the line width |
| OverflowColor | Returns or sets the overflow color |
| PartiallyShaded | Returns or sets the partially shaded |
| PrimaryVar | Returns the primary var name |
| Range | Returns or sets the range |
| RangeMax | Returns or sets the legend range max |
| RangeMin | Returns or sets the legend range min |
| ShowAxis | Returns or sets the show axis |
| ShowDefaultVal | Returns or sets the show default val |
| ShowDescription | Returns or sets the show description |
| ShowLabels | Returns or sets the show labels |
| ShowMapTopo | Returns or sets the show map topo |
| ShowName | Returns or sets the show name |
| ShowOverflowValues | Returns or sets the show overflow |
| ShowSrcTblVals | Returns or sets the show dep src tbl vals |
| ShowUndefValues | Returns or sets the show new undefined values |
| ShowUndefinedValues | Returns or sets the show undefined values |
| ShowUnderflowValues | Returns or sets the show underflow |
| SpectrumLevels | Returns or sets the spectrum levels |
| SurfaceOffset | Returns or sets the surface offset |
| Tag | Returns the Tag for this object. |
| TblDepColor | Returns or sets the table dependent color |
| TblDepDomColor | Returns or sets the table dependent domain color |
| TblDepLabelValues | Returns or sets the table dependent label values |
| TblDepPtType | Returns or sets the tbl dep pt type |
| TblDepSymbolSize | Returns or sets the table dependent symbol size |
| TblIndepColor | Returns or sets the tbl indep color |
| TblIndepPtType | Returns or sets the tbl indep pt type |
| Translucency | Returns or sets the translucency |
| UndefValueColor | Returns or sets the undef value color |
| UnderflowColor | Returns or sets the underflow color |
| XMax | Returns the x max |
| XMin | Returns the x min |
| XNum | Returns or sets the x num |
| YMax | Returns the y max |
| YMin | Returns the y min |
| YNum | Returns or sets the y num |
| ZMax | Returns the z max |
| ZMin | Returns the z min |
| ZNum | Returns or sets the z num |
| 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. |
| 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. |
DisplayPropertiesBuilder.AxisColor¶Returns or sets the axis color
-------------------------------------
Getter Method
Signature AxisColor
| Returns: | |
|---|---|
| Return type: | Id |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature AxisColor
| Parameters: | axisColor (Id) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.BasicColor¶Returns or sets the basic color
-------------------------------------
Getter Method
Signature BasicColor
| Returns: | |
|---|---|
| Return type: | Id |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature BasicColor
| Parameters: | basicColor (Id) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.DepCalcSymblSize¶Returns or sets the dep calc symbl size
-------------------------------------
Getter Method
Signature DepCalcSymblSize
| Returns: | |
|---|---|
| Return type: | float |
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature DepCalcSymblSize
| Parameters: | depCalcSymblSize (float) – |
|---|
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.DepDispType¶Returns or sets the dep disp type
-------------------------------------
Getter Method
Signature DepDispType
| Returns: | |
|---|---|
| Return type: | NXOpen.Fields.DisplayPropertiesBuilderDepDispTypeEnum |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature DepDispType
| Parameters: | depDispType (NXOpen.Fields.DisplayPropertiesBuilderDepDispTypeEnum) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.DepDomColor¶Returns or sets the dep dom color
-------------------------------------
Getter Method
Signature DepDomColor
| Returns: | |
|---|---|
| Return type: | NXOpen.Fields.DisplayPropertiesBuilderDepDomColorEnum |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature DepDomColor
| Parameters: | depDomColor (NXOpen.Fields.DisplayPropertiesBuilderDepDomColorEnum) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.DepLabelValues¶Returns or sets the dep label values
-------------------------------------
Getter Method
Signature DepLabelValues
| Returns: | |
|---|---|
| Return type: | NXOpen.Fields.DisplayPropertiesBuilderDepLabelValueEnum |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature DepLabelValues
| Parameters: | depLabelValues (NXOpen.Fields.DisplayPropertiesBuilderDepLabelValueEnum) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.DepRangeMax¶Returns or sets the dep range max
-------------------------------------
Getter Method
Signature DepRangeMax
| Returns: | |
|---|---|
| Return type: | float |
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature DepRangeMax
| Parameters: | depRangeMax (float) – |
|---|
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.DepRangeMin¶Returns or sets the dependent range min
-------------------------------------
Getter Method
Signature DepRangeMin
| Returns: | |
|---|---|
| Return type: | float |
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature DepRangeMin
| Parameters: | depRangeMin (float) – |
|---|
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.DepSelColor¶Returns or sets the dep sel color
-------------------------------------
Getter Method
Signature DepSelColor
| Returns: | |
|---|---|
| Return type: | Id |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature DepSelColor
| Parameters: | depSelColor (Id) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.DepSymbolSize¶Returns or sets the dep symbol size
-------------------------------------
Getter Method
Signature DepSymbolSize
| Returns: | |
|---|---|
| Return type: | float |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature DepSymbolSize
| Parameters: | depSymbolSize (float) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.DisplayResolution¶Returns or sets the display resolution
-------------------------------------
Getter Method
Signature DisplayResolution
| Returns: | |
|---|---|
| Return type: | NXOpen.Fields.DisplayPropertiesBuilderDispResolutionEnum |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature DisplayResolution
| Parameters: | displayResolution (NXOpen.Fields.DisplayPropertiesBuilderDispResolutionEnum) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.DummyScale¶Returns or sets the dummy scale
-------------------------------------
Getter Method
Signature DummyScale
| Returns: | |
|---|---|
| Return type: | float |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature DummyScale
| Parameters: | dummyScale (float) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.FaceAnalysis¶Returns or sets the face analysis
-------------------------------------
Getter Method
Signature FaceAnalysis
| Returns: | |
|---|---|
| Return type: | bool |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature FaceAnalysis
| Parameters: | faceAnalysis (bool) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.FieldQuantity¶Returns or sets the field quantity type
-------------------------------------
Getter Method
Signature FieldQuantity
| Returns: | |
|---|---|
| Return type: | NXOpen.Fields.DisplayPropertiesBuilderFieldQuantityType |
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature FieldQuantity
| Parameters: | fieldQuantity (NXOpen.Fields.DisplayPropertiesBuilderFieldQuantityType) – |
|---|
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.IndepDispType¶Returns or sets the indep disp type
-------------------------------------
Getter Method
Signature IndepDispType
| Returns: | |
|---|---|
| Return type: | NXOpen.Fields.DisplayPropertiesBuilderIndepDomDispType |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature IndepDispType
| Parameters: | indepDispType (NXOpen.Fields.DisplayPropertiesBuilderIndepDomDispType) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.LabelColor¶Returns or sets the label color
-------------------------------------
Getter Method
Signature LabelColor
| Returns: | |
|---|---|
| Return type: | Id |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature LabelColor
| Parameters: | labelColor (Id) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.Layer¶Returns or sets the layer
-------------------------------------
Getter Method
Signature Layer
| Returns: | |
|---|---|
| Return type: | int |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature Layer
| Parameters: | layer (int) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.LegendPosition¶Returns or sets the legend position
-------------------------------------
Getter Method
Signature LegendPosition
| Returns: | |
|---|---|
| Return type: | NXOpen.Fields.DisplayPropertiesBuilderLegendPos |
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature LegendPosition
| Parameters: | legendPosition (NXOpen.Fields.DisplayPropertiesBuilderLegendPos) – |
|---|
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.LineFont¶Returns or sets the line font
-------------------------------------
Getter Method
Signature LineFont
| Returns: | |
|---|---|
| Return type: | NXOpen.Fields.DisplayPropertiesBuilderLineFontEnum |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature LineFont
| Parameters: | lineFont (NXOpen.Fields.DisplayPropertiesBuilderLineFontEnum) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.LineWidth¶Returns or sets the line width
-------------------------------------
Getter Method
Signature LineWidth
| Returns: | |
|---|---|
| Return type: | NXOpen.Fields.DisplayPropertiesBuilderLineWidthEnum |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature LineWidth
| Parameters: | lineWidth (NXOpen.Fields.DisplayPropertiesBuilderLineWidthEnum) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.OverflowColor¶Returns or sets the overflow color
-------------------------------------
Getter Method
Signature OverflowColor
| Returns: | |
|---|---|
| Return type: | Id |
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature OverflowColor
| Parameters: | overflowColor (Id) – |
|---|
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.PartiallyShaded¶Returns or sets the partially shaded
-------------------------------------
Getter Method
Signature PartiallyShaded
| Returns: | |
|---|---|
| Return type: | bool |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature PartiallyShaded
| Parameters: | partiallyShaded (bool) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.PrimaryVar¶Returns the primary var name
-------------------------------------
Getter Method
Signature PrimaryVar
| Returns: | |
|---|---|
| Return type: | NXOpen.Expression |
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.Range¶Returns or sets the range
-------------------------------------
Getter Method
Signature Range
| Returns: | |
|---|---|
| Return type: | NXOpen.Fields.DisplayPropertiesBuilderValueRange |
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature Range
| Parameters: | range (NXOpen.Fields.DisplayPropertiesBuilderValueRange) – |
|---|
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.RangeMax¶Returns or sets the legend range max
-------------------------------------
Getter Method
Signature RangeMax
| Returns: | |
|---|---|
| Return type: | float |
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature RangeMax
| Parameters: | rangeMax (float) – |
|---|
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.RangeMin¶Returns or sets the legend range min
-------------------------------------
Getter Method
Signature RangeMin
| Returns: | |
|---|---|
| Return type: | float |
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature RangeMin
| Parameters: | rangeMin (float) – |
|---|
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.ShowAxis¶Returns or sets the show axis
-------------------------------------
Getter Method
Signature ShowAxis
| Returns: | |
|---|---|
| Return type: | bool |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature ShowAxis
| Parameters: | showAxis (bool) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.ShowDefaultVal¶Returns or sets the show default val
-------------------------------------
Getter Method
Signature ShowDefaultVal
| Returns: | |
|---|---|
| Return type: | bool |
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature ShowDefaultVal
| Parameters: | showDefaultVal (bool) – |
|---|
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.ShowDescription¶Returns or sets the show description
-------------------------------------
Getter Method
Signature ShowDescription
| Returns: | |
|---|---|
| Return type: | bool |
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature ShowDescription
| Parameters: | showDescription (bool) – |
|---|
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.ShowLabels¶Returns or sets the show labels
-------------------------------------
Getter Method
Signature ShowLabels
| Returns: | |
|---|---|
| Return type: | bool |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature ShowLabels
| Parameters: | showLabels (bool) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.ShowMapTopo¶Returns or sets the show map topo
-------------------------------------
Getter Method
Signature ShowMapTopo
| Returns: | |
|---|---|
| Return type: | bool |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature ShowMapTopo
| Parameters: | showMapTopo (bool) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.ShowName¶Returns or sets the show name
-------------------------------------
Getter Method
Signature ShowName
| Returns: | |
|---|---|
| Return type: | bool |
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature ShowName
| Parameters: | showName (bool) – |
|---|
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.ShowOverflowValues¶Returns or sets the show overflow
-------------------------------------
Getter Method
Signature ShowOverflowValues
| Returns: | |
|---|---|
| Return type: | bool |
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature ShowOverflowValues
| Parameters: | showOverflow (bool) – |
|---|
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.ShowSrcTblVals¶Returns or sets the show dep src tbl vals
-------------------------------------
Getter Method
Signature ShowSrcTblVals
| Returns: | |
|---|---|
| Return type: | bool |
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature ShowSrcTblVals
| Parameters: | showSrcTblVals (bool) – |
|---|
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.ShowUndefValues¶Returns or sets the show new undefined values
-------------------------------------
Getter Method
Signature ShowUndefValues
| Returns: | |
|---|---|
| Return type: | bool |
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature ShowUndefValues
| Parameters: | showUndefinedValues (bool) – |
|---|
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.ShowUndefinedValues¶Returns or sets the show undefined values
-------------------------------------
Getter Method
Signature ShowUndefinedValues
| Returns: | |
|---|---|
| Return type: | NXOpen.Fields.DisplayPropertiesBuilderValuesEnum |
New in version NX6.0.1.
Deprecated since version NX12.0.0: This method is deprecated. Use NXOpen.Fields.DisplayPropertiesBuilder.ShowUndefValues() Undefined values are no longer displayed with various symbols, but are only on or off.
License requirements: None.
-------------------------------------
Setter Method
Signature ShowUndefinedValues
| Parameters: | showUndefinedValues (NXOpen.Fields.DisplayPropertiesBuilderValuesEnum) – |
|---|
New in version NX6.0.1.
Deprecated since version NX12.0.0: This method is deprecated. Use NXOpen.Fields.DisplayPropertiesBuilder.ShowUndefValues() Undefined values are no longer displayed with various symbols, but are only on or off. For backward compatibility, calling this method with hide is the same as calling the new method with false; any other value is the same as calling the new method with true.
License requirements: None.
DisplayPropertiesBuilder.ShowUnderflowValues¶Returns or sets the show underflow
-------------------------------------
Getter Method
Signature ShowUnderflowValues
| Returns: | |
|---|---|
| Return type: | bool |
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature ShowUnderflowValues
| Parameters: | showUnderflow (bool) – |
|---|
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.SpectrumLevels¶Returns or sets the spectrum levels
-------------------------------------
Getter Method
Signature SpectrumLevels
| Returns: | |
|---|---|
| Return type: | int |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature SpectrumLevels
| Parameters: | spectrumLevels (int) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.SurfaceOffset¶Returns or sets the surface offset
-------------------------------------
Getter Method
Signature SurfaceOffset
| Returns: | |
|---|---|
| Return type: | float |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature SurfaceOffset
| Parameters: | surfaceOffset (float) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.TblDepColor¶Returns or sets the table dependent color
-------------------------------------
Getter Method
Signature TblDepColor
| Returns: | |
|---|---|
| Return type: | Id |
New in version NX6.0.1.
Deprecated since version NX12.0.0: This function is deprecated, Tbl dependent Color can be obtained using NXOpen.Fields.DisplayPropertiesBuilder.DepSelColor().
License requirements: None.
-------------------------------------
Setter Method
Signature TblDepColor
| Parameters: | tblDepColor (Id) – |
|---|
New in version NX6.0.1.
Deprecated since version NX12.0.0: This function is deprecated, Tbl dependent Color can be set using NXOpen.Fields.DisplayPropertiesBuilder.DepSelColor().
License requirements: None.
DisplayPropertiesBuilder.TblDepDomColor¶Returns or sets the table dependent domain color
-------------------------------------
Getter Method
Signature TblDepDomColor
| Returns: | |
|---|---|
| Return type: | NXOpen.Fields.DisplayPropertiesBuilderDepDomColorEnum |
New in version NX7.5.0.
Deprecated since version NX12.0.0: This function is deprecated, Tbl dependent Color can be chosen using NXOpen.Fields.DisplayPropertiesBuilder.DepDomColor().
License requirements: None.
-------------------------------------
Setter Method
Signature TblDepDomColor
| Parameters: | depDomColor (NXOpen.Fields.DisplayPropertiesBuilderDepDomColorEnum) – |
|---|
New in version NX7.5.0.
Deprecated since version NX12.0.0: This function is deprecated, Tbl dependent Color can be chosen using NXOpen.Fields.DisplayPropertiesBuilder.DepDomColor().
License requirements: None.
DisplayPropertiesBuilder.TblDepLabelValues¶Returns or sets the table dependent label values
-------------------------------------
Getter Method
Signature TblDepLabelValues
| Returns: | |
|---|---|
| Return type: | NXOpen.Fields.DisplayPropertiesBuilderDepLabelValueEnum |
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature TblDepLabelValues
| Parameters: | tblDepLabelValues (NXOpen.Fields.DisplayPropertiesBuilderDepLabelValueEnum) – |
|---|
New in version NX7.5.0.
License requirements: None.
DisplayPropertiesBuilder.TblDepPtType¶Returns or sets the tbl dep pt type
-------------------------------------
Getter Method
Signature TblDepPtType
| Returns: | |
|---|---|
| Return type: | NXOpen.Fields.DisplayPropertiesBuilderTblPointTypeEnum |
New in version NX6.0.1.
Deprecated since version NX12.0.0: To show source table dependent values use NXOpen.Fields.DisplayPropertiesBuilder.ShowSrcTblVals() to show source table values.
License requirements: None.
-------------------------------------
Setter Method
Signature TblDepPtType
| Parameters: | tblDepPtType (NXOpen.Fields.DisplayPropertiesBuilderTblPointTypeEnum) – |
|---|
New in version NX6.0.1.
Deprecated since version NX12.0.0: Source table display no longer uses symbols, so this function has no meaning. Table values are only on or off; to show source table values use NXOpen.Fields.DisplayPropertiesBuilder.ShowSrcTblVals() to show source table values.
License requirements: None.
DisplayPropertiesBuilder.TblDepSymbolSize¶Returns or sets the table dependent symbol size
-------------------------------------
Getter Method
Signature TblDepSymbolSize
| Returns: | |
|---|---|
| Return type: | float |
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature TblDepSymbolSize
| Parameters: | tblDepSymbolSize (float) – |
|---|
New in version NX7.5.0.
License requirements: None.
DisplayPropertiesBuilder.TblIndepColor¶Returns or sets the tbl indep color
-------------------------------------
Getter Method
Signature TblIndepColor
| Returns: | |
|---|---|
| Return type: | Id |
New in version NX6.0.1.
Deprecated since version NX12.0.0: This function is deprecated. Table independent domain is no longer displayable so this property has no meaning. Dependent domain color can be obtained using NXOpen.Fields.DisplayPropertiesBuilder.DepSelColor().
License requirements: None.
-------------------------------------
Setter Method
Signature TblIndepColor
| Parameters: | tblIndepColor (Id) – |
|---|
New in version NX6.0.1.
Deprecated since version NX12.0.0: This function is deprecated. Table independent domain is no longer displayable, so this function has no meaning. Table dependent domain color can be set using NXOpen.Fields.DisplayPropertiesBuilder.DepSelColor().
License requirements: None.
DisplayPropertiesBuilder.TblIndepPtType¶Returns or sets the tbl indep pt type
-------------------------------------
Getter Method
Signature TblIndepPtType
| Returns: | |
|---|---|
| Return type: | NXOpen.Fields.DisplayPropertiesBuilderValuesEnum |
New in version NX6.0.1.
Deprecated since version NX12.0.0: Table independent domain display no longer modifies the file and is included only to enable old journals to function without modification NXOpen.Fields.DisplayPropertiesBuilder.ShowSrcTblVals() can be used to control source table values, but independent table values display is deprecated.
License requirements: None.
-------------------------------------
Setter Method
Signature TblIndepPtType
| Parameters: | tblIndepPtType (NXOpen.Fields.DisplayPropertiesBuilderValuesEnum) – |
|---|
New in version NX6.0.1.
Deprecated since version NX12.0.0: Table Independent variable display no longer modifies the file and is included only to enable old journals to function without modification. NXOpen.Fields.DisplayPropertiesBuilder.ShowSrcTblVals() can be used to show source table values, but independent table values display is deprecated.
License requirements: None.
DisplayPropertiesBuilder.Translucency¶Returns or sets the translucency
-------------------------------------
Getter Method
Signature Translucency
| Returns: | |
|---|---|
| Return type: | int |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature Translucency
| Parameters: | translucency (int) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.UndefValueColor¶Returns or sets the undef value color
-------------------------------------
Getter Method
Signature UndefValueColor
| Returns: | |
|---|---|
| Return type: | Id |
New in version NX6.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature UndefValueColor
| Parameters: | undefValueColor (Id) – |
|---|
New in version NX6.0.1.
License requirements: None.
DisplayPropertiesBuilder.UnderflowColor¶Returns or sets the underflow color
-------------------------------------
Getter Method
Signature UnderflowColor
| Returns: | |
|---|---|
| Return type: | Id |
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature UnderflowColor
| Parameters: | underflowColor (Id) – |
|---|
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.XMax¶Returns the x max
-------------------------------------
Getter Method
Signature XMax
| Returns: | |
|---|---|
| Return type: | NXOpen.Expression |
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.XMin¶Returns the x min
-------------------------------------
Getter Method
Signature XMin
| Returns: | |
|---|---|
| Return type: | NXOpen.Expression |
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.XNum¶Returns or sets the x num
-------------------------------------
Getter Method
Signature XNum
| Returns: | |
|---|---|
| Return type: | int |
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature XNum
| Parameters: | xNum (int) – |
|---|
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.YMax¶Returns the y max
-------------------------------------
Getter Method
Signature YMax
| Returns: | |
|---|---|
| Return type: | NXOpen.Expression |
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.YMin¶Returns the y min
-------------------------------------
Getter Method
Signature YMin
| Returns: | |
|---|---|
| Return type: | NXOpen.Expression |
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.YNum¶Returns or sets the y num
-------------------------------------
Getter Method
Signature YNum
| Returns: | |
|---|---|
| Return type: | int |
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature YNum
| Parameters: | yNum (int) – |
|---|
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.ZMax¶Returns the z max
-------------------------------------
Getter Method
Signature ZMax
| Returns: | |
|---|---|
| Return type: | NXOpen.Expression |
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.ZMin¶Returns the z min
-------------------------------------
Getter Method
Signature ZMin
| Returns: | |
|---|---|
| Return type: | NXOpen.Expression |
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.ZNum¶Returns or sets the z num
-------------------------------------
Getter Method
Signature ZNum
| Returns: | |
|---|---|
| Return type: | int |
New in version NX12.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature ZNum
| Parameters: | zNum (int) – |
|---|
New in version NX12.0.0.
License requirements: None.
DisplayPropertiesBuilder.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.