Board Object Preview

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

Represents a PCB in an electronics design. Provides access to elements, signals, layers, and design-rule checks.

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().

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.

The search string for both the groupName and attributeName arguments can be either an absolute name value, or a regular expression. With an absolute name, the search string must match the entire groupName or attributeName, including case. An empty string will match everything. For example if you have an attribute group named "MyStuff" that contains the attribute "Length1", using the search string "MyStuff" as the group name and "Length1" as the attribute name will find the attributes with those names. Searching for "MyStuff" as the group name and "" as the attribute name will find all attributes that have "MyStuff" as the group name.

Regular expressions provide a more flexible way of searching. To use a regular expression, prefix the input string for the groupName or attributeName arguments with "re:". The regular expression much match the entire group or attribute name. For example, if you have a group that contains attributes named "Length1", "Length2", "Width1", and "Width2" and want to find any of the length attributes you can use a regular expression using the string "re:Length.*". For more information on attributes see the Attributes topic in the user manual.

Properties

Name Description
attributes Returns the collection of attributes associated with this product.
checked True if the board was recently checked against design rules.
circles Circle shapes on this board.
classes Net class definitions.
description Human-readable description of this board.
dimensions Dimension annotations on this board.
documentAttributes Document attributes on this board.
elements Placed component instances on this board.
errors Design rule check (DRC) errors detected on this board.
exportManager Returns the ExportManager for this design. Use the ExportManager to export the current design in various formats.
frames Frame elements (drawing borders) on this board.
grid Grid settings used in this board.
headline First line of the description, used as a short title.
holes Through-hole drills on this board.
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 board.
libraries Libraries referenced by this board.
linkedSchematic The schematic linked to the same design as this board, or null if unlinked or no schematic exists.
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.
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 design document that this board belongs to, or null if unlinked.
parentDocument Returns the parent Document object.
polyCutouts Polygon cutout regions on this board.
polyShapes Polygon shapes on this board.
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.
rectangles Rectangle shapes on this board.
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.
signals Copper trace networks (signals) on this board.
splines Spline curves on this board.
texts Text annotations on this board.
unitsManager Returns the UnitsManager object associated with this product.
variantDefs Assembly variant definitions in this board.
wires Wires on this board.
workspaces Returns the workspaces associated with this product.

Accessed From

EcadDesign.board, Schematic.linkedBoard

Samples

Name Description
Electronics Board Summary Sample

Demonstrates reading the open PCB layout: board title, placed component and copper network overview, breakdown of geometry, layer stack, design rule check results, and the linked schematic when the design includes one.

Version

Introduced in version May 2026