DisplayPropertiesBuilder Class

class 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
DepDispType Symbol
DepDomColor Inherit
DepLabelValues None
DepSymbolSize 0
DisplayResolution Standard
DummyScale 0
FaceAnalysis 0
IndepDispType Normal
Layer 1
LineFont Solid
LineWidth Normal
PartiallyShaded 0
ShowAxis 0
ShowLabels 0
ShowMapTopo 0
ShowUndefinedValues Hide
SpectrumLevels 3
SurfaceOffset 0
TblDepPtType Hide
TblIndepPtType Hide
Translucency 0

New in version NX6.0.1.

Properties

Property Description
AxisColor Returns or sets the axis color
BasicColor Returns or sets the basic color
DepDispType Returns or sets the dep disp type
DepDomColor Returns or sets the dep dom color
DepLabelValues Returns or sets the dep label values
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
IndepDispType Returns or sets the indep disp type
LabelColor Returns or sets the label color
Layer Returns or sets the layer
LineFont Returns or sets the line font
LineWidth Returns or sets the line width
PartiallyShaded Returns or sets the partially shaded
ShowAxis Returns or sets the show axis
ShowLabels Returns or sets the show labels
ShowMapTopo Returns or sets the show map topo
ShowUndefinedValues Returns or sets the show undefined values
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

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.
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.

Property Detail

AxisColor

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(axisColor)

Parameters:axisColor (Id) –

New in version NX6.0.1.

License requirements: None.

BasicColor

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(basicColor)

Parameters:basicColor (Id) –

New in version NX6.0.1.

License requirements: None.

DepDispType

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(depDispType)

Parameters:depDispType (NXOpen.Fields.DisplayPropertiesBuilderDepDispTypeEnum) –

New in version NX6.0.1.

License requirements: None.

DepDomColor

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(depDomColor)

Parameters:depDomColor (NXOpen.Fields.DisplayPropertiesBuilderDepDomColorEnum) –

New in version NX6.0.1.

License requirements: None.

DepLabelValues

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(depLabelValues)

Parameters:depLabelValues (NXOpen.Fields.DisplayPropertiesBuilderDepLabelValueEnum) –

New in version NX6.0.1.

License requirements: None.

DepSelColor

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(depSelColor)

Parameters:depSelColor (Id) –

New in version NX6.0.1.

License requirements: None.

DepSymbolSize

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(depSymbolSize)

Parameters:depSymbolSize (float) –

New in version NX6.0.1.

License requirements: None.

DisplayResolution

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(displayResolution)

Parameters:displayResolution (NXOpen.Fields.DisplayPropertiesBuilderDispResolutionEnum) –

New in version NX6.0.1.

License requirements: None.

DummyScale

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(dummyScale)

Parameters:dummyScale (float) –

New in version NX6.0.1.

License requirements: None.

FaceAnalysis

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(faceAnalysis)

Parameters:faceAnalysis (bool) –

New in version NX6.0.1.

License requirements: None.

IndepDispType

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(indepDispType)

Parameters:indepDispType (NXOpen.Fields.DisplayPropertiesBuilderIndepDomDispType) –

New in version NX6.0.1.

License requirements: None.

LabelColor

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(labelColor)

Parameters:labelColor (Id) –

New in version NX6.0.1.

License requirements: None.

Layer

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(layer)

Parameters:layer (int) –

New in version NX6.0.1.

License requirements: None.

LineFont

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(lineFont)

Parameters:lineFont (NXOpen.Fields.DisplayPropertiesBuilderLineFontEnum) –

New in version NX6.0.1.

License requirements: None.

LineWidth

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(lineWidth)

Parameters:lineWidth (NXOpen.Fields.DisplayPropertiesBuilderLineWidthEnum) –

New in version NX6.0.1.

License requirements: None.

PartiallyShaded

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(partiallyShaded)

Parameters:partiallyShaded (bool) –

New in version NX6.0.1.

License requirements: None.

ShowAxis

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(showAxis)

Parameters:showAxis (bool) –

New in version NX6.0.1.

License requirements: None.

ShowLabels

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(showLabels)

Parameters:showLabels (bool) –

New in version NX6.0.1.

License requirements: None.

ShowMapTopo

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(showMapTopo)

Parameters:showMapTopo (bool) –

New in version NX6.0.1.

License requirements: None.

ShowUndefinedValues

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.

License requirements: None.

-------------------------------------

Setter Method

Signature ShowUndefinedValues(showUndefinedValues)

Parameters:showUndefinedValues (NXOpen.Fields.DisplayPropertiesBuilderValuesEnum) –

New in version NX6.0.1.

License requirements: None.

SpectrumLevels

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(spectrumLevels)

Parameters:spectrumLevels (int) –

New in version NX6.0.1.

License requirements: None.

SurfaceOffset

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(surfaceOffset)

Parameters:surfaceOffset (float) –

New in version NX6.0.1.

License requirements: None.

TblDepColor

DisplayPropertiesBuilder.TblDepColor

Returns or sets the table dependent color

-------------------------------------

Getter Method

Signature TblDepColor()

Returns:
Return type:Id

New in version NX6.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature TblDepColor(tblDepColor)

Parameters:tblDepColor (Id) –

New in version NX6.0.1.

License requirements: None.

TblDepDomColor

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.

License requirements: None.

-------------------------------------

Setter Method

Signature TblDepDomColor(depDomColor)

Parameters:depDomColor (NXOpen.Fields.DisplayPropertiesBuilderDepDomColorEnum) –

New in version NX7.5.0.

License requirements: None.

TblDepLabelValues

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(tblDepLabelValues)

Parameters:tblDepLabelValues (NXOpen.Fields.DisplayPropertiesBuilderDepLabelValueEnum) –

New in version NX7.5.0.

License requirements: None.

TblDepPtType

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.

License requirements: None.

-------------------------------------

Setter Method

Signature TblDepPtType(tblDepPtType)

Parameters:tblDepPtType (NXOpen.Fields.DisplayPropertiesBuilderTblPointTypeEnum) –

New in version NX6.0.1.

License requirements: None.

TblDepSymbolSize

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(tblDepSymbolSize)

Parameters:tblDepSymbolSize (float) –

New in version NX7.5.0.

License requirements: None.

TblIndepColor

DisplayPropertiesBuilder.TblIndepColor

Returns or sets the tbl indep color

-------------------------------------

Getter Method

Signature TblIndepColor()

Returns:
Return type:Id

New in version NX6.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature TblIndepColor(tblIndepColor)

Parameters:tblIndepColor (Id) –

New in version NX6.0.1.

License requirements: None.

TblIndepPtType

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.

License requirements: None.

-------------------------------------

Setter Method

Signature TblIndepPtType(tblIndepPtType)

Parameters:tblIndepPtType (NXOpen.Fields.DisplayPropertiesBuilderValuesEnum) –

New in version NX6.0.1.

License requirements: None.

Translucency

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(translucency)

Parameters:translucency (int) –

New in version NX6.0.1.

License requirements: None.

UndefValueColor

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(undefValueColor)

Parameters:undefValueColor (Id) –

New in version NX6.0.1.

License requirements: None.

Method Detail

Validate

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.