Electronics
The new API for Electronics continues to be enhanced with additional capabilities.
Drawing
The drawing API continues to receive a lot of enhancements. The big push for this release is to expose all of the settings that control how a drawing is made. These are particularly important when using the automatic drawing creation capabilities that Fusion supports.
Sheet Metal
More API for Fusion's sheet metal functionality continues to be exposed. In this release, you can create and edit unfold and refold features. You can also create and edit the new fillet and chamfer features for sheet metal parts.
Sketch
Using the Sketch.addThreePointArcSlot and Sketch.addCenterPointArcSlot methods you can now directly create slots using three points or a center point. The Sketch.mirror and Sketch.scale methods have also been added to support mirroring and scaling sketch entities.
Finally, the sketch perpendicular constraint has been enhanced in Fusion to support creating a perpendicular constraint between a line and another curve. Previously it was limited to two lines. The existing GeometricConstraints.addPerpendicular method has been replaced by the GeometricConstraints.addPerpendicular2 method to support this.
CAM
More enhancements continue to be to the CAM API for this release. See the CAM related items in the list below.
Lighting
The API has full support for the new light functionality added to the Render workspace in this release. The RenderManager.lights property returns a Lights collection object that supports creating new lights and accessing any existing lights.
Construction Geometry
Work has been done to add missing functionality to the API for construction planes, axes, and points. This includes enhancing some existing objects and adding support for new ways to define construction geometry. You can now create a construction plane perpendicular to another plane, a construction plane through three points, a construction axis normal to a face at a point, and construction points at a defined distance along a path. Snap points are also now supported as input when creating construction geometry.
Analysis
The API continues to support more of the analysis commands available in Fusion. In this release there is support for Zebra Analysis and EnvironmentMap Analysis.
Mesh
The API now supports creating and editing Mesh Remesh features.
Draft Feature
The API now supports creating and editing Draft features.
Timeline
The Timeline object now supports a parentDesign property. The TimelineObject object supports parentTimeline, isDeletable, and a deleteObject method to delete the associated entity.
Palette Docking Enhancement
The Palette object now supports the isDockedInCanvas property. This property determines whether the palette docks within the canvas area or against the edge of the Fusion window. The edge it docks to is controlled by the dockingState property. When true, which is the default, docking the palette overlaps the canvas, leaving the rest of the Fusion window unchanged. When false, docking the palette spans the full edge of the Fusion window and the canvas and other content automatically resize to make room for it, the same way the Autodesk Assistant palette behaves.
There was a problem reported on the forum where exploding text using the API was not behaving as expected. The problem was a side effect of copying text from one sketch to another. This has been fixed.
There was a problem reported on the forum where the Occurrence.isLightBulbOn property was not returning the correct result. This has been fixed.
A problem was reported where the visible argument of the Documents.open method did not work as documented. This has been fixed.
Assembly constraints have continued to evolve over the last few releases. The existing API is exposing an early version of assembly constraints and will be removed and replaced with a complete and easier-to-use API. This new API is still coming. The current API is marked as Preview and it's wise to follow that advice and not use that API for anything you want to maintain long-term.
Custom Features is new functionality that is currently in preview. This release does not include any new Custom Features functionality, but we still encourage you to try it and let us know your thoughts.
You can learn more in the Custom Feature topic in the API User Manual. That document also references two add-in samples you can use to explore the functionality.
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. However, because this functionality is still in preview, it may change and could break existing programs that depend on it. Therefore, you should avoid shipping production programs that rely on preview capabilities.
| Name | Description |
| AdditiveSubNestFuture | Used to check the state and get back the results of a Sub-Nest generation triggered via AdditiveSetupUtility.generateSubNest(). The future reports completion as soon as the underlying arrangement task has finished. |
| AdditiveSubNestInput | Parameter container used to drive a single Sub-Nest generation. Created by AdditiveSubNestInput.create(). The contained CAMParameters mirror those of the additive_subnest strategy (notably arrangeTargets, arrange_subnest_automatic and the manual volume parameters arrange_subnest_automatic_x/y/z). An AdditiveSubNestInput is transient: it is not added to the document tree. Use AdditiveSetupUtility.generateSubNest() to execute the Sub-Nest generation defined by the input. |
| CadMultiPointOnSurfaceParameterValue | A parameter value that is a CadMultiPointOnSurface. |
| CadStockProbeParameterValue | A parameter value for probe stock face selection (CadStockProbe). Names identify analytic stock faces (for example Top, Bottom, Left, Right, Front, Back on box stock; Top, Bottom, Outside, Inside on cylinder or tube stock). Matching is case-insensitive when setting. |
| CAMFutureBase | Base class for futures that track asynchronous CAM tasks. Provides common members to poll completion, progress, and any errors or warnings raised during execution. |
| AnnotationSettings | Object that provides access to Annotation section of document settings. |
| Arc | Object that represents an arc on a drawing sheet. |
| Arcs | Collection object that provides access to all arcs in a sketch and supports creating new ones. Obtained via the DrawingSketch.arcs property. |
| AutoCenterLineOptions | Object that holds the options controlling automatic center line creation for drawing views. |
| AutoCenterMarkOptions | Object that holds the options controlling automatic center mark creation for drawing views. |
| AutoDimensionInput | The input object that defines the settings used by an automatic dimensioning operation when using the Sheet.autoDimension method. Created using the Sheets.createAutoDimensionInput method. |
| BendTable | Represents a bend table on a drawing sheet. |
| BendTableInput | The input object that defines the required input to create a bend table when using the BendTables.add method. Created using the BendTables.createInput method. |
| BendTables | Collection object that provides access to bend tables on a sheet and supports creating new tables. Obtained via the Sheet.bendTables property. |
| CenterLineOptions | Object that holds the options controlling center line creation for drawing view preferences. |
| CenterMarkOptions | Object that holds the options controlling center mark creation for drawing view preferences. |
| Circle | Object that represents a circle on a drawing sheet. |
| Circles | Collection object that provides access to all circles in a sketch and supports creating new ones. Obtained via the DrawingSketch.circles property. |
| DimensionSettings | Object that provides access to Dimension section of document settings. |
| DocumentSettings | Object that provides access to document-level settings for a drawing. |
| DrawingSketch | Object that represents a sketch on a drawing sheet. A sketch owns 2D geometry such as lines and appears as a node in the drawing browser. |
| DrawingSketches | Collection object that provides access to all sketches on a sheet and supports creating new ones. Obtained via the Sheet.sketches property. |
| DrawingStandardsSettings | Object that provides access to the Standards section of document settings (surface texture, feature control frame, datum identifier, welding, taper and slope, and edge). |
| DrawingViewOptions | Object that holds the complete set of options available in the Drawing View Defaults dialog. These options define the appearance and automatic annotation behavior applied to drawing views. |
| DrawingViewSettings | Object that provides access to the Drawing View Defaults section of document settings. These define the default appearance applied to newly created drawing views. |
| DWGExportOptions | Defines the inputs needed to export the drawing as DWG. |
| DXFExportOptions | Defines the inputs needed to export the drawing as DXF. |
| Ellipse | Object that represents an ellipse on a drawing sheet. |
| Ellipses | Collection object that provides access to all ellipses in a sketch and supports creating new ones. Obtained via the DrawingSketch.ellipses property. |
| FlatPatternDrawingViewSettings | Object that provides access to the Drawing View Defaults for sheet metal flat pattern source models. In addition to the standard drawing view defaults, flat pattern views can display bend extents. |
| GeneralTableSettings | Object that provides access to the General subsection of Table document settings (GeneralTableSettings). Includes line widths and line types for custom tables, balloons, hole tables, revision markers, revision clouds, and related table-tab items. |
| HatchSettings | Object that provides access to Hatch section of document settings. |
| ImageInsertInput | The input object that defines the properties needed to insert an image when using the Images.insert method. Created using the Images.createInput method. |
| Images | Collection object used to insert raster images on a sheet. Obtained via the Sheet.images property. |
| LabelSettings | Object that provides access to Label section of document settings. |
| Line | Object that represents a line (a connected chain of straight segments) on a drawing sheet. |
| Lines | Collection object that provides access to all lines in a sketch and supports creating new lines. Obtained via the DrawingSketch.lines property. |
| LineWidthSettings | Object that provides access to line width settings for a drawing. |
| NoteSettings | Object that provides access to Note section of document settings. |
| PartsListSettings | Object that provides access to Parts List section of document settings. |
| Rectangle | Object that represents a two-point rectangle (a closed chain of four straight segments) on a drawing sheet. |
| Rectangles | Collection object that provides access to all rectangles in a sketch and supports creating new ones. Obtained via the DrawingSketch.rectangles property. |
| RevisionHistorySettings | Object that provides access to the Revision History section of document settings. |
| Sheet | Object that represents the sheet specific data within a drawing document. |
| SheetInput | The input object that defines the properties needed to create a new sheet when using the Sheets.add method. Created using the Sheets.createInput method. |
| Sheets | Provides access to the sheets in a drawing document. |
| SketchSettings | Object that provides access to Sketch section of document settings. |
| SymbolSettings | Object that provides access to Symbol section of document settings. |
| TableSettings | Object that provides access to Table section of document settings. |
| TextSettings | Object that provides access to the Text section of the document settings for a drawing. |
| UnitSettingParameters | Common units section in document settings for either primary or alternate. |
| UnitSettings | Object that provides access to the Units section of document settings for a drawing. |
| View | Object that represents an individual drawing view on a sheet. |
| Views | Collection object that provides access to all drawing views on a sheet. Obtained via the Sheet.views property. |
| ViewSettings | Object that provides access to View section of document settings. |
| Arc | Circular arc in a PCB board, schematic sheet, symbol, or package. |
| BoardDocument | Object that represents an electronics PCB document in Fusion. |
| EcadDesignDocument | Object that represents an electronics design document (project) in Fusion. |
| LibraryDocument | Object that represents an electronics library document in Fusion. |
| PortNetMapping | The PortNetMapping collection provides access to all internal-to-external net name mapping entries on a bus port instance. |
| PortNetMappingEntry | One entry in the per-instance bus port net mapping: a ranged or scalar internal bus spec paired with its external bus spec. |
| SchematicDocument | Object that represents an electronics schematic document in Fusion. |
| Sheet | Represents one page of a multi-sheet schematic. |
| Sheets | The Sheets collection provides access to all of the sheets within a schematic. |
| ConstructionPlanePathDefinition | The definition for a parametric construction plane created using the setByPath method. |
| ConstructionPlanePerpendicularDefinition | ConstructionPlanePerpendicularDefinition defines a ConstructionPlane that is perpendicular to the input face or plane. |
| ConstructionPointPathDefinition | The definition for a parametric construction point created using the setByPath method |
| ConstructionSnapPoint | A transient value object describing a snap-point selection passed to construction-geometry inputs (such as ConstructionAxisInput.setByTwoSnapPoints). A ConstructionSnapPoint mirrors what the user supplies in the UI when they hover over an entity and pick a snap location: the host entity, an optional reference entity, the picked 3D point in world space, and a snap-point type that classifies the selection. |
| CylinderLightShape | A cylindrical emitter shape, defined by a radius and a height. |
| DiffuseLightDistribution | A distribution that emits light with a diffuse (Lambertian) falloff. |
| DirectionalLight | A directional light emits parallel light rays in a direction. Because the rays are parallel and infinite, a directional light has no position, range, or attenuation. |
| DiscLightShape | A disc emitter shape, defined by a radius. |
| EnvironmentMapAnalyses | Provides access to any environment map analyses results in the design. |
| EnvironmentMapAnalysis | Represents any existing Environment Map Analysis in the design. |
| Light | The base class for lights used by the scene. It defines the properties that are common to every light type. Type-specific properties are defined on the derived PointLight, DirectionalLight, SpotLight, and PhotometricLight classes, matching the inputs exposed by the light editing command in the user interface. |
| LightDistribution | The base class for the luminous distribution of a photometric light. It defines the properties common to every distribution. Distribution-specific properties are defined on the derived UniformLightDistribution, DiffuseLightDistribution, SpotLightDistribution, and WebLightDistribution classes. |
| Lights | Provides access to the lights used by the scene and supports creating new lights. |
| LightShape | The base class for the emitter shape of a photometric light. It defines the properties common to every shape. Shape-specific dimensions are defined on the derived PointLightShape, LineLightShape, DiscLightShape, RectangleLightShape, SphereLightShape, and CylinderLightShape classes. All dimensions are in centimeters. |
| LineLightShape | A line emitter shape, defined by a length. |
| LoftedFlangeFeature | Represents an existing lofted flange feature in a design. A lofted flange creates a sheet metal body by transitioning between two or more open profile cross-sections, connecting them with a shape that conforms to the sheet metal material thickness. |
| LoftedFlangeFeatureInput | Defines the input properties required for creating a lofted flange feature. Use the createInput method on LoftedFlangeFeatures to create an instance of this object. |
| LoftedFlangeFeatures | Collection that provides access to all of the existing lofted flange features in a design and supports the ability to create new lofted flange features. |
| PhotometricLight | A photometric light models real-world luminaires using physical intensity units, a luminous distribution, and an emitter shape. The luminous distribution is represented by the LightDistribution object returned by the distribution property and the emitter shape by the LightShape object returned by the shape property. The remaining properties define the physically based intensity and color of the light, matching the inputs shown for photometric lights in the light editing command. |
| PointLight | A point light emits light in all directions from a position in world space. |
| PointLightShape | A point emitter shape. A point shape has no dimensions. |
| RectangleLightShape | A rectangular emitter shape, defined by a length and a width. |
| RefoldFeatureInput | This class defines the methods and properties that pertain to the definition of a refold feature input. |
| SheetMetalChamferEdgeSet | A single edge set on an existing sheet metal chamfer feature. |
| SheetMetalChamferEdgeSetInput | A single edge set on a SheetMetalChamferFeatureInput. Represents a group of edges that share one constant distance. |
| SheetMetalChamferEdgeSetInputs | Collection of edge-set inputs on a SheetMetalChamferFeatureInput. Each edge set pairs a group of thickness-direction edges with a single constant distance. |
| SheetMetalChamferEdgeSets | Collection of edge sets on an existing SheetMetalChamferFeature. |
| SheetMetalChamferFeature | Represents an existing sheet metal chamfer feature in a design. A sheet metal chamfer bevels one or more thickness-direction edges on a sheet metal body using a single constant distance per edge set. |
| SheetMetalChamferFeatureInput | Defines the input properties required for creating a sheet metal chamfer feature. Use the createInput method on SheetMetalChamferFeatures to obtain an instance, populate the edge sets and any optional properties, then pass it to the add method. |
| SheetMetalChamferFeatures | Collection that provides access to all of the existing sheet metal chamfer features in a design and supports the ability to create new sheet metal chamfer features. Sheet metal chamfers only operate on thickness-direction edges (edges perpendicular to the sheet metal front and back faces), and use a single constant distance per edge set. Multiple edge sets, each with its own distance, may be defined on one feature. |
| SheetMetalFilletEdgeSet | A single edge set on an existing sheet metal fillet feature. |
| SheetMetalFilletEdgeSetInput | A single edge set on a SheetMetalFilletFeatureInput. Represents a group of edges that share one constant radius. |
| SheetMetalFilletEdgeSetInputs | Collection of edge-set inputs on a SheetMetalFilletFeatureInput. Each edge set pairs a group of thickness-direction edges with a single constant radius. |
| SheetMetalFilletEdgeSets | Collection of edge sets on an existing SheetMetalFilletFeature. |
| SheetMetalFilletFeature | Represents an existing sheet metal fillet feature in a design. A sheet metal fillet rounds one or more thickness-direction edges on a sheet metal body using a single constant radius per edge set. |
| SheetMetalFilletFeatureInput | Defines the input properties required for creating a sheet metal fillet feature. Use the createInput method on SheetMetalFilletFeatures to obtain an instance, populate the edge sets and any optional properties, then pass it to the add method. |
| SheetMetalFilletFeatures | Collection that provides access to all of the existing sheet metal fillet features in a design and supports the ability to create new sheet metal fillet features. Sheet metal fillets only operate on thickness-direction edges (edges perpendicular to the sheet metal front and back faces), and use a single constant radius per edge set. Multiple edge sets, each with its own radius, may be defined on one feature. |
| SphereLightShape | A spherical emitter shape, defined by a radius. |
| SpotLight | A spot light emits light from a position in a direction within a cone. |
| SpotLightDistribution | A distribution that emits light within a cone, defined by an inner hotspot angle and an outer falloff angle. |
| UnfoldFeatureInput | This class defines the methods and properties that pertain to the definition of an unfold feature input. |
| UniformLightDistribution | A distribution that emits light uniformly in all directions. |
| WebLightDistribution | A distribution defined by an IES photometric web profile. |
| ZebraAnalysisInput | Provides access to all of the settings available when creating a zebra analysis. This object is the API equivalent of the command dialog used to create a zebra analysis. Use this object to define the settings you need and then pass it into the add method to create the zebra analysis. |
| Name | Description |
| AdditiveSetupUtility.generateSubNest | Starts a Sub-Nest generation defined by the given input on this additive setup and returns immediately with an AdditiveSubNestFuture used to monitor progress and retrieve any errors or warnings. The arrangement task runs asynchronously on the document task registry. The Sub-Nest IronObject created by this call is transient: parameters and the input object are consumed to drive the arrangement task, but no persistent Sub-Nest operation is added to the document tree (mirrors the in-product Sub-Nest dialog behavior). |
| CAMTemplate.isPrioritySet | True if this template has been provided with a priority, false otherwise |
| CAMTemplate.priority | The priority of the template if is true. |
| MachineAvoidDefaultSelection.machineOverHoles | When true, the toolpath will machine over holes and pockets in the surfaces belonging to this group rather than treating them as features to follow. Only supported on groups whose underlying parameter table exposes this option. For groups that do not support it, the getter returns false and the setter throws. |
| MachineAvoidDirectSelection.machineOverHoles | When true, the toolpath will machine over holes and pockets in the surfaces belonging to this group rather than treating them as features to follow. Only supported on groups whose underlying parameter table exposes this option. For groups that do not support it, the getter returns false and the setter throws. |
| MachineAvoidSelectionBase.machineOverHoles | When true, the toolpath will machine over holes and pockets in the surfaces belonging to this group rather than treating them as features to follow. Only supported on groups whose underlying parameter table exposes this option. For groups that do not support it, the getter returns false and the setter throws. |
| Operation.clearHoleSignature | Removes any Hole Signature or external Hole Signature links from this operation. |
| Operation.getHoleSignatureXML | Gets the hole signature XML string for this operation. Returns an empty string if this operation does not support hole signatures or has none. |
| Operation.hasHoleSignature | Returns true if this operation has an effective hole signature (local or linked). Returns false if the operation does not support hole signatures or has none set. |
| Operation.isHoleSignatureLinked | Returns true if this operation's hole signature is linked from another operation. A linked operation may still return false for hasHoleSignature if the source has been cleared. Returns false if the signature is locally stored or absent. |
| Operation.linkHoleSignatureFrom | Links this operation's Hole Signature to the signature of another operation. |
| Operation.setHoleSignatureXML | Sets the hole signature for this operation using an XML string. Returns true if successful. |
| SetupVisibilityManager.buildVolumeVisible | Controls the visibility of the setup's machine build volume where it exists. This is always disabled for non additive setups. |
| SetupVisibilityManager.noBuildZoneVisible | Controls the visibility of the setup's machine no build zone where it exists. This is always disabled for non additive setups. This will error if a no build zone does not exist with the given index. |
| SetupVisibilityManager.platformVisible | Controls the visibility of the setup's machine platform where it exists. This is always disabled for non additive setups. |
| SetupVisibilityManager.setNoBuildZoneVisible | Controls the visibility of the setup's machine no build zone where it exists. This is always disabled for non additive setups. This will error if a no build zone does not exist with the given index. |
| Tool.toolBlockGeometry | Gets the 3D geometry for a tool block attached to the tool. |
| ToolBlock.toolBlockGeometry | Gets the 3D geometry for a tool block attached to the tool. |
| ToolPreset.supportedFinishingStrategies | Gets the supported finishing strategies for a Preset. |
| ToolPreset.supportedRoughingStrategies | Gets the supported roughing strategies for a Preset. |
| TurningTool.toolBlockGeometry | Gets the 3D geometry for a tool block attached to the tool. |
| Palette.isDockedInCanvas | Gets and sets whether this palette docks within the canvas area or against the edge of the Fusion window. The edge it docks to is controlled by the dockingState property. When true, which is the default, docking the palette overlaps the canvas, leaving the rest of the Fusion window unchanged. When false, docking the palette spans the full edge of the Fusion window and the canvas and other content automatically resize to make room for it, the same way the Autodesk Assistant palette behaves. This property only applies to API created palettes. Setting it on a native palette has no effect. |
| TextCommandPalette.isDockedInCanvas | Gets and sets whether this palette docks within the canvas area or against the edge of the Fusion window. The edge it docks to is controlled by the dockingState property. When true, which is the default, docking the palette overlaps the canvas, leaving the rest of the Fusion window unchanged. When false, docking the palette spans the full edge of the Fusion window and the canvas and other content automatically resize to make room for it, the same way the Autodesk Assistant palette behaves. This property only applies to API created palettes. Setting it on a native palette has no effect. |
| CreateDrawingInput.configuration | Gets and sets the name of the design configuration to create the drawing from. This applies to both automatic and manual creation. This property is optional: when empty (the default), the design's active configuration is used; if the active configuration cannot be determined, createDrawing fails. For a non-configured design (one with no configurations), this property must be left empty; otherwise createDrawing fails. For a configured design, a non-empty value must match one of the design's configuration names, otherwise createDrawing fails. |
| CustomTable.getCellData | Returns the text content of a specific cell in the custom table. |
| Drawing.documentSettings | Returns the DocumentSettings object that provides access to document-level settings for this drawing. |
| DrawingExportManager.createDWGExportOptions | Defines the various settings for a DWG export. |
| DrawingExportManager.createDXFExportOptions | Defines the various settings for a DXF export. |
| DrawingViewFlatPatternPreferences.centerLineOptions | Returns the CenterLineOptions object that controls automatic center line creation for drawing views. |
| DrawingViewFlatPatternPreferences.centerMarkOptions | Returns the CenterMarkOptions object that controls automatic center mark creation for drawing views. |
| DrawingViewPreferences.centerLineOptions | Returns the CenterLineOptions object that controls automatic center line creation for drawing views. |
| DrawingViewPreferences.centerMarkOptions | Returns the CenterMarkOptions object that controls automatic center mark creation for drawing views. |
| Circle.id | Identifier of the object. |
| Circle.layer | Layer number (1-based index into the layer stack). |
| Circle.radius | Radius of this circle, in internal units. |
| Circle.width | Stroke width of this circle, in internal units. |
| Circle.x | X coordinate of the center point, in internal units. |
| Circle.y | Y coordinate of the center point, in internal units. |
| Circles.addByCenterRadius | Creates a new circle in the sketch defined by a center point and a radius. Mirrors the Center Radius Circle drawing command. |
| Port.isBus | True when the port exports a bus (multi-net) connection; false for a single-net port. |
| PortInstance.connectedBus | Bus connected to this port instance, or null when no bus is connected or the port is not a bus port. |
| PortInstance.netMapping | Internal-to-external net name mapping for this bus port instance. Empty for non-bus ports or when no bus is connected. |
| Rectangle.angle | Rotation angle in degrees, counter-clockwise from the positive X axis (0.0–359.9). |
| Rectangle.id | Identifier of the object. |
| Rectangle.layer | Layer number (1-based index into the layer stack). |
| Rectangle.x1 | X coordinate of the lower-left corner, in internal units. |
| Rectangle.x2 | X coordinate of the upper-right corner, in internal units. |
| Rectangle.y1 | Y coordinate of the lower-left corner, in internal units. |
| Rectangle.y2 | Y coordinate of the upper-right corner, in internal units. |
| Rectangles.addTwoPointRectangle | Creates a new two-point rectangle in the sketch, defined by two diagonally opposite corner points. Mirrors the 2-Point Rectangle drawing command. |
| Analyses.environmentMapAnalyses | Returns the EnvironmentMapAnalyses object, which provides access to any existing EnvironmentMapAnalysis objects in the design. |
| BRepBody.getBendFaces | Returns the inner and outer cylindrical bend faces on this sheet metal body. The two arrays have the same length; faces at the same index belong to the same bend. Only cylindrical and elliptical-cylindrical bend walls are returned (not side/partner faces). |
| ConfigurationJointSnap.id | Gets the unique ID that identifies this snap. The ID remains constant for this snap as long as the snap exists. This is different than the name, which the user can change. |
| ConfigurationJointSnaps.itemById | A method that returns the snap with the specified ID. |
| ConfigurationReplaceDesign.id | Gets the unique ID of this ConfigurationReplaceDesign object. |
| ConfigurationReplaceDesigns.itemById | A method that returns the ConfigurationReplaceDesign object with the specified ID. |
| ConfigurationRow.isTestRow | Returns whether this row is the test row of the table. |
| ConfigurationTopTable.testRow | Returns the row that is designated as the test row, or null if no test row is defined. The test row is not included in the rows collection, so this property is the only way to access it. This property returns null when the table being queried was obtained from the DataFile object of a configured design. |
| ConstructionAxis.isExtended | Gets or sets whether this parametric construction axis uses extended sizing. When true, the axis is sized to fit the viewport extent rather than the default bounding-box-based sizing. This property can only be set on parametric construction axes. |
| ConstructionAxisInput.isExtended | Gets or sets whether the construction axis input uses extended sizing. When true, the axis will be sized to fit the viewport extent rather than the default bounding-box-based sizing. |
| ConstructionAxisInput.setByNormalToFaceAtSnapPoint | This input method is for creating a construction axis normal to a specified face or sketch profile and that passes through the location described by a snap point. A snap point captures the same information that the user supplies in the UI when they hover over an entity and pick a snap location: the host entity, an optional reference entity, the picked 3D point in world space, and a ConstructionSnapPointTypes value that classifies the selection. Build the snap with ConstructionSnapPoint.create. Supported snap-point types include vertex (DefaultConstructionSnapPointType on a BRepVertex, SketchPoint, or ConstructionPoint), edge midpoint, edge start/end, arc center, face center, and tangent on a curved face (cylinder/cone, sphere, torus, or spline). The point does not have to lie on the face. This can result in a parametric or non-parametric construction axis depending on whether the parent component is parametric or is a direct edit component. |
| ConstructionAxisInput.setByTwoSnapPoints | This input method is for creating a construction axis that passes through the two snap points. A snap point captures the same information that the user supplies in the UI when they hover over an entity and pick a snap location: the host entity, an optional reference entity, the picked 3D point in world space, and a ConstructionSnapPointTypes value that classifies the selection. This input method exposes snap-point selections (such as edge midpoints, arc centers, face centers and tangent points on curved faces) that previously were only available through the UI. This will fail if the two snap points are coincident. This can result in a parametric or non-parametric construction axis depending on whether the parent component is parametric or is a direct edit component. |
| ConstructionAxisNormalToFaceAtPointDefinition.redefineWithSnapPoint | Redefines the input geometry of the construction axis using a ConstructionSnapPoint to position the axis on a face. Use this overload when the axis was originally created with ConstructionAxisInput.setByNormalToFaceAtSnapPoint, or when redefining any normal-to-face axis using a snap-style pick (vertex, edge mid, edge start/end, arc center, face center, or tangent on cylinder/cone/sphere/torus). The snap point must be built with ConstructionSnapPoint.create. |
| ConstructionAxisTwoPointDefinition.redefineByTwoSnapPoints | Redefines the input geometry of the construction axis using two snap points. A snap point captures the same information that the user supplies in the UI when they hover over an entity and pick a snap location: the host entity, an optional reference entity, the picked 3D point in world space, and a ConstructionSnapPointTypes value that classifies the selection. This redefine method exposes snap-point selections (such as edge midpoints, arc centers, face centers and tangent points on curved faces) that previously were only available through the UI. Use this when editing an existing parametric construction axis that was originally created with ConstructionAxisInput.setByTwoSnapPoints, or when converting a non-snap two-point axis into a snap-point one. The redefine(core.Base, core.Base) overload remains the appropriate API when you only need to swap the underlying entities without snap classification. This will fail if the two snap points are coincident. |
| ConstructionPlaneInput.setByPath | This input method is for creating a construction plane normal to the specified path at a specified position along the path. This can result in a parametric or non-parametric construction plane, depending on whether the parent design is parametric or is a direct edit component, or if the construction plane is created in a base feature in a parametric design. |
| ConstructionPlaneInput.setByPathToObject | This input method is for creating a construction plane normal to the specified path at the position where the path meets the target point entity, with an optional signed offset along the path from that target. This can result in a parametric or non-parametric construction plane, depending on whether the parent design is parametric or is a direct edit component, or if the construction plane is created in a base feature in a parametric design. |
| ConstructionPlaneInput.setByPerpendicularToPlane | This input method creates a construction plane that is perpendicular to the input face or plane. This can result in a parametric or non-parametric construction plane depending on whether the parent component is parametric or is a direct edit component. |
| ConstructionPlaneInput.setByThreeSnapPoints | This input method is for creating a construction plane through three snap points. A snap point captures the same information that the user supplies in the UI when they hover over an entity and pick a snap location: the host entity, an optional reference entity, the picked 3D point in world space, and a ConstructionSnapPointTypes value that classifies the selection. Build each snap with ConstructionSnapPoint.create. Supported snap-point types include vertex (DefaultConstructionSnapPointType on a BRepVertex, SketchPoint, or ConstructionPoint), edge midpoint, edge start/end, arc center, face center, and tangent on a curved face (cylinder/cone, sphere, torus, or spline). The first snap point defines the plane origin. The three points together define the plane orientation (normal); they do not explicitly set the in-plane X- or Y-axis directions. This matches setByThreePoints. This will fail if the three points are collinear or any two are coincident. This can result in a parametric or non-parametric construction plane depending on whether the parent component is parametric or is a direct edit component. |
| ConstructionPlaneThreePointsDefinition.redefineWithSnapPoints | Redefines the input geometry of the construction plane using three ConstructionSnapPoint objects. Use this overload when the plane was originally created with ConstructionPlaneInput.setByThreeSnapPoints, or when redefining any three-points plane using snap-style picks (vertex, edge mid, edge start/end, arc center, face center, or tangent on cylinder/cone/sphere/torus). Each snap point must be built with ConstructionSnapPoint.create. The first snap point defines the plane origin. The three points together define the plane orientation (normal); they do not explicitly set the in-plane X- or Y-axis directions. This matches setByThreePoints. |
| ConstructionPointInput.setByPath | This input method is for creating a construction point on the specified path. This can result in a parametric or non-parametric construction point, depending on whether the parent design is parametric or is a direct edit component, or if the construction point is created in a base feature in a parametric design. |
| ConstructionPointInput.setBySnapPoint | This input method is for creating a construction point at the supplied snap point. A snap point captures the same information that the user supplies in the UI when they hover over an entity and pick a snap location: the host entity, an optional reference entity, the picked 3D point in world space, and a ConstructionSnapPointTypes value that classifies the selection. This input method exposes snap-point selections (such as edge midpoints, arc centers, face centers and tangent points on curved faces) that previously were only available through the UI. This can result in a parametric or non-parametric construction point depending on whether the parent component is parametric or is a direct edit component. |
| ConstructionPointPointDefinition.redefineBySnapPoint | Redefines the input geometry of the construction point using a snap point. A snap point captures the same information that the user supplies in the UI when they hover over an entity and pick a snap location: the host entity, an optional reference entity, the picked 3D point in world space, and a ConstructionSnapPointTypes value that classifies the selection. This redefine method exposes snap-point selections (such as edge midpoints, arc centers, face centers and tangent points on curved faces) that previously were only available through the UI. Use this when editing an existing parametric construction point that was originally created with ConstructionPointInput.setBySnapPoint, or when converting a non-snap construction point into a snap-point one. The pointEntity setter remains the appropriate API when you only need to swap the underlying entity without snap classification. |
| Design.setLightBulbOn | Sets the light bulb of many entities all at once. Changing them all at once is more efficient than setting the isLightBulbOn property of each entity one at a time, and the whole change is a single undo step. |
| Design.setSuppressed | Sets the suppress state of many timeline entities all at once. Changing them all at once is much more efficient than setting the isSuppressed property of each entity one at a time because the design is recomputed once instead of once per entity. |
| DraftFeature.draftType | Specifies how the draft is defined; by a fixed plane or a parting line. Use one of the set methods to change the type. |
| DraftFeature.movingPartingLineDirection | Gets MovingPartingLineDirections used for MovingPartingLineDraftFeatureType. The default is BothAnglesMovingPartingLineDirection. To set this, you need to use the set method to define a parting line type of draft |
| DraftFeature.movingPartingLineFixedEdges | Gets the fixed edges used for MovingPartingLineDraftFeatureType. This can be an empty array in the case where no fixed edges are used. To set this, you need to use the set method to define a moving parting line type of draft |
| DraftFeature.partingLineCurves | Gets the curves used for PartingLineDraftFeatureType. To set this, you need to use the set method to define a parting line type of draft |
| DraftFeature.partingLineType | Gets the parting line type if the draftType is PartingLineDraftFeatureType. The default is FixedPartingLineType. |
| DraftFeature.setFixedPartingLineDraftFeatureType | Sets this draft to define a parting line type of draft where the draft line remains fixed as its current position and the faces of the part draft in or out from the parting line. To use this method, you need to position the timeline marker to immediately before this feature. This can be accomplished using the following code: thisFeature.timelineObject.rollTo(True) |
| DraftFeature.setFixedPlaneDraftFeatureType | Defines a draft type where the plane specified for the pull direction intersects the model and defines where the draft starts. To use this method, you need to position the timeline marker to immediately before this feature. This can be accomplished using the following code: thisFeature.timelineObject.rollTo(True) |
| DraftFeature.setMovingPartingLineDraftFeatureType | Sets this draft to define a parting line type of draft where the parting line moves in and out from the part to create the specified draft angle of the faces connected to the parting line. To use this method, you need to position the timeline marker to immediately before this feature. This can be accomplished using the following code: thisFeature.timelineObject.rollTo(True) |
| DraftFeatureInput.draftType | Specifies how the draft is defined; by a fixed plane or a parting line. Use one of the set methods to change the type. When the DraftFeatureInput is created, the default draft type is FixedPlaneDraftFeatureType. |
| DraftFeatureInput.movingPartingLineDirection | Gets MovingPartingLineDirections used for MovingPartingLineDraftFeatureType. The default is BothAnglesMovingPartingLineDirection |
| DraftFeatureInput.movingPartingLineFixedEdges | Gets the edges that are fixed when using the MovingPartingLineDraftFeatureType. This can be an empty array in the case where no fixed edges are used. |
| DraftFeatureInput.partingLineCurves | Gets the curves used for PartingLineDraftFeatureType |
| DraftFeatureInput.partingLineType | Gets the type of parting line draft, if the draft is a parting line type. If the draft is not a parting line type, this value should be ignored. |
| DraftFeatureInput.setFixedPartingLineDraftFeatureType | Sets this draft to define a parting line type of draft where the draft line remains fixed at its current position and the faces of the part draft in or out from the parting line. |
| DraftFeatureInput.setFixedPlaneDraftFeatureType | Defines a draft type where the plane specified for the pull direction intersects the model and defines where the draft starts. |
| DraftFeatureInput.setMovingPartingLineDraftFeatureType | Sets this draft to define a parting line type of draft where the parting line moves in and out from the part to create the specified draft angle of the faces that connect to the parting line. |
| Features.loftedFlangeFeatures | Returns the collection that provides access to the existing Lofted Flange features. |
| Features.sheetMetalChamferFeatures | Returns the SheetMetalChamferFeatures collection associated with this component, which supports querying existing sheet metal chamfer features and creating new ones. Sheet metal chamfers only operate on edges that are perpendicular to the sheet metal front and back faces (thickness- direction edges), and use a constant distance per edge set. |
| Features.sheetMetalFilletFeatures | Returns the SheetMetalFilletFeatures collection associated with this component, which supports querying existing sheet metal fillet features and creating new ones. Sheet metal fillets only operate on edges that are perpendicular to the sheet metal front and back faces (thickness- direction edges), and use a constant radius per edge set. |
| FlatPatternProduct.setLightBulbOn | Sets the light bulb of many entities all at once. Changing them all at once is more efficient than setting the isLightBulbOn property of each entity one at a time, and the whole change is a single undo step. |
| FlatPatternProduct.setSuppressed | Sets the suppress state of many timeline entities all at once. Changing them all at once is much more efficient than setting the isSuppressed property of each entity one at a time because the design is recomputed once instead of once per entity. |
| GeometricConstraints.addPerpendicular2 | Creates a new perpendicular constraint between a line and another curve. |
| MeshCombineFeature.algorithmType | Gets and sets the used algorithm for the join, cut and intersect operation types. |
| MeshRemeshFeature.edgeLength | Gets and sets the target edge length for the remeshing. The value should be higher than 0.001 cm. Only valid if meshRemeshTargetType is EdgeLengthRemeshTargetType. |
| MeshRemeshFeature.meshRemeshTargetType | Gets and sets the target criteria for the re-meshing. |
| MeshRemeshFeatureInput.edgeLength | Gets and sets the target edge length for the remeshing. The value should be higher than 0.001 cm. Default value is 0.5 cm. Only valid if meshRemeshTargetType is EdgeLengthRemeshTargetType. |
| MeshRemeshFeatureInput.meshRemeshTargetType | Gets and sets the target criteria for the re-meshing, default value is DensityRemeshTargetType. |
| Occurrences.addNewExternalSheetMetalComponent | Method that creates a new occurrence by creating a new external sheet metal component (X-Ref) that is not saved yet. This is similar to addNewExternalComponent but the resulting component will have the design's active sheet metal rule applied, which defines the thickness, bend radius, K factor, gap, and relief parameters for sheet metal features. The component will be saved automatically when the parent assembly is saved. |
| Occurrences.addNewSheetMetalComponent | Method that creates a new sheet metal component and an occurrence that references it. The new component will have the design's active sheet metal rule applied, which defines the thickness, bend radius, K factor, gap, and relief parameters for sheet metal features. The activeSheetMetalRule property of the resulting component will reflect this rule. |
| OffsetFeature.offsetType | Gets and sets the offset type for the offset. To set this property, you need to position the timeline marker to immediately before this feature. This can be accomplished using the following code: thisFeature.timelineObject.rollTo(True) |
| OffsetFeatureInput.offsetType | The offset type used when creating an offset. The default value is SharpOffsetType. |
| PerpendicularConstraint.curve | Returns the curve. |
| PerpendicularConstraint.line | Returns the line. |
| PMIGeometricValueTolerance.setBasic | Sets this object to have Basic tolerance type. Basic tolerance is only supported for linear dimension PMI. It is not valid for hole/thread note geometric values. The tolerance is defined and displayed as Basic (a theoretically exact dimension without tolerance values). |
| RefoldFeatures.add | Creates a new Refold feature. |
| RefoldFeatures.createInput | Creates a RefoldFeatureInput object for the specified unfold feature. Use the add method, passing in the RefoldFeatureInput object, to create the refold feature. |
| RenderManager.lights | Returns the Lights collection associated with this render manager. The Lights collection provides access to the lights in the scene and supports the creation of new lights. These are the same lights that are shown and edited in the Render workspace. |
| Sketch.addCenterPointArcSlot | Creates the geometry that represents a center-point arc slot. The center point defines the center of the slot and the end point defines the center of the end of the slot. The width of the slot is defined by a value and optionally the radius and angle can be specified. Geometric constraints are automatically added to the geometry to maintain the slot shape, and optionally, dimensions are created to control the size. The created geometry and dimensions are returned. |
| Sketch.addThreePointArcSlot | Creates the geometry that represents a three-point arc slot. The two end points define the start and end of the arc that defines the center line of the slot, and the third point specifies a point that results in defining the radius. Geometric constraints are automatically added to the geometry to maintain the slot shape, and optionally, dimensions are created to control the size. The created geometry and dimensions are returned. |
| Sketch.mirror | Mirrors the specified sketch entities about a mirror line and returns the newly created sketch entities (mirrored input entities together with the auxiliary sketch points - line endpoints, arc/ellipse centers, spline fit points, etc. - that the mirror operation created). Symmetry constraints are added between each original entity and its mirrored counterpart, matching the interactive Mirror sketch command. When mirrorLine is not a SketchLine that already belongs to this sketch (for example, a BRepEdge, BRepFace, ConstructionAxis, or ConstructionPlane), a new sketch line is created in the sketch for each call. Existing projections of the same source entity are not reused. This matches the behavior of the interactive Mirror sketch command. To avoid duplicate projected geometry across repeated mirror operations, project the source entity once into the sketch and pass the resulting SketchLine as mirrorLine on every call. |
| Sketch.scale | Scales the specified sketch entities about the specified reference point by the specified scale factor. |
| Timeline.parentDesign | Returns the parametric Design that owns this Timeline. |
| TimelineGroup.deleteObject | Deletes this TimelineObject and its associated feature from the design. This method should not be used for TimelineGroup objects; use TimelineGroup.deleteMe() instead. Check the isDeletable property before calling this method. |
| TimelineGroup.isDeletable | Indicates whether this TimelineObject can be deleted standalone using deleteObject(). Returns false in cases where standalone deletion is not supported, for example: - The object is a child of a collapsed TimelineGroup (delete the parent group instead). - The object represents a snapshot or other entry that cannot be deleted independently. - The underlying feature has dependents whose deletion would cascade. For TimelineGroup objects use TimelineGroup.deleteMe() rather than this method. |
| TimelineGroup.parentTimeline | Returns the Timeline that owns this TimelineObject. |
| TimelineGroups.itemByName | Returns the timeline groups with the specified name. The name is the name shown in the browser/timeline (the value of TimelineGroup.name). Since timeline group names do not have to be unique, this can return more than one group. |
| TimelineObject.deleteObject | Deletes this TimelineObject and its associated feature from the design. This method should not be used for TimelineGroup objects; use TimelineGroup.deleteMe() instead. Check the isDeletable property before calling this method. |
| TimelineObject.isDeletable | Indicates whether this TimelineObject can be deleted standalone using deleteObject(). Returns false in cases where standalone deletion is not supported, for example: - The object is a child of a collapsed TimelineGroup (delete the parent group instead). - The object represents a snapshot or other entry that cannot be deleted independently. - The underlying feature has dependents whose deletion would cascade. For TimelineGroup objects use TimelineGroup.deleteMe() rather than this method. |
| TimelineObject.parentTimeline | Returns the Timeline that owns this TimelineObject. |
| UnfoldFeature.bendFaces | Gets the bend faces that are unfolded when isUnfoldAllBends is false. The returned array contains the full per-bend face groups (inner, outer, and any partner side faces) as resolved at creation time, even if the caller originally supplied only the inner or only the outer face of each bend. When isUnfoldAllBends is true, explicit bend faces may be empty or cleared after the solve. To change which bends are unfolded, use setUnfoldBends. |
| UnfoldFeature.createForAssemblyContext | Creates or returns a proxy for the native object - i.e. a new object that represents this object but adds the assembly context defined by the input occurrence. |
| UnfoldFeature.isUnfoldAllBends | Gets whether all bends in the sheet metal body are unfolded for this feature. When true, the bendFaces property is ignored for the solve. To change unfold-all vs explicit bend selection, use setUnfoldBends. |
| UnfoldFeature.nativeObject | The NativeObject is the object outside the context of an assembly and in the context of its parent component. Returns null in the case where this object is not in the context of an assembly but is already the native object. |
| UnfoldFeature.setUnfoldBends | Updates this unfold feature to unfold either all bends or only the specified bend faces. You need to position the timeline marker to immediately before this feature before calling this method. This can be accomplished using the following code: thisFeature.timelineObject.rollTo(True) |
| UnfoldFeature.stationaryFace | Gets and sets the stationary face for the unfold feature. To set this property, you need to position the timeline marker to immediately before this feature. This can be accomplished using the following code: thisFeature.timelineObject.rollTo(True) |
| UnfoldFeatures.add | Creates a new Unfold feature. |
| UnfoldFeatures.createInput | Creates an UnfoldFeatureInput object. Use methods on this object to define the unfold you want to create and then use the add method, passing in the UnfoldFeatureInput object. |
| WorkingModel.setLightBulbOn | Sets the light bulb of many entities all at once. Changing them all at once is more efficient than setting the isLightBulbOn property of each entity one at a time, and the whole change is a single undo step. |
| WorkingModel.setSuppressed | Sets the suppress state of many timeline entities all at once. Changing them all at once is much more efficient than setting the isSuppressed property of each entity one at a time because the design is recomputed once instead of once per entity. |
| ZebraAnalyses.add | Creates a new zebra analysis. |
| ZebraAnalyses.createInput | Creates a new ZebraAnalysisInput object used to collect the settings required to create a new zebra analysis. A ZebraAnalysisInput object is the API equivalent of the command dialog used to create a zebra analysis. Use this object to define the settings you need and then pass it into the add method to create the zebra analysis. |
| ZebraAnalysis.inputEntities | Gets the entities being analyzed by this zebra analysis. The returned array contains the solid and surface BRepBody objects, T-Spline surface bodies, and mesh bodies that the zebra stripes are displayed on. |
| ZebraAnalysis.isHighQuality | Gets and sets whether the zebra stripes are displayed using higher quality rendering. |
| ZebraAnalysis.isLocked | Gets and sets whether the zebra stripes are locked in place. |
| ZebraAnalysis.isVertical | Gets and sets whether the zebra stripes are oriented vertically. If true the stripes are vertical and if false they are horizontal. |
| ZebraAnalysis.opacity | Gets and sets the opacity of the zebra stripes as an integer in the range of 0 to 100, where 100 is fully opaque. |
| ZebraAnalysis.repeats | Gets and sets the number of zebra stripes displayed. This is the "Repeats" value in the command dialog and is an integer in the range of 1 to 100. |
Help created: Friday, September 11, 2026 3:36 PM