Represents a group in the timeline.
| Name | Description |
| canReorder |
Checks to see if this object can be reordered to the specified position. The default value of -1 indicates the end of the timeline. |
| 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 the group with the option of deleting or keeping the contents. |
| deleteObject |
Deletes this TimelineObject and its associated feature from the design. This method should not be used for TimelineGroup objects; use TimelineGroup.deleteMe() instead. Check the isDeletable property before calling this method. |
| item |
Function that returns the specified timeline object within the group using an index into the collection. |
| reorder |
Reorders this object to the position specified. The default value of -1 indicates the end of the timeline. |
| rollTo |
Rolls the timeline by repositioning the marker to either before or after this object. This method will fail if this is a timelineGroup object and the group is expanded. |
| Name | Description |
| count | The number of items in the group. |
| entity | Returns the entity associated with this timeline object. Edit operations can be performed by getting the object representing the associated entity and using the methods and properties on that entity to make changes. Returns null if this TimelineObject does not have a single public-API entity. This includes TimelineGroup rows (iterate the TimelineGroup's children instead, or use the TimelineGroup itself), and any entry whose feature type does not yet have a public API representation. Scripts that walk the timeline should null-check this property rather than relying on it to throw. |
| errorOrWarningMessage | Returns the error or warning message in the case where the healthState property returns either WarningFeatureHealthState or ErrorFeatureHealthState. Otherwise this property returns an empty string. |
| healthState | Returns the current health state of the object associated with this TimelineObject. Returns UnknownFeatureHealthState when this TimelineObject represents a TimelineGroup, since groups do not carry their own health state. |
| index | Returns the position of this item within the timeline where the first item has an index of 0. This property can return -1 in the two cases where this object is not currently represented in the timeline. The two cases are: 1. When this is a TimelineGroup object and the group is expanded. 2. When this object is part of a group and the group is collapsed. |
| isCollapsed | Indicates if the group is collapsed or expanded. |
| isDeletable | Indicates whether this TimelineObject can be deleted standalone using deleteObject(). Returns false in cases where standalone deletion is not supported, for example: - The object is a child of a collapsed TimelineGroup (delete the parent group instead). - The object represents a snapshot or other entry that cannot be deleted independently. - The underlying feature has dependents whose deletion would cascade. For TimelineGroup objects use TimelineGroup.deleteMe() rather than this method. |
| isGroup | Indicates if this TimelineObject represents a group. If True you can operate on this object as a TimelineGroup object. |
| isRolledBack | Indicates if this item is currently not being computed because it has been rolled back. If this is a timelineGroup object and the group is expanded the value of this property should be ignored. |
| isSuppressed | Gets and sets if this object is suppressed. |
| isValid | Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference. |
| name | Gets and sets the name of this timeline object. This name is shared by the object the timeline object represents. For example, if the TimelineObject represents a Sketch and you change the name using the TimelineObject, the name of the sketch in the browser is also changed. The reverse is also true. Setting the name of an object; sketch, feature construction geometry, etc, will also change the name of the associated node in the timeline. |
| 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(): |
| parentGroup | Returns the parent group, if this object is part of a group. Returns null if this object is not part of a group. |
| parentTimeline | Returns the Timeline that owns this TimelineObject. |