Symbol Object Preview

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

Schematic symbol definition from a library; contains pins, wires, circles, and other graphic primitives.

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
area Bounding area of this symbol.
circles Circle shapes in this symbol.
description Human-readable description of this symbol.
dimensions Dimensions in this symbol.
frames Frames in this symbol.
headline First line of the description, used as a short title.
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.
library Library name where this symbol is defined.
libraryLocallyModified True if the source library has been locally modified.
libraryUrn Uniform Resource Name (URN) of the source library.
libraryVersion Version number of the source library.
locallyModified True if this symbol has been locally modified.
name Assigned name of this symbol.
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():
pins Pins in this symbol.
polyShapes Polygon shapes in this symbol.
rectangles Rectangle shapes in this symbol.
texts Text annotations in this symbol.
urn Uniform Resource Name (URN) that uniquely identifies this symbol.
wires Wires in this symbol.

Accessed From

Gate.symbol, Symbols.item

Version

Introduced in version May 2026