This functionality is provided as a preview
of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the
Fusion API and Scripts forum.
Because this is a preview of future functionality, there is the possibility that it will change, which will possibly
break any existing programs that use this functionality. Because of that, you should never deliver any programs that use
any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.
Input parameters for drawing creation. Create via DrawingManager.createDrawingInput().
| Name | Description |
| classType |
Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType(). |
| handler |
Sets the async data event handler for monitoring progress of drawing creation. Currently not used as drawing creation is synchronous. |
| Name | Description |
| automationPreferences | Gets the AutomationPreferences for configuring global, assembly, component, and sheet metal sheet settings. Modifications to the returned object directly affect drawing creation. |
| baseDocumentType | Gets and sets the base document type option for drawing creation. Specifies whether to create from scratch or from a template. Default: FromScratchBaseDocumentType. |
| 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. |
| content | Gets and sets which assembly content is included for automatic drawing creation: full assembly or visible-only. Default: FullAssemblyDrawingContentType. |
| creationMode | Gets and sets the drawing creation mode. Default: AutomaticDrawingCreationMode. |
| customSize | Gets or sets the custom sheet size for the drawing. The width and height values in CustomSheetSize are unitless; the unit is determined by the value set via the units API. By default, ISO drawings use millimeters and ASME drawings use inches. If a custom size has not been set, the getter returns a default CustomSheetSize object, which can be modified and passed back via the setter to apply it. For drawing creation, horizontalZones and verticalZones must each be at least 2 (positive integers). |
| isValid | Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference. |
| objectType | This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object. It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType(): |
| orientationType | Gets and sets the sheet orientation. Default: LandscapeSheetOrientationType. When a custom sheet size is set via customSize, setting orientationType has no effect; orientationType is ignored and width and height define the layout. PortraitSheetOrientationType is not supported when the standard is ISO and sheet size is A0ISOSheetSize, or when the standard is ASME and sheet size is EASMESheetSize. |
| sheetCreationType | Gets and sets which hierarchy levels get sheets. FirstLevelOnlySheetCreationType reduces file size. Default: AllLevelsSheetCreationType. |
| sheetSize | Gets and sets the sheet size. This defaults to A3ISOSheetSize. Check the drawing standard via the standard property before setting — ISO sizes (A0–A4) are only applicable when the standard is ISO, and ASME sizes (A–E) are only applicable when the standard is ASME. Setting a size that does not match the active standard will have no effect. To specify a custom sheet size, use the setCustomSheetSize method instead — CustomSheetSize cannot be set directly. When the standard is ISO and the sheet size is A0ISOSheetSize, orientation cannot be set to PortraitSheetOrientationType. When the standard is ASME and the sheet size is EASMESheetSize, orientation cannot be set to PortraitSheetOrientationType. |
| standard | Gets and sets the drawing standard (ISO or ASME). Default: ISODrawingStandardType. |
| templateFile | Gets or sets the template file to use when creating the drawing. / This value is only used when baseDocumentType is set to / FromTemplateBaseDocumentType. If FromScratchBaseDocumentType is set to FromScratch, this value is ignored. If FromTemplateBaseDocumentType is selected in baseDocumentType and this value is null or invalid, the createDrawing API will fail. |
| units | Gets and sets the drawing units (mm or inch). Default: MillimeterDrawingUnitType. |