ConfigurationJointSnapColumn Object Preview

Derived from: ConfigurationFeatureAspectColumn Object
Defined in namespace "adsk::fusion" and the header file is <Fusion/Configurations/ConfigurationJointSnapColumn.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

This object represents a column in the table that controls which joint snap to use for a particular joint. The columns contains a list of joint snaps that have been defined specifically for that column. One of the joint snaps is specified for each cell in the column. That joint snap will be used by the joint when the row that cell is in is active.

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().
deleteMe Deletes this column from the table. Property columns cannot be deleted. If the table was obtained from a DataFile, this method will fail.
getCell Gets the cell in this column at the specified row. Depending on the type of data in the cells within the column a ConfigurationFeatureAspectBooleanCell or ConfigurationFeatureAspectStringCell will be returned. The first row has an index of 0 and does not include the header row.
getCellByRowId This method returns the cell in this column at the row identified by its ID. Depending on the type of data in the cells within the column, a ConfigurationFeatureAspectBooleanCell or ConfigurationFeatureAspectStringCell will be returned.
getCellByRowName Gets the cell in this column at the row specified by its name. Depending on the type of data in the cells within the column a ConfigurationFeatureAspectBooleanCell or ConfigurationFeatureAspectStringCell will be returned.

Properties

Name Description
aspectType Gets the type of feature aspect this column is controlling.
feature Returns the feature being controlled by this column.

This property returns null when the table being queried was obtained from a DataFile object.
id The id of the column. This is constant and cannot be changed by the user.
index The index position of this column within the table. The first column is at index 0 and does not include the "Name" column.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
joint Returns the joint or as-built joint being controlled by this column.

This property returns null when the table being queried was obtained from a DataFile 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():
parentTable This property returns the parent table, either the top or custom theme table this column is in.
rowCount Returns the number of rows in this column.
snaps Provides access to any joint snaps that have been defined for this column. Using the returned collection you can define new joint snaps. Use the cell to specify which of the defined snaps is used for a specific row.
title The title of this column. In a top table, this can only be edited for suppression, visibility, parameter, and theme table columns. It behaves as read-only for all other types. In a theme table, the title of all the columns can be modified except for the column that represents the root component for materials and appearances.

If the table was obtained from a DataFile, this property behaves as read-only for all the columns.

Accessed From

ConfigurationJointSnapCell.parentColumn

Version

Introduced in version September 2024