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.
The input object that defines the required input to create a title block when using the TitleBlocks.add method. Created using the TitleBlocks.createInput method.
| 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(). |
| Name | Description |
| isValid | Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference. |
| name | Gets and sets the name of the new title block. The name must be unique and must differ from originTitleBlock when source is ExistingTitleBlockSourceType. When empty, a unique name is generated from originTitleBlock when source is ExistingTitleBlockSourceType. When source is ReferenceTitleBlockSourceType or DrawingFileTitleBlockSourceType and originTitleBlock is set, an empty name uses the source title block name. When originTitleBlock is empty for those sources, all title blocks are imported and this property is ignored. |
| 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(): |
| originTitleBlock | Gets and sets the title block to copy from. Required when source is ExistingTitleBlockSourceType; TitleBlocks.add fails when it is empty. When source is ReferenceTitleBlockSourceType, this is the name of a title block in the template drawing (.f2t). When source is DrawingFileTitleBlockSourceType, this is the name of a title block in the source drawing (.f2d). When empty for ReferenceTitleBlockSourceType or DrawingFileTitleBlockSourceType, all non-default title blocks from the source file are imported. Standard defaults (ANSI_TITLEBLOCK and ISO_TITLEBLOCK) are skipped because every drawing already includes them. Title blocks whose names already exist in the drawing are not imported. If any such name is found in the source file, no title blocks are imported and TitleBlocks.add throws. Import is allowed only when the source file drawing standard matches the target drawing standard (ISO or ASME/ANSI); title block names are not used to infer standard. When originTitleBlock is set, the import fails if the source file standard does not match the target drawing standard. |
| referenceDrawingDataFile | Gets and sets the drawing DataFile to import a title block from when source is DrawingFileTitleBlockSourceType. Requires a cloud drawing DataFile (.f2d); local paths are not supported. |
| referenceTemplateDataFile | Gets and sets the template DataFile to import a title block from when source is ReferenceTitleBlockSourceType. Requires a cloud template DataFile (.f2t); local paths are not supported. |
| source | Gets and sets where the new title block originates from. This defaults to ExistingTitleBlockSourceType. |