DataComponent Object

Derived from: Base Object
Defined in namespace "adsk::core" and the header file is <Core/Dashboard/DataComponent.h>

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

Description

An object that provides ID's that can be used to access the component using MFG DM API. These ID's are generated by the MFG DM API when a file is saved. For that reason, they are not available from a component before its parent file is saved.

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
component	Get the fusion.Component that corresponds to this data component.
id	Gets the unique ID of this DataComponent. This ID can be used within the MFG DM API. This ID is created by the MFG DM API when the component is first saved.
isValid	Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
mfgdmModelId	Get the MFGDM model Id.
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():
timestamp	Get the resolution timestamp.
versionId	Returns the unique ID of this file version of the DataComponent. This ID is updated whenever the document the component exists within is saved.

Accessed From

BaseComponent.dataComponent, Component.dataComponent, Design.rootDataComponent, FlatPatternComponent.dataComponent, FlatPatternProduct.rootDataComponent, Occurrence.dataComponent, WorkingModel.rootDataComponent

Samples

Name	Description
Gets all properties using GraphQL	Fetches bulk component properties of the root component and from occurrences via single GraphQL query.
Get part number using GraphQL	Fetches part number of root component and from occurrences via GQL query.
Set part number using GraphQL	Sets part number of root component and from occurrences via GQL query.

Version

Introduced in version May 2024