OrdinateDimensionPreferences Class

class NXOpen.Annotations.OrdinateDimensionPreferences

Bases: NXOpen.TransientObject

Represents ordinate dimension preferences

New in version NX4.0.0.

Properties

Property	Description
AlignSymbolWithBaseline	Returns or sets the flag indicating whether to align the user defined symbol with the base line
DoglegAngle	Returns or sets the dogleg angle
DoglegCreationOption	Returns or sets the dogleg creation option
DoglegDefinition	Returns or sets the dogleg definition
DoglegEndOffset	Returns or sets the dogleg end offset
DoglegStartOffset	Returns or sets the dogleg start offset
FirstMarginOffset	Returns or sets the first margin offset
LineArrowDisplayOption	Returns or sets the dimension line and arrow display option
MarginSpacing	Returns or sets the spacing, the distance between margins
NumberOfMargins	Returns or sets the number of margins
OriginDisplay	Returns or sets the origin display option
PositiveDirection	Returns or sets the positive direction
SymbolAngle	Returns or sets the user defined symbol angle with baseline, if the symbol is not aligned with the baseline
SymbolAspectRatio	Returns or sets the user defined symbol aspect ratio
SymbolHeight	Returns or sets the user defined symbol height
SymbolLength	Returns or sets the user defined symbol length
SymbolScale	Returns or sets the user defined symbol scale
TextOrientation	Returns or sets the text orientation
TextOrientationAngle	Returns or sets the angle if text orientation is AnnotationsTextOrientation.ByAngle
UserDefinedText	Returns or sets the user defined text, if the user defined symbol option is used to display the origin

Methods

Method	Description
Dispose	Frees the object from memory.

Property Detail

AlignSymbolWithBaseline

OrdinateDimensionPreferences.AlignSymbolWithBaseline

Returns or sets the flag indicating whether to align the user defined symbol with the base line

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

Getter Method

Signature AlignSymbolWithBaseline()

Returns:Flag to align user defined symbol with base line Return type:bool

New in version NX4.0.0.

License requirements: None.

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

Setter Method

Signature AlignSymbolWithBaseline(alignSymbolWithBaseline)

Parameters:alignSymbolWithBaseline (bool) – Flag to align user defined symbol with base line

New in version NX4.0.0.

License requirements: None.

DoglegAngle

OrdinateDimensionPreferences.DoglegAngle

Returns or sets the dogleg angle

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

Getter Method

Signature DoglegAngle()

Returns:Dogleg angle Return type:float

New in version NX4.0.0.

License requirements: None.

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

Setter Method

Signature DoglegAngle(doglegAngle)

Parameters:doglegAngle (float) – New dogleg angle

New in version NX4.0.0.

License requirements: None.

DoglegCreationOption

OrdinateDimensionPreferences.DoglegCreationOption

Returns or sets the dogleg creation option

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

Getter Method

Signature DoglegCreationOption()

Returns:Dogleg creation option Return type:NXOpen.Annotations.OrdinateDoglegCreationOption

New in version NX4.0.0.

License requirements: None.

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

Setter Method

Signature DoglegCreationOption(option)

Parameters:option (NXOpen.Annotations.OrdinateDoglegCreationOption) – New dogleg creation option

New in version NX4.0.0.

License requirements: None.

DoglegDefinition

OrdinateDimensionPreferences.DoglegDefinition

Returns or sets the dogleg definition

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

Getter Method

Signature DoglegDefinition()

Returns:Dogleg definition Return type:NXOpen.Annotations.OrdinateDoglegDefinition

New in version NX4.0.0.

License requirements: None.

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

Setter Method

Signature DoglegDefinition(definition)

Parameters:definition (NXOpen.Annotations.OrdinateDoglegDefinition) – New dogleg definition

New in version NX4.0.0.

License requirements: None.

DoglegEndOffset

OrdinateDimensionPreferences.DoglegEndOffset

Returns or sets the dogleg end offset

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

Getter Method

Signature DoglegEndOffset()

Returns:Dogleg end offset Return type:float

New in version NX4.0.0.

License requirements: None.

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

Setter Method

Signature DoglegEndOffset(doglegEndOffset)

Parameters:doglegEndOffset (float) – New dogleg end offset

New in version NX4.0.0.

License requirements: None.

DoglegStartOffset

OrdinateDimensionPreferences.DoglegStartOffset

Returns or sets the dogleg start offset

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

Getter Method

Signature DoglegStartOffset()

Returns:Dogleg start offset Return type:float

New in version NX4.0.0.

License requirements: None.

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

Setter Method

Signature DoglegStartOffset(doglegStartOffset)

Parameters:doglegStartOffset (float) – New dogleg start offset

New in version NX4.0.0.

License requirements: None.

FirstMarginOffset

OrdinateDimensionPreferences.FirstMarginOffset

Returns or sets the first margin offset

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

Getter Method

Signature FirstMarginOffset()

Returns:First margin offset Return type:float

New in version NX4.0.0.

License requirements: None.

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

Setter Method

Signature FirstMarginOffset(firstMarginOffset)

Parameters:firstMarginOffset (float) – New first margin offeset

New in version NX4.0.0.

License requirements: None.

LineArrowDisplayOption

OrdinateDimensionPreferences.LineArrowDisplayOption

Returns or sets the dimension line and arrow display option

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

Getter Method

Signature LineArrowDisplayOption()

Returns:Dimension line and arrow display option Return type:NXOpen.Annotations.OrdinateLineArrowDisplayOption

New in version NX4.0.0.

License requirements: None.

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

Setter Method

Signature LineArrowDisplayOption(option)

Parameters:option (NXOpen.Annotations.OrdinateLineArrowDisplayOption) – New dimension line and arrow display option

New in version NX4.0.0.

License requirements: None.

MarginSpacing

OrdinateDimensionPreferences.MarginSpacing

Returns or sets the spacing, the distance between margins

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

Getter Method

Signature MarginSpacing()

Returns:Margin spacing Return type:float

New in version NX4.0.0.

License requirements: None.

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

Setter Method

Signature MarginSpacing(marginSpacing)

Parameters:marginSpacing (float) – New margin spacing

New in version NX4.0.0.

License requirements: None.

NumberOfMargins

OrdinateDimensionPreferences.NumberOfMargins

Returns or sets the number of margins

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

Getter Method

Signature NumberOfMargins()

Returns:Number of margins Return type:float

New in version NX4.0.0.

License requirements: None.

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

Setter Method

Signature NumberOfMargins(nMargins)

Parameters:nMargins (float) – New number of margins

New in version NX4.0.0.

License requirements: None.

OriginDisplay

OrdinateDimensionPreferences.OriginDisplay

Returns or sets the origin display option

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

Getter Method

Signature OriginDisplay()

Returns:Origin display option Return type:NXOpen.Annotations.OrdinateOriginDisplayOption

New in version NX4.0.0.

License requirements: None.

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

Setter Method

Signature OriginDisplay(option)

Parameters:option (NXOpen.Annotations.OrdinateOriginDisplayOption) – New origin display option

New in version NX4.0.0.

License requirements: None.

PositiveDirection

OrdinateDimensionPreferences.PositiveDirection

Returns or sets the positive direction

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

Getter Method

Signature PositiveDirection()

Returns:Postive direction Return type:NXOpen.Annotations.OrdinatePositiveDirection

New in version NX4.0.0.

License requirements: None.

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

Setter Method

Signature PositiveDirection(option)

Parameters:option (NXOpen.Annotations.OrdinatePositiveDirection) – New postive direction

New in version NX4.0.0.

License requirements: None.

SymbolAngle

OrdinateDimensionPreferences.SymbolAngle

Returns or sets the user defined symbol angle with baseline, if the symbol is not aligned with the baseline

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

Getter Method

Signature SymbolAngle()

Returns:User defined ymbol angle Return type:float

New in version NX4.0.0.

License requirements: None.

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

Setter Method

Signature SymbolAngle(symbolAngle)

Parameters:symbolAngle (float) – New user defined symbol angle

New in version NX4.0.0.

License requirements: None.

SymbolAspectRatio

OrdinateDimensionPreferences.SymbolAspectRatio

Returns or sets the user defined symbol aspect ratio

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

Getter Method

Signature SymbolAspectRatio()

Returns:User defined symbol aspect ratio Return type:float

New in version NX4.0.0.

License requirements: None.

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

Setter Method

Signature SymbolAspectRatio(symbolAspectRatio)

Parameters:symbolAspectRatio (float) – New user defined symbol aspect ratio

New in version NX4.0.0.

License requirements: None.

SymbolHeight

OrdinateDimensionPreferences.SymbolHeight

Returns or sets the user defined symbol height

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

Getter Method

Signature SymbolHeight()

Returns:User defined symbol height Return type:float

New in version NX4.0.0.

License requirements: None.

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

Setter Method

Signature SymbolHeight(symbolHeight)

Parameters:symbolHeight (float) – New user defined symbol height

New in version NX4.0.0.

License requirements: None.

SymbolLength

OrdinateDimensionPreferences.SymbolLength

Returns or sets the user defined symbol length

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

Getter Method

Signature SymbolLength()

Returns:User defined symbol length Return type:float

New in version NX4.0.0.

License requirements: None.

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

Setter Method

Signature SymbolLength(symbolLength)

Parameters:symbolLength (float) – New user defined symbol length

New in version NX4.0.0.

License requirements: None.

SymbolScale

OrdinateDimensionPreferences.SymbolScale

Returns or sets the user defined symbol scale

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

Getter Method

Signature SymbolScale()

Returns:User defined symbol scale Return type:float

New in version NX4.0.0.

License requirements: None.

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

Setter Method

Signature SymbolScale(symbolScale)

Parameters:symbolScale (float) – New user defiend symbol scale

New in version NX4.0.0.

License requirements: None.

TextOrientation

OrdinateDimensionPreferences.TextOrientation

Returns or sets the text orientation

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

Getter Method

Signature TextOrientation()

Returns:Dimension text orientation Return type:NXOpen.Annotations.TextOrientation

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature TextOrientation(orientation)

Parameters:orientation (NXOpen.Annotations.TextOrientation) – New dimension text orientation

New in version NX5.0.0.

License requirements: None.

TextOrientationAngle

OrdinateDimensionPreferences.TextOrientationAngle

Returns or sets the angle if text orientation is AnnotationsTextOrientation.ByAngle

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

Getter Method

Signature TextOrientationAngle()

Returns:Dimension text orientation angle Return type:float

New in version NX5.0.0.

License requirements: None.

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

Setter Method

Signature TextOrientationAngle(textOrientationAngle)

Parameters:textOrientationAngle (float) – New dimension text orienation angle

New in version NX5.0.0.

License requirements: None.

UserDefinedText

OrdinateDimensionPreferences.UserDefinedText

Returns or sets the user defined text, if the user defined symbol option is used to display the origin

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

Getter Method

Signature UserDefinedText()

Returns:User defined text Return type:str

New in version NX4.0.0.

License requirements: None.

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

Setter Method

Signature UserDefinedText(userDefinedText)

Parameters:userDefinedText (str) – New user defined text

New in version NX4.0.0.

License requirements: None.

Method Detail

Dispose

OrdinateDimensionPreferences.Dispose

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.

Signature Dispose()

New in version NX4.0.0.

License requirements: None.