ModuleInstance Object Preview

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

Placed reference to a module on a schematic sheet.

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
angle Rotation angle in degrees, counter-clockwise from the positive X axis.
column Frame column position (1-based), or ? if outside a frame or frame locations are not set.
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.
mirror True if this instance is mirrored about the Y axis.
module Module definition that this instance references.
moduleVariant Name of the assembly variant applied to this instance; empty if using the default.
name Assigned name of this module instance.
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():
offset Numeric offset added to part designators within this instance (e.g., R17 with offset 100 becomes R117).
row Frame row position (A, B, C...), or ? if outside a frame or frame locations are not set.
sheet Sheet number (1-based) where this instance is placed.
x X coordinate of the placement origin, in internal units.
y Y coordinate of the placement origin, in internal units.

Accessed From

ModuleInstances.item, PortRef.moduleInst

Version

Introduced in version May 2026