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 a sketch on a drawing sheet. A sketch owns 2D geometry such as lines and appears as a node in the drawing browser.
| 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(). |
| deleteMe |
Deletes this sketch and all of its geometry from the sheet. This operation cannot be undone. |
| Name | Description |
| arcs | Returns the Arcs collection for this sketch. Use this collection to draw arc geometry in the sketch or to access existing arcs. |
| circles | Returns the Circles collection for this sketch. Use this collection to draw circle geometry in the sketch or to access existing circles. |
| ellipses | Returns the Ellipses collection for this sketch. Use this collection to draw ellipse geometry in the sketch or to access existing ellipses. |
| isValid | Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference. |
| lines | Returns the Lines collection for this sketch. Use this collection to draw straight-line geometry (a connected chain of segments) in the sketch or to access existing lines. |
| name | Returns the name of the sketch. |
| 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(): |
| rectangles | Returns the Rectangles collection for this sketch. Use this collection to draw two-point rectangle geometry in the sketch or to access existing rectangles. |