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.
| 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 |
| ceilingClearance | Returns the parameter that controls the clearance of the objects from the top of the envelope volume. You can modify the value by using the properties on the returned ModelParameter object. |
| frameWidth | Returns the parameter that controls the width of the envelope frame. This defines the offset distance of the objects from the edge of the frame. You can modify the value by using the properties on the returned ModelParameter object. |
| height | Returns the parameter that controls the height of the envelope volume. This defines the You can modify the value by using the properties on the returned ModelParameter object. |
| isPartialArrangeAllowed | Gets and sets if a partial arrange is allowed for this envelope. |
| isValid | Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference. |
| length | Returns the parameter that controls the length of the envelope volume. This defines the You can modify the value by using the properties on the returned ModelParameter object. |
| objectSpacing | Returns the parameter that controls the space between objects in the arrangement. You can modify the value by using the properties on the returned ModelParameter object. |
| 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(): |
| originXOffset | Returns the parameter that controls the X offset of the envelope volume from the origin of the construction plane. You can modify the value by using the properties on the returned ModelParameter object. |
| originYOffset | Returns the parameter that controls the Y offset of the envelope volume from the origin of the construction plane. You can modify the value by using the properties on the returned ModelParameter object. |
| parentArrange | Returns the parent ArrangeFeature this envelope is associated with. |
| placementClearance | Returns the parameter that controls the offset of the objects from the base plane of the arrangement (the "up" direction). You can modify the value by using the properties on the returned ModelParameter object. |
| plane | Gets and sets the ConstructionPlane the envelope is defined on. |
| width | Returns the parameter that controls the width of the envelope volume. This defines the You can modify the value by using the properties on the returned ModelParameter object. |