PortInstance Object Preview

Derived from: EcadObject Object
Defined in namespace "adsk::electron" and the header file is <Electron/Ports/PortInstance.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

Graphical port instance on a placed module instance (distinct from the logical Port definition).

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
coord Offset from the module center along the side, in internal units. Range: [-module.dx/2, module.dx/2] for top/bottom sides; [-module.dy/2, module.dy/2] for left/right sides.
id Identifier of the object.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
moduleInst Module instance this port instance belongs to.
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():
port Port definition this instance corresponds to.
side Side of the module symbol where this port instance is placed.
x X coordinate of the port line tip in module-local coordinates, in internal units. The tip is located outside the module boundary by the port line length (200 mils).
y Y coordinate of the port line tip in module-local coordinates, in internal units. The tip is located outside the module boundary by the port line length (200 mils).

Accessed From

PortInstances.item, PortRef.portInstance

Version

Introduced in version July 2026