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 |
| attributes | Returns the collection of attributes associated with this face. |
| comment | The comment associated with this parameter |
| component | Returns the Component containing the ModelParameter. |
| createdBy | Returns the object that created this parameter. For example, a feature, a sketch dimension, or a construction plane. |
| dependencyParameters | Returns a list of parameters that this parameter is dependent on. |
| dependentParameters | Returns a list of parameters that are dependent on this parameter as a result of this parameter being referenced in their equation. |
| entityToken | Returns a token for the Parameter object. This can be saved and used at a later time with the Design.findEntityByToken method to get back the same parameter. When using entity tokens it's important to understand that the token string returned for a specific entity can be different over time. However, even if you have two different token strings that were obtained from the same entity, when you use findEntityByToken they will both return the same entity. Because of that you should never compare entity tokens as way to determine what the token represents. Instead, you need to use the findEntityByToken method to get the two entities identified by the tokens and then compare them. |
| expression | Gets and sets the expression (i.e. "22.064 mm") used to calculate the value of the parameter |
| id | Returns the ID of this custom feature parameter. |
| isDeletable | Gets if this parameter can be deleted. Parameters that cannot be deleted are: Model Parameters and User Parameters that have dependents. |
| isFavorite | Gets and sets whether this parameter is included in the Favorites list in the parameters dialog |
| isValid | Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference. |
| isVisible | Gets and sets if this parameter is visible in the parameters dialog. By default, all new parameters are visible. This can be useful in cases where the feature can be edited to be in different states where a parameter is only valid in a certain state. You can change the visibility based on the current state of the feature and if that parameter should be available for edit. This implies that you create all the parameters that might be needed and then change their visibility based on the current state of the feature. The parameters that are not visible will not be returned by the ModelParameters collection and are only available through the custom feature they're associated with. |
| modelParameters | Returns the Collection containing the ModelParameter. |
| name | Gets and sets the name of the parameter. Setting the name can fail if the name is not unique with respect to all other parameters in the design. |
| 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(): |
| parentCustomFeature | Returns the custom feature this parameter is associated with. |
| role | This property identifies what the parameter is used for. For an extrude, it could be "Depth", for a work plane it could be "Offset". |
| unit | The unit type associated with this parameter. An empty string is returned for parameters that don't have a unit type. |
| value | Gets and sets the real value (a double) of the parameter in database units. Setting this property will set/reset the expression value for this parameter |