ConfigurationParameterCell Object Preview

Derived from: ConfigurationCell Object
Defined in namespace "adsk::fusion" and the header file is <Fusion/Configurations/ConfigurationParameterCell.h>

PreviewThis 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.

Description

Represents a single cell within a configuration table that controls the value of a parameter. Get the parent column to get the parameter being controlled.

Methods

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().

Properties

Name Description
expression Gets and sets the expression that defines the value of the associated parameter when the parent row is active. This property behaves as read-only when the table is obtained from a DataFile object.
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():
parentColumn Returns the column this cell is in. From the column, you can get the parameter object being controlled.
parentRow Returns the row this cell is in.
value Gets and sets the value of the parameter in database units. You can use the units property of the associated Parameter object, which you can get from the column, to determine the type of units this parameter is defined in. Setting this property will overwrite any existing expression. This property behaves as read-only when the table is obtained from a DataFile object.

Accessed From

ConfigurationParameterColumn.getCell, ConfigurationParameterColumn.getCellByRowId, ConfigurationParameterColumn.getCellByRowName

Version

Introduced in version January 2024