TypeScript API (Preview)
The Fusion API now supports TypeScript alongside Python and C++. This gives developers a modern scripting and add-in workflow with strong typing, local development, and the same full debugging experience available in existing Fusion API workflows. TypeScript is used exclusively when using the Fusion Automation Service on the cloud. Now that TypeScript is also supported on the desktop it makes development of automation scripts much easier by allowing teams to build and debug locally before submitting jobs. Scripts and add-ins run in a sandboxed environment with configurable read and write permissions. See the TypeScript topic in the User Manual for more details.
More Sheet Metal API
More sheet metal functionality continues to be added. In this release you can create Fold and Join by Bend features. More functionality is coming.
Drawing API
The API now supports some drawing functionality. You can now use the automatic Create Drawing functionality to create new drawings. More functionality is coming.
Animation API
The API is in the early stages of supporting the functionality in the Animation workspace. It's currently very limited, but more functionality is coming.
Mesh Compare
The API now supports comparing one mesh body to another and getting the deviation data.
Selection Filters
When using Fusion, you can control which types of entities are selectable by using the Selection Filters command, which displays a list of different types of entities and you can choose which can be selected. This list is different for each workspace and is now accessible through the API.
Sketch Enhancements
Construction Geometry Enhancements
Fusion has added more functionality when creating and working with construction geometry. This functionality is also supported by the API. You can resize construction planes, better control Plane at Angle planes, and use additional options when creating a plane along a path.
There was a problem reported on the forum where input boxes would overlap in a command dialog. This is a new problem related to the new themes, and has been fixed.
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 |
| AnimationPreferences | Preferences for animation/exploded view sheets. Enable via GlobalPreferences.generateAnimationSheet (default: false). |
| AssemblyPreferences | Preferences for assembly sheets (main and sub-assembly). Includes ISO view, orthogonal views, and parts list options. The same AssemblyPreferences class is used for both main assembly and sub-assembly configurations. |
| AssemblySheetPreferences | Preferences for assembly sheet views (both ISO and orthogonal). Configure parts list and view sheet creation. Used for both isometric and orthogonal projection sheet configurations. Default: Parts list IS included for ISO views, NOT included for orthogonal views. |
| AutoDimensionBasePreferences | Base auto-dimension settings: enable, strategy, hole preferences. Applicable only when GlobalPreferences.isAutoDimensionEnabled is true. |
| AutoDimensionComponentPreferences | Auto-dimension settings for components. Extends base with origin and pattern options. |
| AutomationPreferences | Central configuration hub for automatic drawing preferences. Access globalPreferences for sheet generation toggles, and type-specific preferences for each sheet type. |
| CadScratchPolygonsParameterValue | A parameter value for toolpath edit operations that use scratch polygon geometry, such as polygon trim and move start points. The user needs to set the parameter anew via the API after editing the ScratchPolygonSelections returned by getScratchPolygonSelections(). |
| ComponentPreferences | Preferences for individual component (part) sheets with views, dimensions, and annotations. |
| ComponentSheetViewPreferences | Preferences for component sheet views. Configure orthographic view creation and optional isometric view. This class provides settings for controlling which views are generated on component sheets, including standard orthographic projections (front, top, right side) and an optional isometric view. |
| ConstructionPointDistanceOnPathDefinition | ConstructionPointDistanceOnPathDefinition defines a ConstructionPoint at a specified position along a path defined by an edge or sketch curve. |
| ContentLibraryOccurrenceDefinition | Represents an occurrence definition that originates from a content library (like Fasteners). |
| CornerClosureDefinition | The base class for the definitions to define two-bend and three-bend corner closure features. |
| CreateDrawingInput | Input parameters for drawing creation. Create via DrawingManager.createDrawingInput(). |
| CustomConfigurationValues | Holds the custom values to use when switching to or inserting a custom configuration occurrence. Custom values include per-column overrides (keyed by column ID) as well as optional metadata such as name, part number, and description. |
| CustomSheetSize | Custom width and height cannot exceed 5000 mm × 5000 mm (millimeter units) or 200 inch × 200 inch (inch units). Horizontal and vertical zone counts cannot exceed 1000. |
| CustomTable | Represents a custom table on a drawing sheet. |
| CustomTableInput | The input object that defines the required input to create a Custom table when using the CustomTables.add method. Created using the CustomTables.createInput method. |
| CustomTables | Collection object that provides access to all custom tables on a sheet and supports creating new tables. Obtained via the Sheet.customTables property. |
| DrawingManager | Application-level drawing functionality. Access via the static get property. |
| DrawingViewFlatPatternPreferences | Drawing view settings for flat patterns. Adds bend extents. Different defaults than base. |
| DrawingViewPreferences | Drawing view appearance settings: style, edges, center marks, center lines. |
| FastenerOccurrenceDefinition | Definition returned by occurrences that are instances of fasteners from a content library. |
| FlatPatternOrthogonalViewPreferences | Preferences for flat pattern orthogonal view sheets. Configure folded model view, bend table. |
| FlatPatternPreferences | Preferences for sheet metal flat pattern sheets (unfolded state with bend information). |
| FoldBendLineDefinition | Base class that provides access to the information defining a single bend line within a fold feature. Used when querying or editing an existing fold via FoldFeature.bendLines. |
| FoldBendLineDefinitions | Collection that provides access to the bend line definitions within a fold feature. Obtained from FoldFeature.bendLines. |
| FoldedModelPreferences | Preferences for sheet metal folded model sheets (formed state). Complements flat pattern sheets. |
| FoldFeature | Defines a fold feature, bending sheet metal along sketch lines (bend lines) on a stationary face. |
| FoldFeatureInput | This class defines the methods and properties that pertain to the definition of a fold feature. |
| FoldFeatures | Collection that provides access to all of the existing fold features in a design and supports the ability to create new fold features. |
| GlobalPreferences | Global preferences for drawing generation: sheet toggles, auto-dimensioning, component omission. |
| Job | Base class for all Jobs. |
| JoinByBendFeature | Object that represents an existing join by bend feature in a design. |
| JoinByBendFeatureInput | This class defines the methods and properties that pertain to the definition of a join by bend feature input. |
| JoinByBendFeatures | Collection that provides access to all of the existing join by bend features in a design and supports the ability to create new join by bend features. |
| OccurrenceDefinition | Represents a general occurrence definition. An occurrence definition provides information about the source of an occurrence, such as whether it originates from a content library, and exposes functionality specific to that source. Returned for occurrences that are not associated with any specialized definition type. |
| PortInstance | Graphical port instance on a placed module instance (distinct from the logical Port definition). |
| PortInstances | The PortInstances collection provides access to port instances on a module instance. |
| ScratchPolygonSelection | Represents a single scratch polygon selection - a user-drawn polygon defined by a series of 3D points. Used in toolpath edit operations such as polygon trim and move start points. |
| ScratchPolygonSelections | Collection for all scratch polygon selections to be passed to a CadScratchPolygonsParameterValue or CadScratchPolygonsForMoveStartPointsParameterValue object. This is a read-only container. It returns the scratch polygon selections associated with the parent parameter value object, but does not write to it. To apply changes done to the collection and the selections it contains, the corresponding ParameterValue's applyScratchPolygonSelections() needs to be called. |
| SelectionFilterSettings | Provides management of selection filters. Supports registration of workspace-scoped custom graphics sub-filters that appear as separate entries in the selection filter dropdown, and querying or toggling the enabled state of any selection filter category visible in the toolbar. Access via . |
| STEPFlatPatternExportOptions | Defines that a STEP export of a flat pattern is to be done and specifies the various options. |
| Table | Base class for all table objects in a drawing. |
| ThreeBendCornerClosureDefinition | Defines the input properties required for creating a three-bend corner closure feature. This input definition provides a structured way to organize and validate the parameters before passing them to the setThreeBendCornerClosure method. |
| TimelineBuilderJob | A job that builds a parametric timeline from an input BRep body using the Timeline Builder cloud service. Created with TimelineBuilder.createJob. |
| TwoBendCornerClosureDefinition | Defines the input properties required for creating a two-bend corner closure feature. This input definition provides a structured way to organize and validate the parameters before passing them to the setTwoBendCornerClosure method. |
| Name | Description |
| AdditiveFEAOperation.isSuppressible | Gets whether this operation can be suppressed. Returns false for operations that cannot be suppressed, for instance additive arrange, ncprogram or setup. |
| AdditiveFEAOperationInput.clearReferenceTool | Clears the reference tool previously assigned to this input, if any. After calling this method, the input will not carry a reference tool when the operation is created and the referenceTool property will return null. |
| AdditiveFEAOperationInput.clearTool | Clears the tool previously assigned to this input, if any. After calling this method, the input will not carry a tool when the operation is created, and the tool property will return null. The assigned tool preset (if any) is also cleared. |
| Appearance.color | The appearance's primary color as RGBA. Maps to the schema-appropriate color property — `opaque_albedo` for opaque appearances, `metal_f0` for metallic, `transparent_color` for transparent. Setting alpha less than 255 enables translucency on opaque appearances. For schema-specific properties not exposed here (emission, index of refraction, anisotropy, etc.), use `appearanceProperties`. |
| Appearance.colorTexture | Path to a base-color image used as a texture for the appearance's primary color slot. Setting a non-empty path connects a fresh texture; setting an empty string disconnects the existing texture. Reading returns the connected texture's filename, or an empty string if none is connected. Whichever of `colorTexture`, `normalTexture`, and `roughnessTexture` is set first anchors the UV scale; any of the three that are set afterward copy that scale on connect so all three maps tile at the same rate. The order matters because the underlying color and roughness textures default to a different real-world tile size than the normal-map texture, so without this alignment a typical PBR set wired through these three setters in mixed order would tile at visibly different rates. To set a specific UV scale instead, override `texture_RealWorldScaleX` and `texture_RealWorldScaleY` on each texture via `appearanceProperties` after connecting. The same path applies for overriding wrap modes or other texture properties — access the underlying texture via `appearanceProperties.itemById('opaque_albedo').value` (or `metal_f0` / `transparent_color` depending on the appearance's surface type). The texture image is saved inside the document, so the appearance continues to render correctly when the document is opened on another machine. The string returned by the getter, however, is the path to the image on the local file system, which after a save and re-open will typically differ from the path that was originally set. Treat the returned value as a valid path for reading the image, not as a stable identifier. Returns false when the appearance does not host a primary color slot. Appearances created via `Appearances.add` always support this property. |
| Appearance.normalTexture | Path to a tangent-space normal map used as a texture for the appearance's `surface_normal` slot. Setting a non-empty path connects a fresh texture; setting an empty string disconnects the existing texture. Reading returns the connected texture's filename, or an empty string if none is connected. The supplied image is interpreted as an OpenGL-convention tangent-space normal map (the "normal_gl" variant from typical PBR sources). To use a heightmap or bump map instead, set this property to the image path and then change the texture's `bumpmap_Type` to `bumpmap_height_map` via `appearanceProperties.itemById('surface_normal').value.properties`. The order in which `colorTexture`, `normalTexture`, and `roughnessTexture` are set matters — see the note on `colorTexture`. As with `colorTexture`, the image is saved inside the document, but the path returned by the getter after a save and re-open is a local file-system path that may differ from the path originally set. Returns false when the appearance does not host a `surface_normal` slot. Appearances created via `Appearances.add` always support this property. |
| Appearance.roughness | Surface microfacet roughness in the range [0, 1]. 0.0 is a perfect mirror, 1.0 is fully matte. Maps to the `surface_roughness` property. |
| Appearance.roughnessTexture | Path to a grayscale roughness map used as a texture for the appearance's `surface_roughness` slot. Setting a non-empty path connects a fresh texture; setting an empty string disconnects the existing texture and falls back to the scalar `roughness` value. Reading returns the connected texture's filename, or an empty string if none is connected. Setting this property resets the scalar `roughness` to 1.0 so the texture's grayscale values pass through directly (0 = mirror-smooth, 1 = fully matte). To attenuate the texture, set `roughness` afterwards: appearance.roughnessTexture = path appearance.roughness = 0.7 # cap roughness at 70% The order in which `colorTexture`, `normalTexture`, and `roughnessTexture` are set matters — see the note on `colorTexture`. As with `colorTexture`, the image is saved inside the document, but the path returned by the getter after a save and re-open is a local file-system path that may differ from the path originally set. Returns false when the appearance does not host a `surface_roughness` slot. Appearances created via `Appearances.add` always support this property. |
| Appearances.add | Creates a new Appearance in the Design with neutral defaults. The `surfaceType` parameter selects the surface category; the default (`OpaqueAppearanceSurface`) is appropriate for plastics, paints, ceramics, rubber, and most other non-metallic, non-transparent materials. Configure the result via the Appearance's `color`, `roughness`, `colorTexture`, `normalTexture`, and `roughnessTexture` properties, or via `appearanceProperties` for finer control. This method only applies to the Appearances collection on a Design. |
| AssemblyComponentGeometry.setJointOrigin | Set the position and orientation of a joint. Specify the joint to set using ToolJointType and a 4x4 matrix that defines the joint origin and axes. |
| AutoConstrainInput.resultOption | Gets and sets the result type to use when auto constraining the sketch. The default is Option1AutoConstrainResultType. |
| AutoConstrainResult.movedGeometry | Returns an array containing the SketchEntity objects that were moved during the auto constrain operation. Geometry may be moved when using Option3AutoConstrainResultType. Returns an empty array if no geometry was moved. |
| CAMAdditiveContainer.isSuppressible | Gets whether this operation can be suppressed. Returns false for operations that cannot be suppressed, for instance additive arrange, ncprogram or setup. |
| CAMFolder.isSuppressible | Gets whether this operation can be suppressed. Returns false for operations that cannot be suppressed, for instance additive arrange, ncprogram or setup. |
| CAMHoleRecognition.isSuppressible | Gets whether this operation can be suppressed. Returns false for operations that cannot be suppressed, for instance additive arrange, ncprogram or setup. |
| CAMPattern.isSuppressible | Gets whether this operation can be suppressed. Returns false for operations that cannot be suppressed, for instance additive arrange, ncprogram or setup. |
| ConfigurationAppearanceColumn.isCustomized | Gets and sets whether this column is customized. Setting this to true marks the column as customized; setting it to false removes the customization. Note: today, this only supports ConfigurationThemeColumn. |
| ConfigurationAppearanceTable.hasCustomColumns | Returns whether there are any custom columns in the configuration design. Note: today, only the top table can include custom columns. |
| ConfigurationColumn.isCustomized | Gets and sets whether this column is customized. Setting this to true marks the column as customized; setting it to false removes the customization. Note: today, this only supports ConfigurationThemeColumn. |
| ConfigurationCustomThemeTable.hasCustomColumns | Returns whether there are any custom columns in the configuration design. Note: today, only the top table can include custom columns. |
| ConfigurationFeatureAspectColumn.isCustomized | Gets and sets whether this column is customized. Setting this to true marks the column as customized; setting it to false removes the customization. Note: today, this only supports ConfigurationThemeColumn. |
| ConfigurationInsertColumn.isCustomized | Gets and sets whether this column is customized. Setting this to true marks the column as customized; setting it to false removes the customization. Note: today, this only supports ConfigurationThemeColumn. |
| ConfigurationInsertStandardDesignColumn.isCustomized | Gets and sets whether this column is customized. Setting this to true marks the column as customized; setting it to false removes the customization. Note: today, this only supports ConfigurationThemeColumn. |
| ConfigurationJointSnapColumn.isCustomized | Gets and sets whether this column is customized. Setting this to true marks the column as customized; setting it to false removes the customization. Note: today, this only supports ConfigurationThemeColumn. |
| ConfigurationMaterialColumn.isCustomized | Gets and sets whether this column is customized. Setting this to true marks the column as customized; setting it to false removes the customization. Note: today, this only supports ConfigurationThemeColumn. |
| ConfigurationMaterialTable.hasCustomColumns | Returns whether there are any custom columns in the configuration design. Note: today, only the top table can include custom columns. |
| ConfigurationParameterColumn.isCustomized | Gets and sets whether this column is customized. Setting this to true marks the column as customized; setting it to false removes the customization. Note: today, this only supports ConfigurationThemeColumn. |
| ConfigurationPlasticRuleColumn.isCustomized | Gets and sets whether this column is customized. Setting this to true marks the column as customized; setting it to false removes the customization. Note: today, this only supports ConfigurationThemeColumn. |
| ConfigurationPlasticRuleTable.hasCustomColumns | Returns whether there are any custom columns in the configuration design. Note: today, only the top table can include custom columns. |
| ConfigurationPropertyColumn.isCustomized | Gets and sets whether this column is customized. Setting this to true marks the column as customized; setting it to false removes the customization. Note: today, this only supports ConfigurationThemeColumn. |
| ConfigurationRow.childRows | Returns an array of child rows that are directly nested under this row. An empty array is returned if this row has no children. |
| ConfigurationRow.parentRow | Returns the parent row of this row, or null if this row has no parent (i.e. it is a top-level row in the table). |
| ConfigurationSheetMetalRuleColumn.isCustomized | Gets and sets whether this column is customized. Setting this to true marks the column as customized; setting it to false removes the customization. Note: today, this only supports ConfigurationThemeColumn. |
| ConfigurationSheetMetalRuleTable.hasCustomColumns | Returns whether there are any custom columns in the configuration design. Note: today, only the top table can include custom columns. |
| ConfigurationSuppressCell.isEffectivelySuppressed | Returns whether the feature is effectively suppressed for this configuration row. This is true if the cell is implicitly suppressed by an upstream feature, or if the feature is explicitly suppressed in this cell |
| ConfigurationSuppressColumn.isCustomized | Gets and sets whether this column is customized. Setting this to true marks the column as customized; setting it to false removes the customization. Note: today, this only supports ConfigurationThemeColumn. |
| ConfigurationTable.hasCustomColumns | Returns whether there are any custom columns in the configuration design. Note: today, only the top table can include custom columns. |
| ConfigurationThemeColumn.isCustomized | Gets and sets whether this column is customized. Setting this to true marks the column as customized; setting it to false removes the customization. Note: today, this only supports ConfigurationThemeColumn. |
| ConfigurationTopTable.hasCustomColumns | Returns whether there are any custom columns in the configuration design. Note: today, only the top table can include custom columns. |
| ConfigurationVisibilityColumn.isCustomized | Gets and sets whether this column is customized. Setting this to true marks the column as customized; setting it to false removes the customization. Note: today, this only supports ConfigurationThemeColumn. |
| ConstructionPlane.isExtended | Gets and sets whether the construction plane uses the extended display mode. When true, the plane extends to fill the viewport. When false, the plane size fits to the defining geometry (default). This property only applies to parametric construction planes. |
| ConstructionPlaneInput.isExtended | Gets and sets whether the construction plane will use the extended display mode when created. When true, the plane extends to fill the viewport. When false, the plane size fits to the defining geometry (default). |
| ConstructionPointInput.setByDistanceOnPath | This input method is for creating a construction point at a specified distance along a path defined by an edge or sketch curve. 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. |
| CornerClosureFeature.alignmentType | Gets the type of alignment used for the corner closure. The alignment type can be either a symmetric gap or an overlap. Use the setToSymmetricGapAlignmentType and setToOverlapAlignmentType methods to set the alignment type. |
| CornerClosureFeature.bendTransition | Gets and sets the bend transition type for the corner closure. This can be smooth, straight line, or trim to bend. 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) |
| CornerClosureFeature.closureDefinition | Gets the object that defines the closure for a 2 or 3 bend corner closure. The type of definition object returned will depend on the geometry of the dominant and submissive edges and can be determined by using the closureType property. |
| CornerClosureFeature.closureType | Gets the type of corner closure defined. This is dependent on the geometry of the dominant and submissive edges and can be either a two-bend or three-bend corner closure. |
| CornerClosureFeature.dominantEdge | Gets and sets the dominant edge for the corner closure After setting the edge, the closureType property can be used to determine whether it is a two-bend or three-bend corner. |
| CornerClosureFeature.gap | Gets the parameter that controls the gap distance. To edit the value, use properties on the returned ModelParameter object. |
| CornerClosureFeature.isOverlapFlipped | Gets and sets if the overlap is flipped which defines if the dominant edge goes over the submissive edge or vice versa. This is only used when the alignment type is set to overlap (alignmentType is OverlapCornerClosureAlignmentType) and is ignored for symmetric gap alignment type. 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) |
| CornerClosureFeature.isWidthExtentAligned | Gets and sets how the shape of the extent is defined in relation to the flange edges. This property controls whether the corner closure extends along the flange edges, aligned with the edge direction. When false, it extends the corner closure perpendicular to the flange edges. 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) |
| CornerClosureFeature.overlap | Gets the parameter that controls the overlap percentage when using an overlap alignment type. It is a value between 0 and 1 and defines the percentage of overlap where 0 is no overlap and 1 is 100% overlap. This is only used when the alignment type is set to overlap (alignmentType is OverlapCornerClosureAlignmentType) otherwise it returns null. To set the value use properties on the returned ModelParameter object. |
| CornerClosureFeature.setToOverlapAlignmentType | Set the alignment type to be an overlap. This is only valid when the current type is a symmetric gap alignment type. 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) |
| CornerClosureFeature.setToSymmetricGapAlignmentType | Set the alignment type to be a symmetric gap. This is only valid when the current type is an overlap alignment type. 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) |
| CornerClosureFeature.submissiveEdge | Gets and sets the submissive edge for the corner closure After setting the edge, the closureType property can be used to determine whether it is a two-bend or three-bend corner. |
| CornerClosureFeatureInput.alignmentType | Gets the type of alignment used for the corner closure. The alignment type can be either a symmetric gap or an overlap. Use the setToSymmetricGapAlignmentType and setToOverlapAlignmentType methods to set the alignment type. |
| CornerClosureFeatureInput.bendTransition | Gets and sets the bend transition type for the corner closure. This can be smooth, straight line, or trim to bend. When the input is created, this defaults to smooth. |
| CornerClosureFeatureInput.closureDefinition | Gets the object that defines the closure for a 2 or 3 bend corner closure. The type of definition object returned will depend on the geometry of the dominant and submissive edges and can be determined by using the closureType property. |
| CornerClosureFeatureInput.closureType | Gets the type of corner closure defined. This is dependent on the geometry of the dominant and submissive edges and can be either a two-bend or three-bend corner closure. |
| CornerClosureFeatureInput.gap | Gets and sets the gap distance. This value will be used to create the parameter that defines the corner gap. If it is a real value it will be interpreted as centimeters. If it is a string it behaves the same as entering the value in the command dialog. A string like "0.25" will be 0.25 of whatever the current design units are. You can also specify the units as part of the string so "0.25 in" is valid. You can also define equations like "Thickness / 2" where Thickness is the name of an existing parameter. |
| CornerClosureFeatureInput.isOverlapFlipped | Gets and sets if the overlap is flipped which defines if the dominant edge goes over the submissive edge or vice versa. This is only used when the alignment type is set to overlap (alignmentType is OverlapCornerClosureAlignmentType) and is ignored for symmetric gap alignment type. |
| CornerClosureFeatureInput.isWidthExtentAligned | Gets and sets how the shape of the extent is defined in relation to the flange edges. This property controls whether the corner closure extends along the flange edges, aligned with the edge direction. When false, it extends the corner closure perpendicular to the flange edges. When the input is created this defaults to true. |
| CornerClosureFeatureInput.overlap | Gets and sets the overlap percentage when using an overlap alignment type. This is only used when the alignment type is set to overlap (alignmentType is OverlapCornerClosureAlignmentType) and is ignored for symmetric gap alignment type. The ValueInput can be defines a unitless value between 0 and 1 where 0 is no overlap and 1 is 100% overlap. This can be a real value or a string that evaluates to a unitless real value. A parameter will be created that uses the string as its expression. |
| CornerClosureFeatureInput.setToOverlapAlignmentType | Set the alignment type to be an overlap. |
| CornerClosureFeatureInput.setToSymmetricGapAlignmentType | Set the alignment type to be a symmetric gap. When a new input is created, it defaults to being a symmetric gap alignment, so it's not required to call this method to set it to that type. |
| Design.animationManager | Returns the AnimationManager object associated with this design. Using the AnimationManager you can access the same functionality that is available in the Animation workspace. |
| Drawing.activeSheet | Returns the current sheet i.e, the active sheet |
| ExportManager.createSTEPExportOptionsForFlatPattern | Creates a STEPFlatPatternExportOptions object that's used to export a flat pattern in STEP format. Creation of the STEPFlatPatternExportOptions object does not perform the export. You must pass this object to the ExportManager.execute method to perform the export. |
| Features.foldFeatures | Returns the collection that provides access to the existing fold features and supports the creation of new fold features. |
| Features.joinByBendFeatures | Returns the collection that provides access to the existing join by bend features and supports the creation of new join by bend features. |
| ModuleInstance.portInstances | Port instances placed on this module instance. |
| MultiAxisMachineElement.isUsingCompensateToolLength | Specifies whether tool gauge length should be added to the pivot distance for non-TCP rotary heads. |
| NCProgram.isSuppressible | Gets whether this operation can be suppressed. Returns false for operations that cannot be suppressed, for instance additive arrange, ncprogram or setup. |
| Occurrence.definition | Returns the definition of this occurrence. The definition provides information about the source of the occurrence, such as whether it originates from a content library. Returns null only if the call fails, otherwise always returns a definition object. |
| Occurrence.switchToCustomConfiguration | Switches the configuration for this occurrence to the specified row, applying custom values that override specific column values and optional metadata such as name, part number, and description. Use the isConfiguration property to determine if this occurrence references a configuration. |
| Occurrences.addFromCustomConfiguration | Method that inserts a configuration from a configured design with custom values that override specific column values and optional metadata such as name, part number, and description. Note: custom name, part number, and description are not supported in R1. The insert will fail if the configured design being used is not from the same project as the file it is being inserted into. |
| Operation.clearReferenceTool | Clears the reference tool currently assigned to this operation. After this call the operation will have no reference tool and the referenceTool property will return null. This may invalidate the toolpath. |
| Operation.clearTool | Clears the tool currently assigned to this operation. After this call the operation will have no tool and the tool property will return null. The tool preset (if any) is also cleared. This may invalidate the toolpath. |
| Operation.isSuppressible | Gets whether this operation can be suppressed. Returns false for operations that cannot be suppressed, for instance additive arrange, ncprogram or setup. |
| OperationBase.isSuppressible | Gets whether this operation can be suppressed. Returns false for operations that cannot be suppressed, for instance additive arrange, ncprogram or setup. |
| OperationInput.clearReferenceTool | Clears the reference tool previously assigned to this input, if any. After calling this method, the input will not carry a reference tool when the operation is created and the referenceTool property will return null. |
| OperationInput.clearTool | Clears the tool previously assigned to this input, if any. After calling this method, the input will not carry a tool when the operation is created, and the tool property will return null. The assigned tool preset (if any) is also cleared. |
| OperationStrategy.isSuppressible | Gets whether operations of this strategy type can be suppressed. Returns false for operations that cannot be suppressed, for instance additive arrange, ncprogram or setup. |
| PolygonMesh.compareWith | Compares this polygon mesh with another polygon mesh by computing, for every node in this mesh, the signed distance to the closest point on the other mesh (in cm). A positive value means the node lies on the side of the other mesh's surface normal; a negative value means it lies on the opposite side. |
| PortRef.portInstance | Port instance on the module instance that this reference connects to. |
| Profile.isOnSketchPlane | Indicates if the profile lies on the parent sketch plane. A false value does not prevent areaProperties from being calculated. |
| Setup.isSuppressible | Gets whether this operation can be suppressed. Returns false for operations that cannot be suppressed, for instance additive arrange, ncprogram or setup. |
| Sheet.customTables | Returns the CustomTables collection for this sheet. Use this collection to access existing custom tables or create new ones. |
| SketchFittedSplines.addBlendCurve | Creates a blend curve between two sketch curves. Which end of each curve to blend to is determined by specifying a point near the end of that curve. Using the startSketchPoint and endSketchPoint and then getting the geometry from those returned SketchPoint objects is a convenient way to get good points. |
| ThreadDataQuery.availableHubLibraryIds | Returns an array of available hub library IDs. An empty result means only built-in public thread types are available. The returned IDs can be passed to hubLibraryThreadTypes to filter thread types by library, or to hubLibraryDisplayName to get the display label. Hub libraries are only available for users with paid subscription. |
| ThreadDataQuery.getHubLibraryDisplayName | Returns the display name for a given hub library. |
| ThreadDataQuery.getHubLibraryThreadTypes | Returns thread types filtered by hub library. Pass an empty string to return all thread types from all sources, equivalent to allThreadTypes. Pass a hub library ID from availableHubLibraryIds to return only that library's thread types. |
| ThreadDataQuery.publicThreadTypes | Returns thread types from the built-in public library only, excluding any hub library threads. |
| ThreadInfo.hubLibraryId | Returns the hub library ID for hub library threads, or an empty string for public threads. Use ThreadDataQuery.availableHubLibraryIds to enumerate available hub libraries. |
| ThreadInfo.isHubLibraryThread | Returns true if this thread is from a hub library, false for built-in public threads. |
| Tool.attributes | Returns the collection of attributes associated with this tool. Attributes are arbitrary key-value pairs organized into groups that can be used to store custom metadata on a tool. |
| ToolBlock.attributes | Returns the collection of attributes associated with this tool. Attributes are arbitrary key-value pairs organized into groups that can be used to store custom metadata on a tool. |
| ToolPreset.attributes | Returns the collection of attributes associated with this preset. Attributes are arbitrary key-value pairs organized into groups that can be used to store custom metadata on a preset. |
| TurningTool.attributes | Returns the collection of attributes associated with this tool. Attributes are arbitrary key-value pairs organized into groups that can be used to store custom metadata on a tool. |
| VolumetricCustomFeatureInput.volumetricModel | The volumetric model. |
| VolumetricSampler.sampleAxes | Gets the axes of the current structured sampling layout. For plane grid sampling this returns [primaryAxis, secondaryAxis]. For bounding box grid sampling this returns [xAxis, yAxis, zAxis]. For unstructured sampling this returns an empty array. |
| VolumetricSampler.sampleDimensions | Gets the dimensions of the current structured sampling layout. For plane grid sampling this returns [primaryCount, secondaryCount]. For bounding box grid sampling this returns [xCount, yCount, zCount]. For unstructured sampling this returns an empty array. |
| VolumetricSampler.sampleOrigin | Gets the origin of the current structured sampling layout. For plane grid sampling this is the plane origin. For bounding box grid sampling this is the minimum corner of the bounding box. Returns null if the current sampling layout is not structured. |
| VolumetricSampler.sampleSpacings | Gets the spacing between neighbouring samples along each structured sampling axis. For unstructured sampling this returns an empty array. |
| VolumetricSampler.structuredSamplingRank | Gets the rank of the current structured sampling layout. This is 0 for unstructured sampling, 2 for plane grid sampling and 3 for bounding box grid sampling. |
| Workspace.selectionFilterSettings | Gets the selection filter settings for this workspace. Allows registration of custom graphics sub-filters, and querying or toggling the enabled state of selection filter categories in the toolbar dropdown. |
Help created: Wednesday, July 1, 2026 8:25 PM