PMILeaderLineNoteInput.setAnnotationPlane Method

Parent Object: PMILeaderLineNoteInput

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.


Defined in namespace "adsk::fusion" and the header file is <Fusion/PMI/PMILeaderLineNoteInput.h>

Description

Sets the annotation plane for Leader Line Note PMI.

Syntax

"pMILeaderLineNoteInput_var" is a variable referencing a PMILeaderLineNoteInput object.
# Uses no optional arguments.
returnValue = pMILeaderLineNoteInput_var.setAnnotationPlane(planeType)

# Uses optional arguments.
returnValue = pMILeaderLineNoteInput_var.setAnnotationPlane(planeType, face)
"pMILeaderLineNoteInput_var" is a variable referencing a PMILeaderLineNoteInput object.

#include <Fusion/PMI/PMILeaderLineNoteInput.h>

// Uses no optional arguments.
returnValue = pMILeaderLineNoteInput_var->setAnnotationPlane(planeType);

// Uses optional arguments.
returnValue = pMILeaderLineNoteInput_var->setAnnotationPlane(planeType, face);

Return Value

Type Description
boolean True if the plane has been set successfully.

Parameters

Name Type Description
planeType LeaderLineNotePlaneTypes The type of annotation plane to create.

Creation of Leader Line Note PMI on Unknown plane type is not supported.
face BRepFace An optional input face to define the plane.

Required if the planeType is NormalToCustomFaceLeaderLineNotePlaneType.

Required if the planeType is NormalToFaceLeaderLineNotePlaneType and the face must be an adjacent face to the geometry.

For other plane types, this parameter is ignored.

This is an optional argument whose default value is null.

Version

Introduced in version April 2026