AnnotationManager Class¶
-
class
NXOpen.Annotations.
AnnotationManager
¶ Bases:
object
Represents an object that manages annotation and PMI (Product and Manufacturing Information) display instance objects.
This class contains the collection objects for creating and iterating over annotations and PMI display instances. To obtain an instance of this class, refer to
NXOpen.BasePart
New in version NX3.0.0.
Properties¶
Property | Description |
---|---|
CurrentSbfFile | Returns or sets the symbol font definition file. |
WeldStandard | Returns or sets the weld standard for the part file. |
Preferences | Global annotation preferences |
PmiFilters | PmiFilter collection |
Fcfs | Fcf collection |
Datums | Datum collection |
DatumTargets | DatumTarget collection |
DraftingDatumTargets | DraftingDatumTarget collection |
Welds | Weld collection |
CustomSymbols | CustomSymbol collection |
IdSymbols | IdSymbol collection |
BusinessModifiers | BusinessModifier collection |
OrdinateMargins | OrdinateMargin collection |
DimensionSets | DimensionSet collection |
Centerlines | Centerlines collection |
IntersectionSymbols | IntersectionSymbol collection |
TargetPoints | TargetPoint collection |
OffsetCenterPoints | OffsetCenterPoint collection |
Hatches | Hatch collection |
DraftingSurfaceFinishSymbols | Drafting surface finish collection |
PartSymbolFolders | Part Symbol Folder collection |
TableSections | Table section collection |
Tables | Table collection |
HoleTables | Hole Table collection |
PmiTableSections | PMI Table collection |
FrameBars | Frame bar collection |
SymbolFiles | Library Symbol collection |
DraftingImages | Drafting Image collection |
BendTables | Bend Table collection |
Methods¶
Method | Description |
---|---|
ConvertToGdt | Converts a simple drafting aid into a GDT by creating a new GDT using the text, origin, and preferences from the drafting aid. |
ConvertToIdSymbol | Converts a simple drafting aid into an ID symbol by creating a new ID symbol using the text, origin, and preferences from the drafting aid. |
ConvertToLabel | Converts a simple drafting aid into a label by creating a new label using the text, origin, and preferences from the drafting aid. |
ConvertToLineWeld | Converts a simple drafting aid into a line weld by creating a new line weld using the text, origin, and preferences from the drafting aid. |
ConvertToNote | Converts a simple drafting aid into a note by creating a new note using the text, origin, and preferences from the drafting aid. |
CreateAssociateDimensionBuilder | Creates the Dimension Associativity builder |
CreateAssociativeText | Creates a NXOpen.Annotations.AssociativeText . |
CreateAssociativityBuilder | Creates the Dimension Associativity builder |
CreateComponentData | Creates a NXOpen.Annotations.ComponentData for an annotation. |
CreateCompoundDatumReferenceBuilder | Creates a new compound datum dialog |
CreateDatumReferenceBuilder | Creates a NXOpen.Annotations.DatumReferenceBuilder |
CreateDraftingDatumTargetBuilder | Creates a NXOpen.Annotations.DraftingDatumTargetBuilder |
CreateDraftingFeatureControlFrameBuilder | Creates a NXOpen.Annotations.DraftingFeatureControlFrameBuilder |
CreateDraftingNoteBuilder | Creates a NXOpen.Annotations.DraftingNoteBuilder |
CreateEditLeaderBuilder | Creates a NXOpen.Annotations.EditLeaderBuilder |
CreateEmptyDatumReferenceBuilder | Creates a new empty datum reference builder |
CreateFeatureControlFrameDataBuilder | Creates a NXOpen.Annotations.FeatureControlFrameDataBuilder |
CreateFeatureControlFrameIndicatorBuilder | Creates a NXOpen.Annotations.FeatureControlFrameIndicatorBuilder |
CreateGdt | Creates a GDT symbol |
CreateLabel | Creates a label. |
CreateLeaderData | Creates a NXOpen.Annotations.LeaderData |
CreateNote | Creates a note |
CreatePmiDatumTargetBuilder | Creates a NXOpen.Annotations.PmiDatumTargetBuilder |
CreatePmiFeatureControlFrameBuilder | Creates a NXOpen.Annotations.PmiFeatureControlFrameBuilder |
CreatePmiNoteBuilder | Creates a NXOpen.Annotations.PmiNoteBuilder |
CreatePmiTrackingPropertiesBuilder | Creates a NXOpen.Annotations.PmiTrackingPropertiesBuilder . |
CreateQueryPmiBuilder | Creates the Query PMI builder |
CreateQueryView | Creates a model view displaying the given PMI symbols. |
GetDefaultAnnotationPlane | Returns the default annotation plane for the specified part |
GetStandardSymbolTextFont | Returns the font to use for displaying symbols with standard fonts. |
LoadSymbolFontFromSbfFile | Loads a symbol font from the current symbol font definition file |
MakePmi | Flag the annotation as PMI object. |
NewAppendedText | Creates a new AppendedText object |
NewAssociativity | Creates a new Associativity object |
NewDatumReference | Creates a new DatumReference object |
NewDimensionData | Creates new DimensionData object |
NewFcfFrame | Creates a new FcfFrame object |
NewFcfFrameData | Creates a new Fcf Frame Data object |
NewLeaderBundle | Constructs a new LeaderBundle object |
NewMasterCustomSymbolData | Creates a new MasterCustomSymbolData object |
NewPmiData | Creates a new PmiData object |
NewUserSymbolPreferences | Constructs a new UserSymbolPreferences object |
QueryPmiFromGeometry | Finds all PMI symbols that reference the given geometry as an associated object. |
ReadAllSymbolNamesFromSbfFile | Reads the names of all symbol fonts in the current symbol font definition file |
RemovePmi | Remove PMI flag from annotation. |
SaveUserSymbolPart | Save a new master Custom Symbol file. |
SetMasterSymbolNameInQaf | This method writes master custom symbol name to the predefined quick access folder and saves the part. |
SetParallelToScreen | Sets the parallel to screen status on each input annotation. |
SetStandardSymbolTextFont |
Property Detail¶
CurrentSbfFile¶
-
AnnotationManager.
CurrentSbfFile
¶ Returns or sets the symbol font definition file.
LoadSymbolFontFromSbfFile()
will read from this file-------------------------------------
Getter Method
Signature
CurrentSbfFile
Returns: Return type: str New in version NX3.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CurrentSbfFile
Parameters: fileName (str) – New in version NX3.0.0.
License requirements: None.
WeldStandard¶
-
AnnotationManager.
WeldStandard
¶ Returns or sets the weld standard for the part file.
-------------------------------------
Getter Method
Signature
WeldStandard
Returns: Weld standard Return type: NXOpen.Annotations.WeldStandard
New in version NX7.5.4.
License requirements: None.
-------------------------------------
Setter Method
Signature
WeldStandard
Parameters: standard ( NXOpen.Annotations.WeldStandard
) – Weld standardNew in version NX7.5.4.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
Preferences¶
-
AnnotationManager.
Preferences
¶ Global annotation preferences
Signature
Preferences
New in version NX3.0.0.
Returns: Return type: NXOpen.Preferences.AnnotationPreferences
PmiFilters¶
-
AnnotationManager.
PmiFilters
¶ PmiFilter collection
Signature
PmiFilters
New in version NX3.0.0.
Returns: Return type: NXOpen.Annotations.PmiFilterCollection
Fcfs¶
-
AnnotationManager.
Fcfs
¶ Fcf collection
Signature
Fcfs
New in version NX3.0.0.
Returns: Return type: NXOpen.Annotations.FcfCollection
Datums¶
-
AnnotationManager.
Datums
¶ Datum collection
Signature
Datums
New in version NX3.0.0.
Returns: Return type: NXOpen.Annotations.GdtDatumCollection
DatumTargets¶
-
AnnotationManager.
DatumTargets
¶ DatumTarget collection
Signature
DatumTargets
New in version NX3.0.0.
Returns: Return type: NXOpen.Annotations.DatumTargetCollection
DraftingDatumTargets¶
-
AnnotationManager.
DraftingDatumTargets
¶ DraftingDatumTarget collection
Signature
DraftingDatumTargets
New in version NX8.0.1.
Returns: Return type: NXOpen.Annotations.DraftingDatumTargetCollection
Welds¶
-
AnnotationManager.
Welds
¶ Weld collection
Signature
Welds
New in version NX3.0.0.
Returns: Return type: NXOpen.Annotations.WeldCollection
CustomSymbols¶
-
AnnotationManager.
CustomSymbols
¶ CustomSymbol collection
Signature
CustomSymbols
New in version NX3.0.0.
Returns: Return type: NXOpen.Annotations.CustomSymbolCollection
IdSymbols¶
-
AnnotationManager.
IdSymbols
¶ IdSymbol collection
Signature
IdSymbols
New in version NX3.0.0.
Returns: Return type: NXOpen.Annotations.IdSymbolCollection
BusinessModifiers¶
-
AnnotationManager.
BusinessModifiers
¶ BusinessModifier collection
Signature
BusinessModifiers
New in version NX3.0.0.
Returns: Return type: NXOpen.Annotations.BusinessModifierCollection
OrdinateMargins¶
-
AnnotationManager.
OrdinateMargins
¶ OrdinateMargin collection
Signature
OrdinateMargins
New in version NX3.0.0.
Returns: Return type: NXOpen.Annotations.OrdinateMarginCollection
DimensionSets¶
-
AnnotationManager.
DimensionSets
¶ DimensionSet collection
Signature
DimensionSets
New in version NX3.0.0.
Returns: Return type: NXOpen.Annotations.DimensionSetCollection
Centerlines¶
-
AnnotationManager.
Centerlines
¶ Centerlines collection
Signature
Centerlines
New in version NX3.0.0.
Returns: Return type: NXOpen.Annotations.CenterlineCollection
IntersectionSymbols¶
-
AnnotationManager.
IntersectionSymbols
¶ IntersectionSymbol collection
Signature
IntersectionSymbols
New in version NX3.0.0.
Returns: Return type: NXOpen.Annotations.IntersectionSymbolCollection
TargetPoints¶
-
AnnotationManager.
TargetPoints
¶ TargetPoint collection
Signature
TargetPoints
New in version NX3.0.0.
Returns: Return type: NXOpen.Annotations.TargetPointCollection
OffsetCenterPoints¶
-
AnnotationManager.
OffsetCenterPoints
¶ OffsetCenterPoint collection
Signature
OffsetCenterPoints
New in version NX3.0.0.
Returns: Return type: NXOpen.Annotations.OffsetCenterPointCollection
Hatches¶
-
AnnotationManager.
Hatches
¶ Hatch collection
Signature
Hatches
New in version NX3.0.0.
Returns: Return type: NXOpen.Annotations.HatchCollection
DraftingSurfaceFinishSymbols¶
-
AnnotationManager.
DraftingSurfaceFinishSymbols
¶ Drafting surface finish collection
Signature
DraftingSurfaceFinishSymbols
New in version NX7.5.0.
Returns: Return type: NXOpen.Annotations.DraftingSurfaceFinishCollection
PartSymbolFolders¶
-
AnnotationManager.
PartSymbolFolders
¶ Part Symbol Folder collection
Signature
PartSymbolFolders
New in version NX7.5.0.
Returns: Return type: NXOpen.Annotations.PartSymbolFolderCollection
TableSections¶
-
AnnotationManager.
TableSections
¶ Table section collection
Signature
TableSections
New in version NX8.0.0.
Returns: Return type: NXOpen.Annotations.TableSectionCollection
Tables¶
-
AnnotationManager.
Tables
¶ Table collection
Signature
Tables
New in version NX8.0.0.
Returns: Return type: NXOpen.Annotations.TableCollection
HoleTables¶
-
AnnotationManager.
HoleTables
¶ Hole Table collection
Signature
HoleTables
New in version NX9.0.0.
Returns: Return type: NXOpen.Annotations.HoleTableCollection
PmiTableSections¶
-
AnnotationManager.
PmiTableSections
¶ PMI Table collection
Signature
PmiTableSections
New in version NX12.0.0.
Returns: Return type: NXOpen.Annotations.PmiTableSectionCollection
FrameBars¶
-
AnnotationManager.
FrameBars
¶ Frame bar collection
Signature
FrameBars
New in version NX8.0.0.
Returns: Return type: NXOpen.Annotations.FrameBarCollection
SymbolFiles¶
-
AnnotationManager.
SymbolFiles
¶ Library Symbol collection
Signature
SymbolFiles
New in version NX8.0.0.
Returns: Return type: NXOpen.Annotations.SymbolFileCollection
DraftingImages¶
-
AnnotationManager.
DraftingImages
¶ Drafting Image collection
Signature
DraftingImages
New in version NX9.0.0.
Returns: Return type: NXOpen.Annotations.DraftingImageCollection
BendTables¶
-
AnnotationManager.
BendTables
¶ Bend Table collection
Signature
BendTables
New in version NX9.0.0.
Returns: Return type: NXOpen.Annotations.BendTableCollection
Method Detail¶
ConvertToGdt¶
-
AnnotationManager.
ConvertToGdt
¶ Converts a simple drafting aid into a GDT by creating a new GDT using the text, origin, and preferences from the drafting aid.
If there are other annotations that are dependent on the drafting aid, (for example, a label that has a leader attached to the drafting aid), those dependencies will NOT be copied over.
Signature
ConvertToGdt(draftingAid, keepDraftingAid, leader)
Parameters: - draftingAid (
NXOpen.Annotations.SimpleDraftingAid
) – the drafting aid to convert - keepDraftingAid (bool) – whether to keep the drafting aid. If false, the drafting aid will be deleted
- leader (
NXOpen.Annotations.LeaderBundle
) – specifies the leaders for the new GDT
Returns: the new GDT
Return type: New in version NX3.0.0.
License requirements: drafting (“DRAFTING”)
- draftingAid (
ConvertToIdSymbol¶
-
AnnotationManager.
ConvertToIdSymbol
¶ Converts a simple drafting aid into an ID symbol by creating a new ID symbol using the text, origin, and preferences from the drafting aid.
If there are other annotations that are dependent on the drafting aid, (for example, a label that has a leader attached to the drafting aid), those dependencies will NOT be copied over.
Signature
ConvertToIdSymbol(draftingAid, keepDraftingAid, leader)
Parameters: - draftingAid (
NXOpen.Annotations.SimpleDraftingAid
) – the drafting aid to convert - keepDraftingAid (bool) – whether to keep the drafting aid. If false, the drafting aid will be deleted
- leader (
NXOpen.Annotations.LeaderBundle
) – specifies the leaders for the new ID Symbol
Returns: the new ID Symbol
Return type: New in version NX4.0.0.
License requirements: drafting (“DRAFTING”)
- draftingAid (
ConvertToLabel¶
-
AnnotationManager.
ConvertToLabel
¶ Converts a simple drafting aid into a label by creating a new label using the text, origin, and preferences from the drafting aid.
If there are other annotations that are dependent on the drafting aid, (for example, a label that has a leader attached to the drafting aid), those dependencies will NOT be copied over.
Signature
ConvertToLabel(draftingAid, keepDraftingAid, leader)
Parameters: - draftingAid (
NXOpen.Annotations.SimpleDraftingAid
) – the drafting aid to convert - keepDraftingAid (bool) – whether to keep the drafting aid. If false, the drafting aid will be deleted
- leader (
NXOpen.Annotations.LeaderBundle
) – specifies the leaders for the new label. The leader type must be Plain, Around, PlainAligned, or AroundAligned. To use any other type of leader, you must create a GDT instead.
Returns: the new label
Return type: New in version NX3.0.0.
License requirements: drafting (“DRAFTING”)
- draftingAid (
ConvertToLineWeld¶
-
AnnotationManager.
ConvertToLineWeld
¶ Converts a simple drafting aid into a line weld by creating a new line weld using the text, origin, and preferences from the drafting aid.
If there are other annotations that are dependent on the drafting aid, (for example, a line weld that has a leader attached to the drafting aid), those dependencies will NOT be copied over.
Signature
ConvertToLineWeld(draftingAid, keepDraftingAid, leader)
Parameters: - draftingAid (
NXOpen.Annotations.LineWeld
) – the drafting aid to convert - keepDraftingAid (bool) – whether to keep the drafting aid. If false, the drafting aid will be deleted
- leader (
NXOpen.Annotations.LeaderBundle
) – specifies the leaders for the new label. The leader type must be Plain, Around, PlainAligned, or AroundAligned. To use any other type of leader, you must create a GDT instead.
Returns: the new line weld
Return type: New in version NX3.0.0.
License requirements: drafting (“DRAFTING”)
- draftingAid (
ConvertToNote¶
-
AnnotationManager.
ConvertToNote
¶ Converts a simple drafting aid into a note by creating a new note using the text, origin, and preferences from the drafting aid.
If there are other annotations that are dependent on the drafting aid, (for example, a label that has a leader attached to the drafting aid), those dependencies will NOT be copied over.
Signature
ConvertToNote(draftingAid, keepDraftingAid)
Parameters: - draftingAid (
NXOpen.Annotations.SimpleDraftingAid
) – the drafting aid to convert - keepDraftingAid (bool) – whether to keep the drafting aid. If false, the drafting aid will be deleted
Returns: the new note
Return type: New in version NX3.0.0.
License requirements: drafting (“DRAFTING”)
- draftingAid (
CreateAssociateDimensionBuilder¶
-
AnnotationManager.
CreateAssociateDimensionBuilder
¶ Creates the Dimension Associativity builder
Signature
CreateAssociateDimensionBuilder(dimension)
Parameters: dimension ( NXOpen.Annotations.Dimension
) –NXOpen.Annotations.Dimension
to be editedReturns: AssociateDimensionBuilder object Return type: NXOpen.Annotations.AssociateDimensionBuilder
New in version NX5.0.0.
License requirements: None.
CreateAssociativeText¶
-
AnnotationManager.
CreateAssociativeText
¶ Creates a
NXOpen.Annotations.AssociativeText
.The
NXOpen.Annotations.AssociativeText
instance must be deleted after its use.Signature
CreateAssociativeText()
Returns: Return type: NXOpen.Annotations.AssociativeText
New in version NX8.0.0.
License requirements: None.
CreateAssociativityBuilder¶
-
AnnotationManager.
CreateAssociativityBuilder
¶ Creates the Dimension Associativity builder
Signature
CreateAssociativityBuilder(dimension, assocIndex)
Parameters: - dimension (
NXOpen.Annotations.Dimension
) –NXOpen.Annotations.Dimension
to be edited - assocIndex (int) – Associativity index
Returns: AssociateDimensionBuilder object
Return type: New in version NX5.0.0.
License requirements: None.
- dimension (
CreateComponentData¶
-
AnnotationManager.
CreateComponentData
¶ Creates a
NXOpen.Annotations.ComponentData
for an annotation.Signature
CreateComponentData(annotationTag)
Parameters: annotationTag ( NXOpen.Annotations.Annotation
) – the annotation whose component data will be available with this objectReturns: Return type: NXOpen.Annotations.ComponentData
New in version NX6.0.2.
License requirements: None.
CreateCompoundDatumReferenceBuilder¶
-
AnnotationManager.
CreateCompoundDatumReferenceBuilder
¶ Creates a new compound datum dialog
Signature
CreateCompoundDatumReferenceBuilder()
Returns: Return type: NXOpen.Annotations.CompoundDatumReferenceBuilder
New in version NX5.0.0.
License requirements: geometric_tol (“GDT”)
CreateDatumReferenceBuilder¶
-
AnnotationManager.
CreateDatumReferenceBuilder
¶ Creates a
NXOpen.Annotations.DatumReferenceBuilder
Signature
CreateDatumReferenceBuilder(datumReference)
Parameters: datumReference ( NXOpen.Annotations.FcfDatumReference
) – the datum reference to be edited, if None, then create an fcf symbolReturns: Return type: NXOpen.Annotations.DatumReferenceBuilder
New in version NX6.0.0.
License requirements: None.
CreateDraftingDatumTargetBuilder¶
-
AnnotationManager.
CreateDraftingDatumTargetBuilder
¶ Creates a
NXOpen.Annotations.DraftingDatumTargetBuilder
Signature
CreateDraftingDatumTargetBuilder(datumTarget)
Parameters: datumTarget ( NXOpen.Annotations.DraftingDatumTarget
) – Datum to editReturns: Return type: NXOpen.Annotations.DraftingDatumTargetBuilder
New in version NX6.0.0.
License requirements: None.
CreateDraftingFeatureControlFrameBuilder¶
-
AnnotationManager.
CreateDraftingFeatureControlFrameBuilder
¶ Creates a
NXOpen.Annotations.DraftingFeatureControlFrameBuilder
Signature
CreateDraftingFeatureControlFrameBuilder(fcf)
Parameters: fcf ( NXOpen.Annotations.Gdt
) – the fcf symbol to be edited, if None, then create an fcf symbolReturns: Return type: NXOpen.Annotations.DraftingFeatureControlFrameBuilder
New in version NX6.0.0.
License requirements: None.
CreateDraftingNoteBuilder¶
-
AnnotationManager.
CreateDraftingNoteBuilder
¶ Creates a
NXOpen.Annotations.DraftingNoteBuilder
Signature
CreateDraftingNoteBuilder(annotation)
Parameters: annotation ( NXOpen.Annotations.SimpleDraftingAid
) –NXOpen.Annotations.SimpleDraftingAid
to be editedReturns: Return type: NXOpen.Annotations.DraftingNoteBuilder
New in version NX6.0.0.
License requirements: None.
CreateEditLeaderBuilder¶
-
AnnotationManager.
CreateEditLeaderBuilder
¶ Creates a
NXOpen.Annotations.EditLeaderBuilder
Signature
CreateEditLeaderBuilder(tableTag)
Parameters: tableTag ( NXOpen.DisplayableObject
) – the table object to editReturns: Return type: NXOpen.Annotations.EditLeaderBuilder
New in version NX6.0.1.
License requirements: drafting (“DRAFTING”)
CreateEmptyDatumReferenceBuilder¶
-
AnnotationManager.
CreateEmptyDatumReferenceBuilder
¶ Creates a new empty datum reference builder
Signature
CreateEmptyDatumReferenceBuilder()
Returns: Return type: NXOpen.Annotations.DatumReferenceBuilder
New in version NX9.0.0.
License requirements: None.
CreateFeatureControlFrameDataBuilder¶
-
AnnotationManager.
CreateFeatureControlFrameDataBuilder
¶ Creates a
NXOpen.Annotations.FeatureControlFrameDataBuilder
Signature
CreateFeatureControlFrameDataBuilder(frame)
Parameters: frame ( NXOpen.Annotations.FeatureControlFrameData
) – the fcf symbol to be edited, if None, then create an fcf symbolReturns: Return type: NXOpen.Annotations.FeatureControlFrameDataBuilder
New in version NX6.0.0.
License requirements: None.
CreateFeatureControlFrameIndicatorBuilder¶
-
AnnotationManager.
CreateFeatureControlFrameIndicatorBuilder
¶ Creates a
NXOpen.Annotations.FeatureControlFrameIndicatorBuilder
Signature
CreateFeatureControlFrameIndicatorBuilder()
Returns: Return type: NXOpen.Annotations.FeatureControlFrameIndicatorBuilder
New in version NX12.0.0.
License requirements: None.
CreateGdt¶
-
AnnotationManager.
CreateGdt
¶ Creates a GDT symbol
Signature
CreateGdt(textLines, origin, letteringPreferences, userSymbolPreferences, lineArrowPreferences, alwaysVertical, leader)
Parameters: - textLines (list of str) – text for the GDT
- origin (
NXOpen.Point3d
) – origin for the GDT - letteringPreferences (
NXOpen.Annotations.LetteringPreferences
) – lettering preferences. If None, the global lettering preferences will be used - userSymbolPreferences (
NXOpen.Annotations.UserSymbolPreferences
) – user symbol preferences. If None, the scale and aspect ratio will be set to 1.0 - lineArrowPreferences (
NXOpen.Annotations.LineAndArrowPreferences
) – line and arrow preferences. If None, the global line and arrow preferences will be used - alwaysVertical (bool) –
- leader (
NXOpen.Annotations.LeaderBundle
) – specifies the leaders for the GDT. The following leader types are not valid for GDT symbols: PlainNostub and AlignedNostub
Returns: the new GDT
Return type: New in version NX3.0.0.
License requirements: drafting (“DRAFTING”)
CreateLabel¶
-
AnnotationManager.
CreateLabel
¶ Creates a label.
The leader type must be Plain, Around, PlainAligned, or AroundAligned. To use any other type of leader, you must create a GDT instead.
Signature
CreateLabel(textLines, origin, letteringPreferences, userSymbolPreferences, lineArrowPreferences, leader)
Parameters: - textLines (list of str) – text for the label
- origin (
NXOpen.Point3d
) – origin for the label - letteringPreferences (
NXOpen.Annotations.LetteringPreferences
) – lettering preferences. If None, the global lettering preferences will be used - userSymbolPreferences (
NXOpen.Annotations.UserSymbolPreferences
) – user symbol preferences. If None, the scale and aspect ratio will be set to 1.0 - lineArrowPreferences (
NXOpen.Annotations.LineAndArrowPreferences
) – line and arrow preferences. If None, the global line and arrow preferences will be used - leader (
NXOpen.Annotations.LeaderBundle
) – specifies the leaders for the label
Returns: the new label
Return type: New in version NX3.0.0.
License requirements: drafting (“DRAFTING”)
CreateLeaderData¶
-
AnnotationManager.
CreateLeaderData
¶ Creates a
NXOpen.Annotations.LeaderData
Signature
CreateLeaderData()
Returns: Return type: NXOpen.Annotations.LeaderData
New in version NX6.0.0.
License requirements: None.
CreateNote¶
-
AnnotationManager.
CreateNote
¶ Creates a note
Signature
CreateNote(textLines, origin, orientation, letteringPreferences, userSymbolPreferences)
Parameters: - textLines (list of str) – text for the note
- origin (
NXOpen.Point3d
) – origin for the note - orientation (
NXOpen.AxisOrientation
) – determines whether the note will be horizontal or vertical - letteringPreferences (
NXOpen.Annotations.LetteringPreferences
) – lettering preferences. If None, the global lettering preferences will be used - userSymbolPreferences (
NXOpen.Annotations.UserSymbolPreferences
) – user symbol preferences. If None, the scale and aspect ratio will be set to 1.0
Returns: the new note
Return type: New in version NX3.0.0.
License requirements: drafting (“DRAFTING”)
CreatePmiDatumTargetBuilder¶
-
AnnotationManager.
CreatePmiDatumTargetBuilder
¶ Creates a
NXOpen.Annotations.PmiDatumTargetBuilder
Signature
CreatePmiDatumTargetBuilder(datumTarget)
Parameters: datumTarget ( NXOpen.Annotations.DatumTarget
) – Datum to editReturns: Return type: NXOpen.Annotations.PmiDatumTargetBuilder
New in version NX6.0.0.
License requirements: None.
CreatePmiFeatureControlFrameBuilder¶
-
AnnotationManager.
CreatePmiFeatureControlFrameBuilder
¶ Creates a
NXOpen.Annotations.PmiFeatureControlFrameBuilder
Signature
CreatePmiFeatureControlFrameBuilder(fcf)
Parameters: fcf ( NXOpen.Annotations.Fcf
) – the fcf symbol to be edited, if None, then create an fcf symbolReturns: Return type: NXOpen.Annotations.PmiFeatureControlFrameBuilder
New in version NX6.0.0.
License requirements: None.
CreatePmiNoteBuilder¶
-
AnnotationManager.
CreatePmiNoteBuilder
¶ Creates a
NXOpen.Annotations.PmiNoteBuilder
Signature
CreatePmiNoteBuilder(annotation)
Parameters: annotation ( NXOpen.Annotations.SimpleDraftingAid
) –NXOpen.Annotations.SimpleDraftingAid
to be editedReturns: Return type: NXOpen.Annotations.PmiNoteBuilder
New in version NX6.0.0.
License requirements: None.
CreatePmiTrackingPropertiesBuilder¶
-
AnnotationManager.
CreatePmiTrackingPropertiesBuilder
¶ Creates a
NXOpen.Annotations.PmiTrackingPropertiesBuilder
.Signature
CreatePmiTrackingPropertiesBuilder()
Returns: PmiTrackingPropertiesBuilder object Return type: NXOpen.Annotations.PmiTrackingPropertiesBuilder
New in version NX10.0.0.
License requirements: drafting (“DRAFTING”)
CreateQueryPmiBuilder¶
-
AnnotationManager.
CreateQueryPmiBuilder
¶ Creates the Query PMI builder
Signature
CreateQueryPmiBuilder()
Returns: Return type: NXOpen.Annotations.QueryPmiBuilder
New in version NX5.0.0.
License requirements: geometric_tol (“GDT”)
CreateQueryView¶
-
AnnotationManager.
CreateQueryView
¶ Creates a model view displaying the given PMI symbols.
This method would ordinarily be invoked with the PMI symbols resulting from a call to
NXOpen.Annotations.AnnotationManager.QueryPmiFromGeometry()
.Signature
CreateQueryView(pmiSymbols)
Parameters: pmiSymbols (list of NXOpen.Annotations.Annotation
) – List of PMI symbols, ordinarily from a geometry queryReturns: Model view displaying the given PMI symbols Return type: NXOpen.ModelingView
New in version NX5.0.0.
License requirements: geometric_tol (“GDT”)
GetDefaultAnnotationPlane¶
-
AnnotationManager.
GetDefaultAnnotationPlane
¶ Returns the default annotation plane for the specified part
Signature
GetDefaultAnnotationPlane(jaDefaultPlane)
Parameters: jaDefaultPlane ( NXOpen.Annotations.PmiDefaultPlane
) –Returns: Return type: NXOpen.Xform
New in version NX4.0.0.
License requirements: None.
GetStandardSymbolTextFont¶
-
AnnotationManager.
GetStandardSymbolTextFont
¶ Returns the font to use for displaying symbols with standard fonts.
Signature
GetStandardSymbolTextFont()
Returns: The name of the text font to use for displaying a symbol when using a standard font. Return type: str New in version NX8.5.0.
License requirements: None.
LoadSymbolFontFromSbfFile¶
-
AnnotationManager.
LoadSymbolFontFromSbfFile
¶ Loads a symbol font from the current symbol font definition file
Signature
LoadSymbolFontFromSbfFile(symbolName)
Parameters: symbolName (str) – name of the symbol Returns: a tuple Return type: A tuple consisting of (symbolFont, symbolWidth, symbolHeight). symbolFont is a NXOpen.SymbolFont
. symbolWidth is a float. symbolHeight is a float.New in version NX3.0.0.
License requirements: None.
MakePmi¶
-
AnnotationManager.
MakePmi
¶ Flag the annotation as PMI object.
Once flagged, the annotation particiaptes in all PMI specific behaviors, so you can manage it from Part Navigator, inherit on a drawing view, control its display in different model views etc..
Signature
MakePmi(annotation)
Parameters: annotation ( NXOpen.Annotations.Annotation
) –NXOpen.Annotations.Annotation
to be editedNew in version NX6.0.0.
License requirements: geometric_tol (“GDT”)
NewAppendedText¶
-
AnnotationManager.
NewAppendedText
¶ Creates a new AppendedText object
Signature
NewAppendedText()
Returns: New AppendedText object Return type: NXOpen.Annotations.AppendedText
New in version NX4.0.0.
License requirements: None.
NewAssociativity¶
-
AnnotationManager.
NewAssociativity
¶ Creates a new Associativity object
Signature
NewAssociativity()
Returns: New Associativity object Return type: NXOpen.Annotations.Associativity
New in version NX4.0.0.
License requirements: None.
NewDatumReference¶
-
AnnotationManager.
NewDatumReference
¶ Creates a new DatumReference object
Signature
NewDatumReference()
Returns: New DatumReference object Return type: NXOpen.Annotations.DatumReference
New in version NX4.0.0.
License requirements: None.
NewDimensionData¶
-
AnnotationManager.
NewDimensionData
¶ Creates new DimensionData object
Signature
NewDimensionData()
Returns: New DimensionData object Return type: NXOpen.Annotations.DimensionData
New in version NX4.0.0.
License requirements: None.
NewFcfFrame¶
-
AnnotationManager.
NewFcfFrame
¶ Creates a new FcfFrame object
Signature
NewFcfFrame()
Returns: New FcfFrame object Return type: NXOpen.Annotations.FcfFrame
New in version NX4.0.0.
License requirements: None.
NewFcfFrameData¶
-
AnnotationManager.
NewFcfFrameData
¶ Creates a new Fcf Frame Data object
Signature
NewFcfFrameData()
Returns: New Fcf Frame Data object Return type: NXOpen.Annotations.FcfFrameData
New in version NX5.0.0.
License requirements: None.
NewLeaderBundle¶
-
AnnotationManager.
NewLeaderBundle
¶ Constructs a new LeaderBundle object
Signature
NewLeaderBundle()
Returns: Return type: NXOpen.Annotations.LeaderBundle
New in version NX3.0.0.
License requirements: None.
NewMasterCustomSymbolData¶
-
AnnotationManager.
NewMasterCustomSymbolData
¶ Creates a new MasterCustomSymbolData object
Signature
NewMasterCustomSymbolData()
Returns: New MasterCustomSymbolData object Return type: NXOpen.Annotations.MasterCustomSymbolData
New in version NX6.0.0.
Deprecated since version NX9.0.0: Use
NXOpen.Annotations.MasterSymbolBuilder
instead.License requirements: None.
NewPmiData¶
-
AnnotationManager.
NewPmiData
¶ Creates a new PmiData object
Signature
NewPmiData()
Returns: New PMIData object Return type: NXOpen.Annotations.PmiData
New in version NX4.0.0.
License requirements: None.
NewUserSymbolPreferences¶
-
AnnotationManager.
NewUserSymbolPreferences
¶ Constructs a new UserSymbolPreferences object
Signature
NewUserSymbolPreferences(type, lengthOrScale, heightOrAspectRatio)
Parameters: - type (
NXOpen.Annotations.UserSymbolPreferencesSizeType
) – Whether to use length and height or scale and aspect ratio - lengthOrScale (float) – Length or scale
- heightOrAspectRatio (float) – Height or aspect ratio
Returns: the new object
Return type: New in version NX3.0.0.
License requirements: None.
- type (
QueryPmiFromGeometry¶
-
AnnotationManager.
QueryPmiFromGeometry
¶ Finds all PMI symbols that reference the given geometry as an associated object.
The geometry types supported are limited to those supported by
NXOpen.Annotations.AssociatedObject
.Signature
QueryPmiFromGeometry(geom)
Parameters: geom (list of NXOpen.DisplayableObject
) – Geometry to be searchedReturns: PMI symbols that reference the geometry Return type: list of NXOpen.Annotations.Annotation
New in version NX5.0.0.
License requirements: geometric_tol (“GDT”)
ReadAllSymbolNamesFromSbfFile¶
-
AnnotationManager.
ReadAllSymbolNamesFromSbfFile
¶ Reads the names of all symbol fonts in the current symbol font definition file
Signature
ReadAllSymbolNamesFromSbfFile()
Returns: array of names of all symbol fonts in the file :rtype: list of str
New in version NX3.0.0.
License requirements: None.
RemovePmi¶
-
AnnotationManager.
RemovePmi
¶ Remove PMI flag from annotation.
After the flag is removed, the annotation can’t be managed as PMI. However it retains all its properties.
Signature
RemovePmi(annotation)
Parameters: annotation ( NXOpen.Annotations.Annotation
) –NXOpen.Annotations.Annotation
to be editedNew in version NX6.0.0.
License requirements: geometric_tol (“GDT”)
SaveUserSymbolPart¶
-
AnnotationManager.
SaveUserSymbolPart
¶ Save a new master Custom Symbol file.
Use builder class
NXOpen.Annotations.MasterSymbolBuilder
methods instead of this method.Signature
SaveUserSymbolPart(symData)
Parameters: symData ( NXOpen.Annotations.MasterCustomSymbolData
) – New master part dataNew in version NX6.0.0.
Deprecated since version NX7.5.2: Use
NXOpen.Annotations.MasterSymbolBuilder
instead.License requirements: None.
SetMasterSymbolNameInQaf¶
-
AnnotationManager.
SetMasterSymbolNameInQaf
¶ This method writes master custom symbol name to the predefined quick access folder and saves the part.
The given part should correspond to the part file of native symbol part file otherwise error will be raised.
Signature
SetMasterSymbolNameInQaf()
New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
SetParallelToScreen¶
-
AnnotationManager.
SetParallelToScreen
¶ Sets the parallel to screen status on each input annotation.
Signature
SetParallelToScreen(parallelToScreen, annotations)
Parameters: - parallelToScreen (bool) – Parallel to Screen Setting
- annotations (list of
NXOpen.Annotations.Annotation
) – Annotations to be set
New in version NX11.0.1.
License requirements: geometric_tol (“GDT”)
SetStandardSymbolTextFont¶
-
AnnotationManager.
SetStandardSymbolTextFont
¶ Signature
SetStandardSymbolTextFont(symbolTextFontName)
Parameters: symbolTextFontName (str) – The name of the text font to use for displaying a symbol when using a standard font. New in version NX8.5.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)