Dimension Class

class NXOpen.Annotations.Dimension

Bases: NXOpen.Annotations.Annotation, NXOpen.Annotations.IAppendedText

Represents a dimension

Abstract class

New in version NX3.0.0.

Properties

Property Description
AnnotationOrigin Returns or sets the origin (location) of the annotation.
AnnotationPlane Returns or sets the annotation plane.
Color Returns or sets the color of the object.
ComputedSize Returns the computed size of the dimension.
HasAssociativeOrigin Returns a flag indicating whether the origin is associative
InspectionDimensionFlag Returns or sets a setting to control the inspection box displayed around the dimension value.
IsBlanked Returns the blank status of this object.
IsOccurrence Returns whether this object is an occurrence or not.
IsOriginCentered Returns or sets a flag indicating whether the dimension text is centered equally between the extension lines.
IsRetained Returns a flag indicating whether the annotation is retained
JournalIdentifier Returns the identifier that would be recorded in a journal for this object.
Layer Returns or sets the layer that the object is in.
LeaderOrientation Returns or sets the leader orientation for the annotation.
LimitFitAnsiHoleType Returns or sets the tolerance limit fit ANSI hole type.
LimitFitDeviation Returns or sets the tolerance limit fit deviation.
LimitFitDisplayStyle Returns or sets the tolerance limit fit display style.
LimitFitEnhancedDisplayType Returns or sets the enhanced limit fit display type.
LimitFitGrade Returns or sets the tolerance limit fit grade.
LimitFitShaftDeviation Returns or sets the deviation for limit fit representation of shaft tolerance NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
LimitFitShaftGrade Returns or sets the grade for limit fit representation of shaft tolerance NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object.
LineFont Returns or sets the line font of the object.
LineWidth Returns or sets the line width of the object.
LowerMetricToleranceValue Returns or sets a setting to control the metric lower tolerance value of a dimension.
LowerToleranceValue Returns or sets a setting to control the lower tolerance value of a dimension.
MeasurementDirection Returns or sets the measurement direction.
MeasurementDirectionView Returns or sets the measurement direction view.
MetricNominalDecimalPlaces Returns or sets a setting to control the number of decimal places for the nominal value of a metric dimension.
MetricToleranceDecimalPlaces Returns or sets a setting to control the number of decimal places for the metric tolerance value of a dimension.
Name Returns the custom name of the object.
NameLocation Returns the location of the object’s name.
NominalDecimalPlaces Returns or sets a setting to control the number of decimal places for the nominal value of a dimension.
NumberOfAssociativities Returns the number of associativities for the annotation.
OwningComponent Returns the owning component, if this object is an occurrence.
OwningPart Returns the owning part of this object
Prototype Returns the prototype of this object if it is an occurrence.
ReferenceDimensionFlag Returns or sets a setting to control the visibility of the reference parenthesis of a dimension.
Tag Returns the Tag for this object.
ToleranceDecimalPlaces Returns or sets a setting to control the number of decimal places for the primary tolerance value of a dimension.
ToleranceType Returns or sets a setting to control the tolerance display style.
UpperMetricToleranceValue Returns or sets a setting to control the metric upper tolerance value of a dimension.
UpperToleranceValue Returns or sets a setting to control the upper tolerance value of a dimension.

Methods

Method Description
Blank Blanks the object.
DeleteAllAttributesByType Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle Deletes an attribute by type and title.
DeleteUserAttribute Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes Deletes the attributes encountered with the given Type with option to update or not.
FindObject Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
GetAppendedText Returns the appended text @return Appended text
GetAssociativeOrigin Gets data that specifies the origin’s associativity @return associativity data
GetAssociativity Returns the associativity at specified index.
GetAttributeTitlesByType Gets all the attribute titles of a specific type.
GetBooleanUserAttribute Gets a boolean attribute by Title and array Index.
GetComputationalTimeUserAttribute Gets a time attribute by Title and array Index.
GetDimensionPreferences Returns the dimension preferences @return Dimenension preferences
GetDimensionText Returns the dimension text - both the main text and the dual text.
GetFirstAssociativity Returns the first associativity data.
GetInferredAnnotationPlane Returns the inferred annotation plane @return
GetIntegerAttribute Gets an integer attribute by title.
GetIntegerUserAttribute Gets an integer attribute by Title and array Index.
GetLetteringPreferences Returns the lettering preferences for the annotation @return
GetLineAndArrowPreferences Returns the line and arrow preferences for the annotation @return
GetMeasurementType Returns dimension measurement type.
GetNarrowDimensionPreferences Returns the narrow dimension preferences for the given linear dimension.
GetNarrowDimensionTextOffset Returns the narrow dimension text offset for the given chain dimension.
GetRealAttribute Gets a real attribute by title.
GetRealUserAttribute Gets a real attribute by Title and array Index.
GetReferenceAttribute Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetSecondAssociativity Returns the second associativity data.
GetStringAttribute Gets a string attribute value by title.
GetStringUserAttribute Gets a string attribute by Title and array Index.
GetSymbolPreferences Returns the symbol preferences for the annotation @return
GetTimeAttribute Gets a time attribute by title.
GetTimeUserAttribute Gets a time attribute by Title and array Index.
GetUserAttribute Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount Gets the count of set attributes on the object, if any, of the given type.
GetUserAttributeLock Determine the lock of the given attribute.
GetUserAttributeSize Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects Returns an array of objects from which this object presents attributes.
GetUserAttributes Gets all the attributes that have been set on the given object.
GetUserAttributesAsStrings Gets all the attributes that have been set on the given object.
GetViews Returns the views that the PMI display instance object is displayed in NOTE: This method is only valid for PMI display instance objects.
HasUserAttribute Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object.
Highlight Highlights the object.
InsertIntoStack Inserts the annotation into a stack.
IsApproximate Returns whether or not the given dimension is approximate.
IsDriving Determines if a dimension is driving.
Print Prints a representation of this object to the system log file.
RedisplayObject Redisplays the object in all views.
RemoveViewDependency Remove dependency on all views from an object.
SetAppendedText Sets the appended text
SetAssociativeOrigin Associates the annotation’s origin to the specified geometry.
SetAssociativity Sets the associativity at specified index.
SetAttribute Creates or modifies an integer attribute.
SetBooleanUserAttribute Creates or modifies a boolean attribute with the option to update or not.
SetComputedSize  
SetDimensionPreferences Sets the dimension preferences
SetDimensionText Set the main dimension text.
SetFirstAssociativity Sets the first associativity data.
SetLetteringPreferences Sets the lettering preferences for the annotation.
SetLineAndArrowPreferences Sets the line and arrow preferences for the annotation.
SetName Sets the custom name of the object.
SetNameLocation Sets the location of the object’s name.
SetNarrowDimensionPreferences Sets the narrow dimension preferences to the given linear dimension.
SetNarrowDimensionTextOffset Sets the narrow dimension text offset for the given chain dimension.
SetReferenceAttribute Creates or modifies a string attribute which uses a reference string.
SetSecondAssociativity Sets the second associativity data.
SetSymbolPreferences Sets the symbol preferences for the annotation.
SetTimeAttribute Creates or modifies a time attribute.
SetTimeUserAttribute Creates or modifies a time attribute with the option to update or not.
SetUserAttribute Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock Lock or unlock the given attribute.
SetViews Sets the views that the PMI display instance object is displayed in.
Unblank Unblanks the object.
Unhighlight Unhighlights the object.

Enumerations

DimensionMeasurementTypes Enumeration Specifies dimension measurement types

Property Detail

ComputedSize

Dimension.ComputedSize

Returns the computed size of the dimension.

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

Getter Method

Signature ComputedSize()

Returns:
Return type:float

New in version NX5.0.0.

License requirements: None.

InspectionDimensionFlag

Dimension.InspectionDimensionFlag

Returns or sets a setting to control the inspection box displayed around the dimension value.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature InspectionDimensionFlag()

Returns:
Return type:bool

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature InspectionDimensionFlag(inspectionDimensionFlag)

Parameters:inspectionDimensionFlag (bool) –

New in version NX5.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

IsOccurrence

Dimension.IsOccurrence

Returns whether this object is an occurrence or not.

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

Getter Method

Signature IsOccurrence()

Returns:This object is an occurrence
Return type:bool

New in version NX3.0.0.

License requirements: None.

IsOriginCentered

Dimension.IsOriginCentered

Returns or sets a flag indicating whether the dimension text is centered equally between the extension lines.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature IsOriginCentered()

Returns:
Return type:bool

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature IsOriginCentered(isOriginCentered)

Parameters:isOriginCentered (bool) –

New in version NX5.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

JournalIdentifier

Dimension.JournalIdentifier

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

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

Getter Method

Signature JournalIdentifier()

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

LimitFitAnsiHoleType

Dimension.LimitFitAnsiHoleType

Returns or sets the tolerance limit fit ANSI hole type.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature LimitFitAnsiHoleType()

Returns:Limit fit ansi hole type
Return type:NXOpen.Annotations.FitAnsiHoleType

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature LimitFitAnsiHoleType(fitHoleType)

Parameters:fitHoleType (NXOpen.Annotations.FitAnsiHoleType) – New limit fit ansi hole type

New in version NX7.5.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

LimitFitDeviation

Dimension.LimitFitDeviation

Returns or sets the tolerance limit fit deviation.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature LimitFitDeviation()

Returns:Limit fit deviation
Return type:str

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature LimitFitDeviation(fitDeviation)

Parameters:fitDeviation (str) – New limit fit deviation

New in version NX7.5.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

LimitFitDisplayStyle

Dimension.LimitFitDisplayStyle

Returns or sets the tolerance limit fit display style.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature LimitFitDisplayStyle()

Returns:Limit fit tolerance display style
Return type:NXOpen.Annotations.FitDisplayStyle

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature LimitFitDisplayStyle(fitDisplayStyle)

Parameters:fitDisplayStyle (NXOpen.Annotations.FitDisplayStyle) – New limit fit tolerance display style

New in version NX7.5.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

LimitFitEnhancedDisplayType

Dimension.LimitFitEnhancedDisplayType

Returns or sets the enhanced limit fit display type.

Used to determine if the tolerance representation is for hole, shaft, or fit tolerance (fit meaning both hole and shaft tolerances are displayed).

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature LimitFitEnhancedDisplayType()

Returns:Limit fit enhanced tolerance display style
Return type:NXOpen.Annotations.FitAnsiHoleType

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature LimitFitEnhancedDisplayType(fitEnhancedDisplayType)

Parameters:fitEnhancedDisplayType (NXOpen.Annotations.FitAnsiHoleType) – New limit fit enhanced tolerance display style

New in version NX9.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

LimitFitGrade

Dimension.LimitFitGrade

Returns or sets the tolerance limit fit grade.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature LimitFitGrade()

Returns:Limit fit grade
Return type:int

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature LimitFitGrade(fitGrade)

Parameters:fitGrade (int) – New limit fit grade

New in version NX7.5.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

LimitFitShaftDeviation

Dimension.LimitFitShaftDeviation

Returns or sets the deviation for limit fit representation of shaft tolerance

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature LimitFitShaftDeviation()

Returns:Limit fit shaft deviation
Return type:str

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature LimitFitShaftDeviation(fitShaftDeviation)

Parameters:fitShaftDeviation (str) – New limit fit shaft deviation

New in version NX9.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

LimitFitShaftGrade

Dimension.LimitFitShaftGrade

Returns or sets the grade for limit fit representation of shaft tolerance

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature LimitFitShaftGrade()

Returns:Limit fit shaft grade
Return type:int

New in version NX9.0.0.

License requirements: None.

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

Setter Method

Signature LimitFitShaftGrade(fitShaftGrade)

Parameters:fitShaftGrade (int) – New limit fit shaft grade

New in version NX9.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

LowerMetricToleranceValue

Dimension.LowerMetricToleranceValue

Returns or sets a setting to control the metric lower tolerance value of a dimension.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature LowerMetricToleranceValue()

Returns:
Return type:float

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature LowerMetricToleranceValue(toleranceValue)

Parameters:toleranceValue (float) –

New in version NX5.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

LowerToleranceValue

Dimension.LowerToleranceValue

Returns or sets a setting to control the lower tolerance value of a dimension.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature LowerToleranceValue()

Returns:
Return type:float

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature LowerToleranceValue(upperToleranceValue)

Parameters:upperToleranceValue (float) –

New in version NX5.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

MeasurementDirection

Dimension.MeasurementDirection

Returns or sets the measurement direction.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature MeasurementDirection()

Returns:Direction Object
Return type:NXOpen.Direction

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature MeasurementDirection(direction)

Parameters:direction (NXOpen.Direction) – Direction Object

New in version NX7.5.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

MeasurementDirectionView

Dimension.MeasurementDirectionView

Returns or sets the measurement direction view.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature MeasurementDirectionView()

Returns:View Object
Return type:NXOpen.View

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature MeasurementDirectionView(view)

Parameters:view (NXOpen.View) – View Object

New in version NX7.5.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

MetricNominalDecimalPlaces

Dimension.MetricNominalDecimalPlaces

Returns or sets a setting to control the number of decimal places for the nominal value of a metric dimension.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature MetricNominalDecimalPlaces()

Returns:
Return type:int

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature MetricNominalDecimalPlaces(decimalPlaces)

Parameters:decimalPlaces (int) –

New in version NX5.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

MetricToleranceDecimalPlaces

Dimension.MetricToleranceDecimalPlaces

Returns or sets a setting to control the number of decimal places for the metric tolerance value of a dimension.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature MetricToleranceDecimalPlaces()

Returns:
Return type:int

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature MetricToleranceDecimalPlaces(decimalPlaces)

Parameters:decimalPlaces (int) –

New in version NX5.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

Name

Dimension.Name

Returns the custom name of the object.

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

Getter Method

Signature Name()

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

NominalDecimalPlaces

Dimension.NominalDecimalPlaces

Returns or sets a setting to control the number of decimal places for the nominal value of a dimension.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature NominalDecimalPlaces()

Returns:
Return type:int

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature NominalDecimalPlaces(decimalPlaces)

Parameters:decimalPlaces (int) –

New in version NX5.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

OwningComponent

Dimension.OwningComponent

Returns the owning component, if this object is an occurrence.

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

Getter Method

Signature OwningComponent()

Returns:
Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

Dimension.OwningPart

Returns the owning part of this object

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

Getter Method

Signature OwningPart()

Returns:The owning part of this object or null if it does not have an owner
Return type:NXOpen.BasePart

New in version NX3.0.0.

License requirements: None.

Prototype

Dimension.Prototype

Returns the prototype of this object if it is an occurrence.

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

Getter Method

Signature Prototype()

Returns:The prototype of this object or null if this object is not an occurrence
Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

ReferenceDimensionFlag

Dimension.ReferenceDimensionFlag

Returns or sets a setting to control the visibility of the reference parenthesis of a dimension.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature ReferenceDimensionFlag()

Returns:
Return type:bool

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature ReferenceDimensionFlag(referenceDimensionFlag)

Parameters:referenceDimensionFlag (bool) –

New in version NX5.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

ToleranceDecimalPlaces

Dimension.ToleranceDecimalPlaces

Returns or sets a setting to control the number of decimal places for the primary tolerance value of a dimension.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature ToleranceDecimalPlaces()

Returns:
Return type:int

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature ToleranceDecimalPlaces(decimalPlaces)

Parameters:decimalPlaces (int) –

New in version NX5.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

ToleranceType

Dimension.ToleranceType

Returns or sets a setting to control the tolerance display style.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature ToleranceType()

Returns:
Return type:NXOpen.Annotations.ToleranceType

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature ToleranceType(toleranceType)

Parameters:toleranceType (NXOpen.Annotations.ToleranceType) –

New in version NX5.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

UpperMetricToleranceValue

Dimension.UpperMetricToleranceValue

Returns or sets a setting to control the metric upper tolerance value of a dimension.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature UpperMetricToleranceValue()

Returns:
Return type:float

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature UpperMetricToleranceValue(toleranceValue)

Parameters:toleranceValue (float) –

New in version NX5.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

UpperToleranceValue

Dimension.UpperToleranceValue

Returns or sets a setting to control the upper tolerance value of a dimension.

NOTE: The set method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

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

Getter Method

Signature UpperToleranceValue()

Returns:
Return type:float

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature UpperToleranceValue(upperToleranceValue)

Parameters:upperToleranceValue (float) –

New in version NX5.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

Method Detail

FindObject

Dimension.FindObject

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Journal identifier of the object
Returns:
Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

GetAppendedText

Dimension.GetAppendedText

Returns the appended text

Signature GetAppendedText()

Returns:Appended text
Return type:NXOpen.Annotations.AppendedText

New in version NX4.0.0.

License requirements: None.

GetDimensionPreferences

Dimension.GetDimensionPreferences

Returns the dimension preferences

Signature GetDimensionPreferences()

Returns:Dimenension preferences
Return type:NXOpen.Annotations.DimensionPreferences

New in version NX4.0.0.

License requirements: None.

GetDimensionText

Dimension.GetDimensionText

Returns the dimension text - both the main text and the dual text.

The returned text may contain just the computed dimension value or manual text including the control characters.

Note that the text doesn’t contain the tolerance text, appended text or text for flags like inspection/reference.

Signature GetDimensionText()

Returns:a tuple
Return type:A tuple consisting of (mainTextLines, dualTextLines). mainTextLines is a list of str. List of main text lines dualTextLines is a list of str. List of dual text lines

New in version NX6.0.0.

License requirements: None.

GetFirstAssociativity

Dimension.GetFirstAssociativity

Returns the first associativity data.

Signature GetFirstAssociativity()

Returns:
Return type:NXOpen.Annotations.Associativity

New in version NX5.0.0.

License requirements: None.

GetMeasurementType

Dimension.GetMeasurementType

Returns dimension measurement type.

Signature GetMeasurementType()

Returns:Dimension Measurement Type.
Return type:NXOpen.Annotations.DimensionMeasurementTypes

New in version NX10.0.0.

License requirements: None.

GetNarrowDimensionPreferences

Dimension.GetNarrowDimensionPreferences

Returns the narrow dimension preferences for the given linear dimension.

Signature GetNarrowDimensionPreferences()

Returns:Narrow dimension preferences
Return type:NXOpen.Annotations.NarrowDimensionData

New in version NX5.0.0.

License requirements: None.

GetNarrowDimensionTextOffset

Dimension.GetNarrowDimensionTextOffset

Returns the narrow dimension text offset for the given chain dimension.

Signature GetNarrowDimensionTextOffset()

Returns:
Return type:float

New in version NX5.0.0.

License requirements: None.

GetSecondAssociativity

Dimension.GetSecondAssociativity

Returns the second associativity data.

Signature GetSecondAssociativity()

Returns:
Return type:NXOpen.Annotations.Associativity

New in version NX5.0.0.

License requirements: None.

IsApproximate

Dimension.IsApproximate

Returns whether or not the given dimension is approximate.

A dimension is approximate if it is attached to lightweight view geometry that doesn’t have exact data.

Signature IsApproximate()

Returns:TRUE, if dimension is approximate.

FALSE, if dimension is not approximate. :rtype: bool

New in version NX9.0.0.

License requirements: None.

IsDriving

Dimension.IsDriving

Determines if a dimension is driving.

A driving dimension is a dimension that is used to constrain geometry created by the sketcher on a drawing. A driving dimension is also referred to as a sketch dimension.

Signature IsDriving()

Returns:
Return type:bool

New in version NX6.0.0.

License requirements: None.

Print

Dimension.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetAppendedText

Dimension.SetAppendedText

Sets the appended text

Signature SetAppendedText(appendedText)

Parameters:appendedText (NXOpen.Annotations.AppendedText) – Appended text

New in version NX4.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

SetComputedSize

Dimension.SetComputedSize

Signature SetComputedSize(computedSize)

Parameters:computedSize (float) –

New in version NX5.0.0.

Deprecated since version NX8.0.0: Use Annotations.Dimension.SetDimensionText instead.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

SetDimensionPreferences

Dimension.SetDimensionPreferences

Sets the dimension preferences

Signature SetDimensionPreferences(preferences)

Parameters:preferences (NXOpen.Annotations.DimensionPreferences) – New dimension preferences

New in version NX4.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

SetDimensionText

Dimension.SetDimensionText

Set the main dimension text.

For a dual dimension, the dual dimension text is determined from the main dimension text

Signature SetDimensionText(mainTextLines)

Parameters:mainTextLines (list of str) – List of main text lines

New in version NX7.5.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

SetFirstAssociativity

Dimension.SetFirstAssociativity

Sets the first associativity data.

Signature SetFirstAssociativity(newAssociativity)

Parameters:newAssociativity (NXOpen.Annotations.Associativity) –

New in version NX5.0.0.

License requirements: None.

SetName

Dimension.SetName

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Signature SetName(name)

Parameters:name (str) –

New in version NX3.0.0.

License requirements: None.

SetNarrowDimensionPreferences

Dimension.SetNarrowDimensionPreferences

Sets the narrow dimension preferences to the given linear dimension.

Signature SetNarrowDimensionPreferences(narrowDimensionData)

Parameters:narrowDimensionData (NXOpen.Annotations.NarrowDimensionData) – New narrow dimension preferences

New in version NX5.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

SetNarrowDimensionTextOffset

Dimension.SetNarrowDimensionTextOffset

Sets the narrow dimension text offset for the given chain dimension.

Signature SetNarrowDimensionTextOffset(narrowTextOffset)

Parameters:narrowTextOffset (float) –

New in version NX5.0.0.

License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)

SetSecondAssociativity

Dimension.SetSecondAssociativity

Sets the second associativity data.

Signature SetSecondAssociativity(newAssociativity)

Parameters:newAssociativity (NXOpen.Annotations.Associativity) –

New in version NX5.0.0.

License requirements: None.