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.
| 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(). |
| setAnnotationPlane | Sets the annotation plane for Leader Line Note PMI. |
| Name | Description |
| adjacentPlanarFaces | Adjacent planar faces to the geometry that can be used to define the annotation plane with type NormalToFaceLeaderLineNotePlaneType. |
| annotationPlaneReferencedFace | The BRepFace used as the alternate plane for the leader line note, if there's any. Applicable when the planeType is NormalToCustomFaceLeaderLineNotePlaneType or NormalToFaceLeaderLineNotePlaneType |
| annotationPlaneType | Get the LeaderLineNotePlaneTypes that the Leader Line Note PMI is currently using. |
| annotationTargetPoint | Gets and sets the annotation point on the geometry that the leader line note is associated with. This can be a point on the BRepFace, BRepEdge or BRepVertex, depending on the geometry. The point is relative to the geometry's component space where the PMI is being created. |
| annotationTextPoint | Gets and sets the annotation point where the leader line starts. This point must be a valid point on the annotation plane. The point is relative to the geometry's component space where the PMI is being created. |
| geometry | The geometric entity to which the Note PMI will be associated. This can be a BRepFace, BRepEdge, or BRepVertex object. For BRepEdge objects, only linear, circular and elliptical edges are supported. The note will be positioned relative to this entity and will maintain its association with the entity geometry. Setting the geometry will set a default annotation plane and target point. Resetting the geometry will reset to default annotation plane and target point. Native object will be used when setting the geometry. |
| horizontalAlignment | Controls the horizontal alignment of the PMI text relative to its anchor point. This determines how the text box is positioned relative to the text placement point. |
| isPerpendicularLine | Controls whether the PMI text is perpendicular to the leader line or parallel to it. |
| isShowImportedGeometry | Gets and sets whether the original graphics/geometry of the PMI should be visible. Applicable only to PMI that has been converted. |
| isValid | Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference. |
| leaderLineExtension | Gets and sets the length of the leader line extension in cm. This value extends the leader line in the direction determined by the perpendicular setting. |
| 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(): |
| plane | Get the annotation plane of the PMI. This plane determines the plane in which the PMI text and graphics are drawn. The plane is relative to the geometry's component space where the PMI is being created. |
| segments | Gets and sets the list of PMISegments used to define the PMI text. The segments can be any combination of PMITextSegment, PMISymbolSegment and PMILineBreakSegment objects. Changing this property will result in changing the displayed text of the PMI. |
| supportedAnnotationPlaneTypes | A helper method to get all available annotation plane types that can be set on this Leader Line Note PMI. |
| verticalAlignment | Controls the vertical alignment of the PMI text relative to its anchor point. This determines the vertical positioning of the text box relative to the calculated text placement point. |