This 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.
Represents a schematic in an electronics design.
Provides access to sheets, parts, nets, and electrical-rule checks.
| 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(). |
| deleteEntities |
Deletes the specified set of entities that are associated with this product. |
| findAttributes |
Find attributes attached to objects in this product that match the group and or attribute name. This does not find attributes attached directly to the Product or Document objects but finds the attributes attached to entities within the product. |
| selectObjects |
Selects the specified objects in the editor, navigating to the correct sheet if needed. |
| Name | Description |
| alwaysVectorFont | When non-zero, vector font is used for all text in this schematic. |
| attributes | Returns the collection of attributes associated with this product. |
| checked | True if Electrical Rule Check (ERC) was run recently on this schematic. |
| classes | Net class definitions. |
| description | Human-readable description of this schematic. |
| documentAttributes | Document-level attributes in this schematic. |
| errors | Electrical rule check (ERC) errors in this schematic. |
| exportManager | Returns the ExportManager for this design. Use the ExportManager to export the current design in various formats. |
| grid | Grid settings used in this schematic. |
| headline | First line of the description, used as a short title. |
| isValid | Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference. |
| layers | Layer stack available in this schematic. |
| libraries | Libraries referenced by this schematic. |
| linkedBoard | The board linked to the same design as this schematic, or null if unlinked or no board exists. |
| modules | Modules (reusable circuit blocks) in this schematic. |
| name | File name of this document. |
| namedViews | Returns the NamedViews object associated with this product. The NamedViews collection provides access to the named views defined in this product and supports the creation of new named views. |
| nets | Nets (logical connections) in this schematic. |
| 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(): |
| parentDesign | Parent electronics design that contains this schematic, or null if unlinked. |
| parentDocument | Returns the parent Document object. |
| parts | Parts (component definitions) in this schematic. |
| productType | Returns the product type name of this product. A list of all of the possible product types can be obtained by using the Application.supportedProductTypes property. |
| selectionSets | Returns the SelectionSets object associated with this product. If the product does not support selection sets, null is returned. The SelectionSets object is used to create and access existing selection sets. |
| sheets | Sheets in this schematic. |
| unitsManager | Returns the UnitsManager object associated with this product. |
| variantDefs | Variant definitions in this schematic. |
| verticalText | Vertical text orientation mode (upward or downward). |
| workspaces | Returns the workspaces associated with this product. |
| xrefLabel | Format string for cross-reference labels. |
| xrefPart | Format string for part cross-references. |
| Name | Description |
| Electronics Bill of Materials Sample | Prints a bill of materials to the Text Commands window: lines that share the same value, footprint, MPN, and manufacturer are merged—Part lists all designators (sorted), Qty is the count. Indented Value, Footprint, MPN, and Manufacturer lines follow. Empty value, MPN, or manufacturer shows (missing). Omits parts without a package, without a linked 3D footprint name, or not populated for the default assembly variant. |
| Electronics Schematic Summary Sample | Demonstrates reading the open electronics schematic: document title, sheet and connectivity overview, per-sheet component and geometry counts, electrical rule check results, and the linked PCB when the design includes one. |