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.
Assigns a value to a column. The column's leaf type and the operatorType together determine which value class is required — see ConfigurationRuleSetOperators for the operator/value/leaf-type compatibility matrix.
| 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(). |
| create |
Creates a new, detached SetBlock with empty columnId, operatorType = UnknownConfigurationRuleSetOperator, and no value. Populate the fields then append to a rule body (or to an If block's then / else branches). |
| Name | Description |
| columnId | Gets and sets the id of the column whose value is being assigned. Must resolve in the configuration table; an unknown columnId degrades the block to a placeholder on submit. Do not invent columnIds — fetch them from getRules on an existing rule or from the configuration data. Not all column kinds are addressable as set targets (for example feature-aspect and property columns). |
| isValid | Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference. |
| 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(): |
| operatorType | Gets and sets the assignment operator. See ConfigurationRuleSetOperators for the operator/value/leaf-type compatibility matrix. Set to UnknownConfigurationRuleSetOperator to mark this block as an unconfigured placeholder. |
| value | Gets and sets the value to assign. Null marks the block as an unconfigured placeholder. The required value class is determined by operatorType and the column's leaf type — see ConfigurationRuleSetOperators. Construct values via the create factories on the concrete value classes (ConfigurationRuleStringValue.create, ConfigurationRuleNumberValue.create, etc.). Number values are in Fusion internal units (centimetres for length, radians for angle, etc.), not display units. |
| Name | Description |
| Configuration Rules API Sample | Demonstrates reading and modifying configuration rules using the typed ConfigurationRules API. Before running: Run in the DESIGN workspace from Scripts and Add-Ins (Python, C++, or TypeScript), unless the script states otherwise. |