PMIInput Object Preview

Derived from: Base Object
Defined in namespace "adsk::fusion" and the header file is <Fusion/PMI/PMIInput.h>

PreviewThis functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.

Description

A Base class for all PMI creation input types. The different types of PMI creation inputs are derived from this base class.

Methods

Name Description
classType Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().

Properties

Name Description
annotationTextPoint Gets and sets the annotation point where the leader line starts.

This point must be a valid point on the annotation plane. The point is relative to the geometry's component space where the PMI is being created.
horizontalAlignment Controls the horizontal alignment of the PMI text relative to its anchor point.

This determines how the text box is positioned relative to the text placement point.
isPerpendicularLine Controls whether the PMI text is perpendicular to the leader line or parallel to it.
isShowImportedGeometry Gets and sets whether the original graphics/geometry of the PMI should be visible.

Applicable only to PMI that has been converted.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
leaderLineExtension Gets and sets the length of the leader line extension in cm.

This value extends the leader line in the direction determined by the perpendicular setting.
objectType This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.

It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType():
plane Get the annotation plane of the PMI.

This plane determines the plane in which the PMI text and graphics are drawn. The plane is relative to the geometry's component space where the PMI is being created.
segments Gets and sets the list of PMISegments used to define the PMI text.

The segments can be any combination of PMITextSegment, PMISymbolSegment and PMILineBreakSegment objects.

Changing this property will result in changing the displayed text of the PMI.
verticalAlignment Controls the vertical alignment of the PMI text relative to its anchor point.

This determines the vertical positioning of the text box relative to the calculated text placement point.

Derived Classes

PMIHoleThreadNoteInput, PMILeaderLineNoteInput

Version

Introduced in version April 2026