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.
Object that represents the sheet specific data within a drawing document.
| Name | Description |
| addRevisionTable |
|
| autoDimension |
Automatically adds dimensions on view chain specify in AutoDimensionInput. |
| 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(). |
| copy |
Creates a copy of this sheet and inserts it into the drawing. |
| createAutoDimensionInput |
Creates a new AutoDimensionInput object used to define the settings for an automatic dimensioning operation. After configuring the returned input object (dimension strategy, datum location, etc.), pass it to the Sheet.autoDimension method to generate the dimensions on a specific sheet. |
| deleteMe |
Deletes this sheet from the drawing. This operation cannot be undone. |
| getRevisionTable |
|
| revisionTableInput |
|
| Name | Description |
| bendTables | Returns the BendTables collection for this sheet. Use this collection to create new bend tables. |
| border | Returns the document-level border appearance settings exposed through the Object Properties Drawing Border row. The returned object reflects settings shared across all sheets in this drawing; changing a property updates border geometry on every sheet. |
| configurationTables | Returns the ConfigurationTables collection for this sheet. Use this collection to access the configuration table on the sheet, or to create one. A configuration table lists the configurations of the configured design the drawing references, one configuration per row. The collection is empty, and a configuration table cannot be created, when the drawing does not reference a design that has configurations. |
| customSize | Gets or sets the custom sheet dimensions and border zones for this sheet. When getting: returns a new CustomSheetSize with the current layout width, height, and border zone counts. This is provided for standard sheet sizes as well as custom sizes so callers can read dimensions, adjust them, and assign the object back. When setting: applies width, height, and zones and persists a custom sheet size for this sheet. The value must not be null. Width and height use the document drawing units (millimeters or inches), as reported by DocumentSettings.units. Validation limits are described on CustomSheetSize. If both horizontalZones and verticalZones are zero on set, existing border zone counts on the sheet are left unchanged (so scripts can change only width and height). |
| customTables | Returns the CustomTables collection for this sheet. Use this collection to access existing custom tables or create new ones. |
| drawingDimensions | Returns the DrawingDimensions collection for this sheet. Use this collection to access existing dimensions or create new ones. |
| drawingSymbols | Returns the drawing symbols collection for this sheet. Use createDatumIdentifierInput and addDatumIdentifier to create datum identifier symbols. |
| height | Returns the height value for the sheet. |
| holeTables | Returns the HoleTables collection for this sheet. Use this collection to create new hole tables and to access the existing ones. |
| images | Returns the Images collection for this sheet. Use this collection to insert images. |
| 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 sheet. |
| 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(): |
| orientation | Gets and sets the orientation of the sheet. This property is not applicable when the sheet has a custom size. |
| sheetSize | Gets and sets the sheet size. Default sheet size for iso is A3ISOSheetSize and for asme is BASMESheetSize with respect to standard. 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 To apply a custom sheet size, set customSize; CustomSizeSheetSize cannot be assigned here. |
| sketches | Returns the DrawingSketches collection for this sheet. Use this collection to create new sketches or access existing ones. Sketch geometry such as lines lives inside a sketch. |
| tidyUp | Automatically arranges and tidies all elements on the sheet. All view chains, dimensions, labels, and annotations are considered when repositioning to remove overlaps and improve overall layout clarity. |
| titleBlock | Gets and sets the title block definition assigned to this sheet. When getting: returns the title block definition currently applied to this sheet, or null if the title block could not be determined. When setting: applies the specified title block definition to this sheet. The value must not be null and must name an existing title block definition in the drawing. |
| views | Returns the DrawingViews collection for this sheet. |
| width | Returns the width value for the sheet. |